C#扫盲之：带你掌握C#的扩展方法、以及探讨扩展方法的本质、注意事项

Myth丶恋晨 2022-03-17 11:36 213阅读 0赞

# [C\#扫盲之：带你掌握C\#的扩展方法、以及探讨扩展方法的本质、注意事项][C_C] #

#### 1、为什么需要扩展方法 ####

--------------------

.NET3.5给我们提供了扩展方法的概念，**它的功能是在不修改要添加类型的原有结构时，允许你为类或结构添加新方法。**

思考：那么究竟为什么需要扩展方法呢，为什么不直接修改原有类型呢？

首先，假设我们的项目中有一个类，后来过了一段时间，我们明确的知道需要为该类添加一个新功能，考虑这个需求有两个解决办法：

(1)直接修改当前类的定义

这样做的缺点是，破坏向后的兼容性，可能以前使用的旧代码无法通过编译。比如说旧代码使用了一个Methed(int,int)的方法，但是为了满足新功能我们现在修改成了Methed(int,int，int),多增加了一个参数，这样原有的旧代码就无法通过编译。

(2)以当前类为基类进行派生，在子类中进行实现

这样做也有缺点，那就是假如功能需要修改时，我们需要维护两个地方，一个是父类，一个是子类，增加了代码维护工作量

这时，新的特性扩展方法解决了以上两个问题，并且还解决了当有些类的实现是第三方的，我们无法修改源代码情况下，以及某些类是不可继承的，无法派生的，这两种情况下任然可以使用扩展方法来添加新功能。使用扩展方法，可以在不创建子类和直接修改类型的情况下修改类型。

#### 2、扩展方法怎么用 ####

--------------------

##### 2.1规则 #####

定义扩展方法必须遵守两个***Static***和一个***this***：

<table style="border:1px solid #b04f6a;"> 
 <tbody> 
  <tr> 
   <td>1.必须把扩展方法定义在静态类中，每个扩展方法也必须声明为静态的</td> 
  </tr> 
  <tr> 
   <td>2.所有扩展方法必须要使用this关键字对第一个参数进行修饰</td> 
  </tr> 
 </tbody> 
</table>

### ###

扩展方法的实现如下图所示，我们要给StringBuilder系统类型扩展一个功能用于提取字符串对象中的某个字符的索引

![399371-20160330224110754-1885641517.png][]

##### 2.1在实例层次上调用扩展方法 #####

在实例层次上调用扩展方法的意思就是，在被扩展对象的实例上进行调用而不是使用我们定义的静态类调用。具体怎样调用，请看一下代码。

![ContractedBlock.gif][] ![ExpandedBlockStart.gif][]

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Threading.Tasks;
    
    namespace ExStensionMethd
    {
        class Program
        {
            static void Main(string[] args)
            {
                StringBuilder tmpStr = new StringBuilder("12323");
                Console.WriteLine(tmpStr.StringIndef('2'));//这里我们使用的是StringBuilder的实例tmpStr来直接调用
    
                Console.ReadKey();
            }
        }
    
        /// <summary>
        /// 扩展方法静态类
        /// </summary>
        static class ExtionClass
        {
            public static int StringIndef(this StringBuilder str, char tmpChar)
            {
                int index = 0;
                for (; index < str.Length; index++)
                {
                    if (str[index].Equals(tmpChar))
                    {
                        return index;
                    }
                }
                return -1;
            }
        }
    }

实例层次调用扩展方法

说明：需要特别说明的是，扩展方法可以拥有多个参数，***但第一个参数的位置始终是属于为扩展对象的，不能改变。也就是说只有第一个参数可以并且必须用this关键字修饰***，其他的参数视为方法的普通参数。

#### **3、扩展方法的定义位置** ####

--------------------

定义扩展方法，也就是说定义扩展方法静态类时，我们必须为其指定命名空间，如果该命名空间与要使用扩展方法的命名空间不同，则需要导入命名空间(使用using关键字)。建议扩展方法定义成将要扩展类型的相同的命名空间，比如我们上面例子中的系统类型StringBulder的命名空间为System.Text，我们完全可以添加一个新类，然后定义命名空间为System.Text，也就是说最好是全局的、最外层的命名空间，这样做的好处我们将在下面阐述。

#### **4、扩展方法的本质** ####

--------------------

扩展方法的实质其实是由编译器来采用镜像原理来实现的，并没有改变原有类型或者是附加什么额外的东西，查看下图译生成后的IL代码，可以看到我们用红色框标记出来的地址，call int32 ExStensionMethd.ExtionClass::StringIndef(class \[mscorlib\]System.Text.StringBuilder,char)其实质仍然调用的原静态类的公共静态方法而已。

![399371-20160330231638910-263100277.png][]

