如何:实现和调用自定义扩展方法(C# 编程指南) - C# 编程指南

返回介绍

如何:实现和调用自定义扩展方法(C# 编程指南)

发布于 2019-11-12 字数3094 浏览 893 评论 0

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

定义和调用扩展方法

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

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

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

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

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

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

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

示例

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

C#  复制代码
using System.Linq;
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 项目。

安全性

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

请参见

概念

C# 编程指南

参考

扩展方法(C# 编程指南)静态类和静态类成员(C# 编程指南)protected(C# 参考)internal(C# 参考)public(C# 参考)this(C# 参考)命名空间(C# 参考)

其他资源

语言集成查询 (LINQ)

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!