程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> 關於.NET >> C#的擴展方法解析,

C#的擴展方法解析,

編輯:關於.NET

C#的擴展方法解析,


    在使用面向對象的語言進行項目開發的過程中,較多的會使用到“繼承”的特性,但是並非所有的場景都適合使用“繼承”特性,在設計模式的一些基本原則中也有較多的提到。

    繼承的有關特性的使用所帶來的問題:對象的繼承關系實在編譯時就定義好了,所以無法在運行時改變從父類繼承的實現。子類的實現與它父類有非常緊密的依賴關系,以至於父類實現中的任何變化必然會導致子類發生變化。當你需要復用子類時,如果繼承下來的實現不適合解決新的問題,則父類必須重寫它或被其他更適合的類替換,這種依賴關系限制了靈活性並最終限制了復用性。替代繼承特性的方式,較多的會采用 合成/聚合復用原則,“合成/聚合復用原則”:盡量使用合成/聚合,盡量不要使用類繼承。

    如果在新類型的對象應當攜帶有關額外行為的細節,在使用繼承特性時,有時可能不太適合,例如:處理指類型,密封類,或者接口時。在面對這些要求時,我們有時候會寫一些靜態類包含一些靜態方法。但是過多的靜態方法會造成額外的不必要的開銷。

一.擴展方法概述:

    面對以上的有關“繼承”的問題,以及在面對項目的一些需求時,我們需要解決這些問題的方式就是“擴展方法”。在C#3.0中引入了“擴展方法”,既有靜態方法的優點,又使調用它們的代碼的可讀性得到了提高。在使用擴展方法時,可以像調用實例方法那樣調用靜態方法。

   1.擴展方法的基本原則:

      (1).C#只支持擴展方法,不支持擴展屬性、擴展事件、擴展操作符等。

      (2).擴展方法(第一個參數前面是this的方法)必須在非泛型的靜態類中聲明,擴展方法必須有一個參數,而且只有第一個參數使用this標記。

      (3).C#編譯器查找靜態類中的擴展方法時,要求這些靜態類本身必須具有文件作用域。

      (4).C#編譯要求“導入”擴展方法。(靜態方法可以任意命名,C#編譯器在尋找方法時,需要花費時間進行查找,需要檢查文件作用域中的所有的靜態類,並掃描它們的所有靜態方法來查找一個匹配)

      (5).多個靜態類可以定義相同的擴展方法。

      (6).用一個擴展方法擴展一個類型時,同時也擴展了派生類型。 

   2.擴展方法聲明:

     (1).必須在一個非嵌套的、非泛型型的靜態類中(所以必須是一個靜態方法)

     (2).至少有一個參數。

     (3).第一個參數必須附加this關鍵字做前綴。

     (4).第一個參數不能有其他任何修飾符(如ref或out)。

     (5).第一個參數的類型不能是指針類型。

 以上的兩個分類說明中,對擴展方法的基本特性和聲明方式做了一個簡單的介紹,有關擴展方法的使用方式,會在後面的代碼樣例中進行展示,再次就不再多做說明。

二.擴展方法原理解析:

    “擴展方法”是C#獨有的一種方法,在擴展方法中會使用ExtensionAttribute這個attribute。

    C#一旦使用this關鍵字標記了某個靜態方法的第一個參數,編譯器就會在內部向該方法應用一個定制的attribute,這個attribute會在最終生成的文件的元數據中持久性的存儲下來,此屬性在System.Core dll程序集中。

    任何靜態類只要包含了至少一個擴展方法,它的元數據中也會應用這個attribute,任何一個程序集包含了至少一個符合上述特點的靜態類,它的元數據也會應用這個attribute。如果代碼嗲用了一個不存在的實例方法,編譯器會快速的掃描引用的所有程序集,判斷它們哪些包含了擴展方法,然後,在這個程序集中,可以掃描包含了擴展方法的靜態類。

    如果同一個命名空間中的兩個類含有擴展類型相同的方法,就沒有辦法做到只用其中一個類中的擴展方法。為了通過類型的簡單名稱(沒有命名控件前綴)來使用類型,可以導入該類型所有在的命名空間,但這樣做的時候,你沒有辦法阻止那個命名空間中的擴展方法也被導入進來。

三..NET3.5的擴展方法Enumerable和Queryable:

   在框架中,擴展方法最大的用途就是為LINQ服務,框架提供了輔助的擴展方法,位於System.Linq命名空間下的Enumerable和Queryable類。Enumerable大多數擴展是IEnumerable<T>,Queryable大大多數擴展是IQueryable<T>。

   1.Enumerable類中的常用方法:

      (1).Range():一個參數是起始數,一個是要生成的結果數。