所以代码中的**tmpStr.StringIndef('2'))和ExtionClass.StringIndef(tmpStr,'2')****是等效的**，然而为什么我们可以直接使用实例调用呢，这是因为编译器默默地做了工作。

**　　编译器工作---------------------------------------**

tmpStr.StringIndef('2')

当编译看到以下代码，编译器分两步工作：

(1) 编译器检查tmpStr当前类型，也就是**StringBulder类以及****StringBulder任何基类**是否具有所匹配的名为StringIndef包含一个char参数的函数，如果找到，则生成IL代码并Call它；

(2) 如果没有找到匹配的方法，就继续检查是否有任何静态类定义了名为StringIndef的静态方法，并且这个方法必须第一个参数是用this关键字修饰，参数类型为StringBulder的。找到时生成相应的IL代码来调用它

所以这正是我们定义扩展方法的意义，因为编译器就是按照规则来匹配相应的方法为其生成IL代码，然而就算我们定义了扩展方法，其他的程序员也不知道，这样岂不是多此一举吗，不是这样。作为宇宙对强大编译器的VS,它使用了**"智能感知“**的功能来简化我们对扩展方法的使用，当我们使用扩展类型实例时，当点号按下时，VS自动添加上扩展方法让我们选择，对我们程序员来说，就好像是直接使用了扩展对象的原有方法一样。这就是VS编译器为我们所做的。

#### 5.使用扩展方法扩展各种类型 ####

--------------------

扩展方法的扩展对象可以是类，接口，委托类型等。当扩展接口时，则所有实现了此接口的类，都拥有此扩展方法。

![ContractedBlock.gif][] ![ExpandedBlockStart.gif][]

class Program
        {
            static void Main(string[] args)
            {
                "123123123123".ShowItems();//字符串
                new[] { 1, 2, 3, 4, }.ShowItems();//int数组
                new List<int> { 1, 2, 3, 4 }.ShowItems();//List容器
    
                Console.ReadKey();
            }
        }
    
        /// <summary>
        /// 扩展方法静态类
        /// </summary>
        static class ExtionClass
        {
            public static void ShowItems<T>(this IEnumerable<T> colletion)
            {
                foreach (var item in colletion)
                {
                    if (item is string)
                        Console.WriteLine(item);
                    else
                        Console.WriteLine(item.ToString());
                }
    
            }
        }

接口的扩展方法

#### 6.扩展方法使用注意事项 ####

--------------------

*  C\#支持扩展方法，不支持扩展属性、扩展事件、扩展操作符等；
 *  扩展类必须在非泛型静态类中定义，不能是泛型类，扩展类名可以任意定义。【为什么不能是泛型静态类知道吗？如果真的不知道，说明上面的内容你没有仔细看嘞，因为扩展方法其实再是编译时进行的匹配和编译，而泛型类只有在运行时才可以进行真正确定它具体类型，所以就不能是泛型静态类了】；
 *  扩展方法的定义必须具有文件作用域，也就是说必须在文件中某个命名空间下直接定义，不能嵌套在另一个类中定义；
 *  多个静态类可以定义相同的扩展方法，这一点需要注意在调用时要明确调用对象。调用冲突时，不能再再使用实例调用。只能使用静态类.方法的普通方式进行使用；
 *  假如扩展的这个类是一个基类时，而它又有很多派生类，则其派生类也拥有这个扩展方法(正如上面我们扩展的接口一样），这有个好处也有坏处，好处就是子类可以使用这个方法，坏处就是智能提示会有递归下去，有很多填充的垃圾信息；
 *  扩展方法存在版本问题。正如我们前面所说，编译时会首先查找这个类是否定义了相匹配的方法，然后才回去查找静态类。所以假如现在我们定义了一个IndexOf的方法，而在微软的后续版本中，官方添加了同样名为IndexOf的方法，则我们的静态方法就不会调用。

参考资料：精通C#(第6版)
    　　　　　CLR via C#(第4版)

由于本人才学识浅，描述难免纰漏，如有错误，欢迎指出。么么！

posted @ 2016-03-31 09:14 [Mathca][] 阅读( ...) 评论( ...) [编辑][Link 1] 收藏

[C_C]: https://www.cnblogs.com/Matcha/p/5312288.html
[399371-20160330224110754-1885641517.png]: /images/20220317/fb5b2bc6cd714f92a4f2469bc08199fc.png
[ContractedBlock.gif]: https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif
[ExpandedBlockStart.gif]: /images/20220317/44b48a858e8944d4b24891c6b87271fb.png
[399371-20160330231638910-263100277.png]: /images/20220317/cb322d9b3ee34673b1098d8bc26f57c9.png
[Mathca]: https://www.cnblogs.com/Matcha/
[Link 1]: https://i.cnblogs.com/EditPosts.aspx?postid=5312288