【Unity】Unity开发进阶（七）双刃剑：扩展方法

---

扩展方法

C#在3.0版本中引入了“扩展方法”，既有静态方法的优点，又使调用它们的代码的可读性得到了提高。在使用扩展方法时，可以像调用实例方法那样调用静态方法。

扩展方法声明

1. 必须在一个非嵌套的、非泛型的静态类中（所以必须是一个静态方法）。
2. 至少有一个参数。
3. 第一个参数必须附加this关键字做前缀。
4. 第一个参数不能有其他任何修饰符（如ref或out）。
5. 第一个参数的类型不能是指针类型。

如何使用

扩展方法参数可以给该参数的类型增加一个方法，简单点说就是在A类中写一个方法，B类中也会拥有这个方法。比如：

public static class A
{
    public static void Foo(this B s)
    {
    }
}

class B
{
}

class MainClass
{
	static void Main()
    {
        B b = new B();
        // 使用B类的对象调用A类中定义的Foo方法
        b.Foo();          
    }
}

代码中对象b可以直接调用Foo方法，因为这个方法已经被扩展到B类中了。

举个例子

我想做一个用于辅助Transform类的工具类（TransformHelper），其中有一个方法是要递归查找子对象中的某个变换组件，这时候就可以通过 **this参数（扩展方法）**来给Transform类添加此方法，代码如下：

/// <summary>
///变换组件助手类
/// </summary>
public static class TransformHelper
{
    /// <summary>
    /// 递归查找变换组件
    /// </summary>
    /// <param name="cuurentTF">当前对象</param>
    /// <param name="childName">要查找的子节点名称</param>
    /// <returns></returns>
    public static Transform FindChildByName(this Transform cuurentTF, string childName)
    {
        Transform child = cuurentTF.Find(childName);

        if (child != null) return child;

        for (int i = 0; i < cuurentTF.childCount; i++)
        {
            child = FindChildByName(cuurentTF.GetChild(i), childName);
            if (child != null) return child;
        }

        return null;
    }
}

/// <summary>
/// 游戏主窗口
/// </summary>
public class UIMainWindow : MonoBehaviour
{
    private void Start()
    {
        // 用静态类的方式调用方法
        TransformHelper.FindChildByName(transform, "ButtonGameStart").GetComponent<Button>().onClick.AddListener(OnGameStartButtonClick);
        
        // 直接使用变化组件调用方法，注意，此时不用要再传第一个参数了，因为第一个参数已经成为默认的this了。
        transform.FindChildByName("ButtonGameStart").GetComponent<Button>().onClick.AddListener(OnGameStartButtonClick);
    }
}

基本原则

1. C#只支持扩展方法，不支持扩展属性、扩展事件、扩展操作符等。
2. 扩展方法（第一个参数前面是this的方法）必须在非泛型的静态类中声明，扩展方法必须有一个参数，而且只有第一个参数使用this标记。
3. C#编译器查找静态类中的扩展方法时，要求这些静态类本身必须具有文件作用域。
4. C#编译要求“导入”扩展方法。（静态方法可以任意命名，C#编译器在寻找方法时，需要花费时间进行查找，需要检查文件作用域中的所有的静态类，并扫描它们的所有静态方法来查找一个匹配）。
5. 多个静态类可以定义相同的扩展方法。
6. 用一个扩展方法扩展一个类型时，同时也扩展了派生类型。
7. 调用方法时无需传递第一个参数，默认指定调用方法的对象（this）为第一个参数。

扩展方法的优劣分析

刚接触到扩展方法时，内心总觉得这是不合理的，因为扩展方法可能导致每个类都可能有新的、隐藏的、未知的方法，首先从内存的角度考虑就是不合理的（问题1），其次在代码的可维护性和易用性两方面考虑也是颇具困难的（问题2）。

比如我将方法扩展到泛型中，代码如下：

public static string FindKey<T>(this T obj, FindHandler<T> handler)
{
    return null;
}

按照正常的理解，会以为所有类型，或者说所有引入这个类的类型都会加入FindKey方法，但实际上并不是这样的，或者说并不完全是这样的。虽然这些方法可以使用对象直接调用，但实际上被调用的还是最初的那个静态方法，而不是重新写入到泛型T类中的方法。

为什么这么说呢？

因为在扩展方法中会使用ExtensionAttribute这个Attribute。一旦使用this关键字标记了某个静态方法的第一个参数，编译器就会在内部向该方法应用一个定制的attribute，这个attribute会在最终生成的文件的元数据中持久性的存储下来，此属性在System.Core dll程序集中。

任何静态类只要包含了至少一个扩展方法，它的元数据中也会应用这个attribute，任何一个程序集包含了至少一个符合上述特点的静态类，它的元数据也会应用这个attribute。如果代码用了一个不存在的实例方法，编译器会快速的扫描引用的所有程序集，判断它们哪些包含了扩展方法，然后，在这个程序集中，可以扫描包含了扩展方法的静态类。

如果同一个命名空间中的两个类含有扩展类型相同的方法，就没有办法做到只用其中一个类中的扩展方法。为了通过类型的简单名称（没有命名空间前缀）来使用类型，可以导入该类型所有在的命名空间，但这样做的时候，你没有办法阻止那个命名空间中的扩展方法也被导入进来。

回到最初提出的问题：

问题1：是不是每个对象都加入了这个扩展方法？
这个问题其实并未发生，因为C#使用的方式不是给每个对象加一个方法，而是另外提供了一个扩展方法的列表，在使用时通过列表找到被扩展的静态方法然后调用，也就是说方法还是只有那一个方法，并没有大范围的占据方法区。

问题2：代码的可维护性和易用性上是否受到了影响？
这个问题其实是存在的，如果开发团队不能有效的控制扩展方法的定义，将会出现局部代码无法溯源或者扩展功能影响主场景功能的问题，导致代码可读性差，语义不明确等问题。但如果开发团队能够有效的控制扩展方法的创建，并提供专门的扩展方法维护及使用方案，开发效率也会有些许提升。

总结

扩展方法可以说是一把双刃剑，用好了锋利无比，用不好也有可能会自伤，但总得来说还是功大于过，特别适合具有经验的团队使用。

---

本文部分内容引用彭泽0902提供的博客：相关链接

更多内容请查看总目录【Unity】Unity学习笔记目录整理