public static IEnumerable<int> Range(int start, int count) { 
            long max = ((long)start) + count - 1;
            if (count < 0 || max > Int32.MaxValue) throw Error.ArgumentOutOfRange("count"); 
            return RangeIterator(start, count);
        }

        static IEnumerable<int> RangeIterator(int start, int count) { 
            for (int i = 0; i < count; i++) yield return start + i;
        } 

     (2).Where():對集合進行過濾的一個方式,接受一個謂詞,並將其應用於原始集合中的每個元素。

 public static IEnumerable<TSource> Where<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate) {
            if (source == null) throw Error.ArgumentNull("source"); 
            if (predicate == null) throw Error.ArgumentNull("predicate"); 
            if (source is Iterator<TSource>) return ((Iterator<TSource>)source).Where(predicate);
            if (source is TSource[]) return new WhereArrayIterator<TSource>((TSource[])source, predicate); 
            if (source is List<TSource>) return new WhereListIterator<TSource>((List<TSource>)source, predicate);
            return new WhereEnumerableIterator<TSource>(source, predicate);
        }

 public WhereEnumerableIterator(IEnumerable<TSource> source, Func<TSource, bool> predicate) { 
                this.source = source;
                this.predicate = predicate; 
            }

    以上分別介紹了Range()和Where()兩個方法,該類中還主要包含select()、orderby()等等方法。

  2.Queryable類中的常用方法:

    (1).IQueryable接口:

 /// <summary>
  /// 提供對未指定數據類型的特定數據源的查詢進行計算的功能。
  /// </summary>
  /// <filterpriority>2</filterpriority>
  public interface IQueryable : IEnumerable
  {
    /// <summary>
    /// 獲取與 <see cref="T:System.Linq.IQueryable"/> 的實例關聯的表達式目錄樹。
    /// </summary>
    /// 
    /// <returns>
    /// 與 <see cref="T:System.Linq.IQueryable"/> 的此實例關聯的 <see cref="T:System.Linq.Expressions.Expression"/>。
    /// </returns>
    Expression Expression { get; }
    /// <summary>
    /// 獲取在執行與 <see cref="T:System.Linq.IQueryable"/> 的此實例關聯的表達式目錄樹時返回的元素的類型。
    /// </summary>
    /// 
    /// <returns>
    /// 一個 <see cref="T:System.Type"/>,表示在執行與之關聯的表達式目錄樹時返回的元素的類型。
    /// </returns>
    Type ElementType { get; }
    /// <summary>
    /// 獲取與此數據源關聯的查詢提供程序。
    /// </summary>
    /// 
    /// <returns>
    /// 與此數據源關聯的 <see cref="T:System.Linq.IQueryProvider"/>。
    /// </returns>
    IQueryProvider Provider { get; }
  }

   (2).Where():

  public static IQueryable<TSource> Where<TSource>(this IQueryable<TSource> source, Expression<Func<TSource, bool>> predicate) { 
            if (source == null)
                throw Error.ArgumentNull("source"); 
            if (predicate == null)
                throw Error.ArgumentNull("predicate");
            return source.Provider.CreateQuery<TSource>(
                Expression.Call( 
                    null,
                    ((MethodInfo)MethodBase.GetCurrentMethod()).MakeGenericMethod(typeof(TSource)), 
                    new Expression[] { source.Expression, Expression.Quote(predicate) } 
                    ));
        } 

   (3).Select():

 public static IQueryable<TResult> Select<TSource,TResult>(this IQueryable<TSource> source, Expression<Func<TSource, TResult>> selector) {
            if (source == null)
                throw Error.ArgumentNull("source");
            if (selector == null) 
                throw Error.ArgumentNull("selector");
            return source.Provider.CreateQuery<TResult>( 
                Expression.Call( 
                    null,
                    ((MethodInfo)MethodBase.GetCurrentMethod()).MakeGenericMethod(typeof(TSource), typeof(TResult)), 
                    new Expression[] { source.Expression, Expression.Quote(selector) }
                    ));
        }

   以上是對擴展方法中兩個類進行了一個簡單的解析。

