C# 实现和调用自定义扩展方法

C# 编程指南

如何：实现和调用自定义扩展方法

 

 

更新：2007 年 11 月

本主题演示如何为 .NET Framework 类库中的任何类型或您想要扩展的任何其他 .NET 类型实现您自己的扩展方法。客户端代码可通过以下方式使用您的扩展方法：添加对包含这些扩展方法的 DLL 的引用，并且添加一条 using 指令以指定在其中定义这些扩展方法的命名空间。

定义和调用扩展方法

1. 定义一个静态类以包含扩展方法。

   该类必须对客户端代码可见。有关可访问性规则的更多信息，请参见访问修饰符（C# 编程指南）。

2. 将该扩展方法实现为静态方法，并使其至少具有与包含类相同的可见性。

3. 该方法的第一个参数指定方法所操作的类型；该参数必须以 this 修饰符开头。

4. 在调用代码中，添加一条 using 指令以指定包含扩展方法类的命名空间。

5. 按照与调用类型上的实例方法一样的方式调用扩展方法。

   请注意，第一个参数不是由调用代码指定的，因为它表示正应用运算符的类型，并且编译器已经知道对象的类型。您只需通过 n 为这两个形参提供实参。

 示例

下面的示例在 MyExtensions.StringExtension 类中实现了一个名为 WordCount 的扩展方法。该方法对 String 类进行操作，而该类被指定为第一个方法参数。MyExtensions 命名空间被导入到应用程序命名空间中，并且该方法是在 Main 方法内调用的。

C#

;
using System.Text;
using System;

namespace CustomExtensions
{
    //Extension methods must be defined in a static class
    public static class StringExtension
    {
        // This is the extension method.
        // The first parameter takes the "this" modifier
        // and specifies the type for which the method is defined.
        public static int WordCount(this String str)
        {
            return str.Split(new char[] {' ', '.','?'}, StringSplitOptions.RemoveEmptyEntries).Length;
        }
    }
}
namespace Extension_Methods_Simple
{
    //Import the extension method namespace.
    using CustomExtensions;
    class Program
    {
        static void Main(string[] args)
        {
            string s = "The quick brown fox jumped over the lazy dog.";
            //  Call the method as if it were an
            //  instance method on the type. Note that the first
            //  parameter is not specified by the calling code.
            int i = s.WordCount();
            System.Console.WriteLine("Word count of s is {0}", i);
        }
    }
}

若要运行这段代码，请将其复制并粘贴到已经在 Visual Studio 中创建的 Visual C# 控制台应用程序项目中。默认情况下，此项目针对的是 .NET Framework 3.5 版，并且具有一个对 System.Core.dll 的引用和一条针对 System.Linq 的 using 指令。如果项目不满足上面的一个或多个要求，则您可以手动添加它们。有关更多信息，请参见如何：创建 LINQ 项目。

 安全性

扩展方法不会引起任何特定安全漏洞。它们永远不可用于模拟类型上的现有方法，因为在解决所有名称冲突时，都会偏向于类型本身所定义的实例或静态方法。扩展方法无法访问扩展类中的任何私有数据。

 

扩展方法调用

expr

在以下形式之一的方法调用

. identifier ( )

expr . identifier ( args )

expr . identifier < typeargs > ( )

expr . identifier < typeargs > ( args )

如果正常的调用处理找不到适用的方法，则将尝试以扩展方法调用的形式处理该构造。目标是查找最佳的 type-name C，以便可以进行相应的静态方法调用：

C . identifier ( expr )

C . identifier ( expr , args )

C . identifier < typeargs > ( expr )

C . identifier < typeargs > ( expr , args )

如果满足以下各项，则扩展方法 C_i.M_j 符合条件 (eligible)：

·         C_i 为非泛型、非嵌套类

·         M_j 的名称为 identifier

·         M_j 作为如上所示的静态方法应用于参数时是可访问且适用的

·         存在从 expr 到 M_j 的第一个参数的类型的隐式标识、引用或装箱转换。

对 C 的搜索操作如下：

 

 

o        如果给定的命名空间或编译单元直接包含具有适当扩展方法 M_j 的非泛型类型声明 C_i，则这些扩展方法的集合为候选集。

o        如果使用给定命名空间或编译单元中的命名空间指令导入的命名空间直接包含具有适当扩展方法 M_j 的非泛型类型声明 C_i，则这些扩展方法的集合为候选集。

·         如果在任何封闭命名空间声明或编译单元中都找不到候选集，则会出现编译时错误。

·         否则，将对候选集应用重载决策，如（第 7.4.3 节）中所述。如果找不到一个最佳方法，则会出现编译时错误。

·         C 是将最佳方法声明为扩展方法的类型。

·         如果将 C 用作目标，则将以静态方法调用（第 7.4.4 节）的形式处理该方法调用。

上述规则表示，实例方法优先于扩展方法，内部命名空间声明中可用的扩展方法优先于外部命名空间声明中可用的扩展方法，并且直接在命名空间中声明的扩展方法优先于通过 using 命名空间指令导入该命名空间的扩展方法。例如：

public static class E

{

     public static void F(this object obj, int i) { }

     public static void F(this object obj, string s) { }

}

class A { }

class B

{

     public void F(int i) { }

}

class C

{

     public void F(object obj) { }

}

class X

{

     static void Test(A a, B b, C c) {

        a.F(1);              // E.F(object, int)

        a.F("hello");     // E.F(object, string)

        b.F(1);              // B.F(int)

        b.F("hello");     // E.F(object, string)

        c.F(1);              // C.F(object)

        c.F("hello");     // C.F(object)

     }

}