四.擴展方法實例:

      由於擴展方法實際是對一個靜態方法的調用,所以CLR不會生成代碼對調用方法的表達式的值進行null值檢查

   1.異常處理代碼:

    /// <summary>
    /// 為參數驗證提供有用的方法
    /// </summary>
    public static class ArgumentValidator
    {
        /// <summary>
        /// 如果argumentToValidate為空,則拋出一個ArgumentNullException異常
        /// </summary>
        public static void ThrowIfNull(object argumentToValidate, string argumentName)
        {
            if (null == argumentName)
            {
                throw new ArgumentNullException("argumentName");
            }

            if (null == argumentToValidate)
            {
                throw new ArgumentNullException(argumentName);
            }
        }

        /// <summary>
        /// 如果argumentToValidate為空,則拋出一個ArgumentException異常
        /// </summary>
        public static void ThrowIfNullOrEmpty(string argumentToValidate, string argumentName)
        {
            ThrowIfNull(argumentToValidate, argumentName);

            if (argumentToValidate == string.Empty)
            {
                throw new ArgumentException(argumentName);
            }
        }

        /// <summary>
        /// 如果condition為真,則拋出ArgumentException異常
        /// </summary>
        /// <param name="condition"></param>
        /// <param name="msg"></param>
        public static void ThrowIfTrue(bool condition, string msg)
        {
            ThrowIfNullOrEmpty(msg, "msg");

            if (condition)
            {
                throw new ArgumentException(msg);
            }
        }

        /// <summary>
        /// 如果指定目錄存在該文件則拋出FileNotFoundException異常
        /// </summary>
        /// <param name="fileSytemObject"></param>
        /// <param name="argumentName"></param>
        public static void ThrowIfDoesNotExist(FileSystemInfo fileSytemObject, String argumentName)
        {
            ThrowIfNull(fileSytemObject, "fileSytemObject");
            ThrowIfNullOrEmpty(argumentName, "argumentName");

            if (!fileSytemObject.Exists)
            {
                throw new FileNotFoundException("'{0}' not found".Fi(fileSytemObject.FullName));
            }
        }

        public static string Fi(this string format, params object[] args)
        {
            return FormatInvariant(format, args);
        }

        /// <summary>
        /// 格式化字符串和使用<see cref="CultureInfo.InvariantCulture">不變的文化</see>.
        /// </summary>
        /// <remarks>
        /// <para>這應該是用於顯示給用戶的任何字符串時使用的“B”>“B”>“”。它意味著日志
        ///消息,異常消息,和其他類型的信息,不使其進入用戶界面,或不會
        ///無論如何,對用戶都有意義;).</para>
        /// </remarks>
        public static string FormatInvariant(this string format, params object[] args)
        {
            ThrowIfNull(format, "format");

            return 0 == args.Length ? format : string.Format(CultureInfo.InvariantCulture, format, args);
        }

        /// <summary>
        /// 如果時間不為DateTimeKind.Utc,則拋出ArgumentException異常
        /// </summary>
        /// <param name="argumentToValidate"></param>
        /// <param name="argumentName"></param>
        public static void ThrowIfNotUtc(DateTime argumentToValidate, String argumentName)
        {
            ThrowIfNullOrEmpty(argumentName, "argumentName");

            if (argumentToValidate.Kind != DateTimeKind.Utc)
            {
                throw new ArgumentException("You must pass an UTC DateTime value", argumentName);
            }
        }
    }

  2.枚舉擴展方法:

 public static class EnumExtensions
    {
        /// <summary>
        /// 獲取名字
        /// </summary>
        /// <param name="e"></param>
        /// <returns></returns>
        public static string GetName(this Enum e)
        {
            return Enum.GetName(e.GetType(), e);
        }

        /// <summary>
        /// 獲取名字和值
        /// </summary>
        /// <param name="enumType">枚舉</param>
        /// <param name="lowerFirstLetter">是否轉化為小寫</param>
        /// <returns></returns>
        public static Dictionary<string, int> GetNamesAndValues( this Type enumType, bool lowerFirstLetter)
        {
            //由於擴展方法實際是對一個靜態方法的調用,所以CLR不會生成代碼對調用方法的表達式的值進行null值檢查
            ArgumentValidator.ThrowIfNull(enumType, "enumType");
            //獲取枚舉名稱數組
            var names = Enum.GetNames(enumType);
            //獲取枚舉值數組
            var values = Enum.GetValues(enumType);

            var d = new Dictionary<string, int>(names.Length);

            for (var i = 0; i < names.Length; i++)
            {
                var name = lowerFirstLetter ? names[i].LowerFirstLetter() : names[i];
                d[name] = Convert.ToInt32(values.GetValue(i));
            }

            return d;
        }

        /// <summary>
        /// 轉換為小寫
        /// </summary>
        /// <param name="s"></param>
        /// <returns></returns>
        public static string LowerFirstLetter(this string s)
        {
            ArgumentValidator.ThrowIfNull(s, "s");

            return char.ToLowerInvariant(s[0]) + s.Substring(1);
        }
    }

五.總結:

    在本文中,主要對擴展方法進行了一些規則說明、聲明方式,使用方式,以及對擴展方法的意義和擴展方法的原理進行了簡單的解答。並在本文的最後給了一個枚舉的擴展方法代碼。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved