C#中的扩展方法及用途

GPS平台、网站建设、软件开发、系统运维，找森大网络科技！
http://cnsendnet.taobao.com
来自森大科技官方博客
http://www.cnsendblog.com/index.php/?p=476

扩展方法使你能够向现有类型“添加”方法，而无需创建新的派生类型、重新编译或以其他方式修改原始类型。 扩展方法是一种特殊的静态方法，但可以像扩展类型上的实例方法一样进行调用。 以上是msdn官网对扩展方法的描述，现在我通过一个情景例子来对此进行阐释。假设一个控制台程序class Program{}里面的主函数如下：

 

static void Main(string[] args)

        {

            DateTime now = DateTime.Now;

            string time = now.ToString("yyyy-MM-dd HH:mm:ss");

            Console.WriteLine(time);

            Console.ReadKey();

        }

 

假设需求变了，日期的显示格式要变成"yyyy-MM-dd"这种格式，当然只需要初始化time时按下面写法改写即可：

string time = now.ToString("yyyy-MM-dd");

但是如果要改变日期格式的有很多个类呢？每个都要改一次吗？这样一旦需求变来变去就忙死人了。传统的解决方式是封装一个帮助类，在里面写方法，然后供其他类调用。

本例在当前项目模仿添加一个DateHelper类:public class DateHelper{}，在类里面定义方法：

public static string DateToString(DateTime dt)

        {

            return dt.ToString("yyyy-MM-dd HH:mm:ss");

        }

于是原来的主函数改写如下：

 

static void Main(string[] args)

        {

            DateTime now = DateTime.Now;

            string time = DateHelper.DateToString(now);

            Console.WriteLine(time);

            Console.ReadKey();

        }

 

此时如果变需求，只需要改写DateHelp类里的DateToString()方法就行了，不管有多少个类调用此方法，都会被影响。问题解决了，可是这样要调用另一个类的方法，还是有点麻烦，有没有什么方法能够让我们像now.DateToString()一样直接调用呢？当然DateTime是微软写好的，我们改不了，无法创建想要的实例方法，于是，便引出了扩展方法。
下面是扩展方法的要素：

1.此方法必须是一个静态方法

2.此方法必须放在静态类中

3.此方法的第一个参数必须以this开头，并且指定此方法是扩展自哪个类型

根据以上要素，我们DateHelper类改成静态类：public static class DateHelper{} ，同时改写DateToString()方法：

public static string DateToString(this DateTime dt)

        {

            return dt.ToString("yyyy-MM-dd HH:mm:ss");

        }

此时回到主函数方法体，输入"now."便可以看见自动提示有个DateToString()方法，于是代码可以这样写：

 

static void Main(string[] args)

        {

            DateTime now = DateTime.Now;

            string time = now.DateToString();

            Console.WriteLine(time);

            Console.ReadKey();

        }

 

显而易见，这样用起来会更加便捷，而且这样让我们看起来确实就像是被扩展类型本身具有的实例方法一样，可读性很高。下面概括一下扩展方法的特点：

1.扩展方法扩展自哪个类型，就必须是此类型的变量来使用，其他类型无法使用，本例扩展自DateTime类型，就只能是被DateTime类型的变量.出来(now.DateToString())
2.扩展方法中的this后面的参数不属于方法的参数，本例是无参数，this后面的DateTime dt是指明扩展方法扩展自何种类型
3.如果扩展方法和实例方法具有相同的签名，则优先调用实例方法
4.扩展自父类上的方法，可以被子类的对象直接使用
5.扩展自接口上的方法，可以被实现类的对象直接使用
6.扩展方法最终还是被编译器编译成：静态类.静态方法()，本例中now.DateToString()最终还是会被编译成DateHelper.DateToString(now)，这是它的本质

实际上，我们可能会遇到这样的情景，如在接口扩展一个方法的时候，所有的原本已实现该接口的类都要实现新扩展的方法，这样的改动是一个很麻烦的工作，可以使用扩展方法“曲线救国”；而有时候我们想为某个类添加新方法却不想改动这个类，那么扩展方法这种“伪添加”方法的方式就体现出它的价值了。最常见的扩展方法是LINQ标准查询运算符，运用广泛，这种方便快捷的方式理应博得码农们点1024个赞。

 

什么是扩展方法？

  扩展方法从字面上理解是指扩展的方法，而对应到面向对象编程这个格局中则是指为一个类提供的扩展方法。按照我们通常的理解，我们首先需要获得某个类的源代码，然后在这个类代码中增加成员方法，这样就可以达到为一个类提供扩展方法的目的。可是不幸地是，这种方法在没有源代码的情况下就无法奏效了，而且我们人为地去改变源代码有可能会破坏整个代码的稳定性。那么有没有一种方法能在不改变源代码的前提下为某个类提供扩展方法呢？这就是我们今天要说的扩展方法，所以我们可以将扩展方法理解为在不改变源代码的前提下向外部提供扩展方法的一种方式。C#中的扩展方法实现起来是相对来说比较简单的，例如我们做在Unity3D游戏开发的时候，可能会用到DOTween这个插件。这个插件是iTween的作者重新编写一个动画插件，效率上比iTween有较大的提升。更为重要的一点是，它采用扩展方法这种实现方式，使得我们在调用这些API接口的时候难以感觉到我们是在使用一个插件，更像是在使用Unity3D的原生函数，所以当我们使用DOTween + uGUI 这样的组合的时候，内心会感到无比的舒畅，一切都像是水到渠成一般。

扩展方法有哪些特点？

  扩展方法在实现上和普通的面向对象编程是一样的，换句话说，我们只需要定义一个类，然后在里面添加并实现相应的方法即可。但是这里需要注意的地方有三点，第一，实现扩展方法的类必须是静态类且类的名称和实现扩展方法的类无关；第二、实现扩展方法的类方法必须是静态方法；第三、实现扩展方法的类方法的第一个参数必须是使用this关键字指明要实现扩展方法的类。例如，我们知道将一个合法字符串类型转换为整型，可以使用int.parse()方法，假如我们希望为string类型扩展一个ToInt方法应该怎么办呢？我们一起来看下面的这段代码：

1. ///<summary>
2. /// 1、定义一个静态类
3. /// 2、静态类的名称和要实现扩展方法的具体类无关
4. ///</summary>
5. public static class SomeClass
6. {
7.     ///<summary>
8.     /// 3、实现一个具体的静态方法
9.     ///</summary>
10. ///<param name="str">4、第一个参数必须使用this关键字指定要使用扩展方法的类型</param>
11. ///<returns></returns>
12. public static int ToInt(this string str)
13. {
14. return int.Parse(str);
15. }

16.}

需要注意的是C#支持扩展方法是从.NET3.5版本开始，所以在编写扩展方法的时候请确保你的.NET版本是否满足这一要求。提到版本问题，有很多朋友尤其是从Unity5.0以后开始学习Unity3D的朋友，常常会在我的博客中留言提到我的代码无法在新环境下运行等等类似地问题，我觉得这个世界上更新速度最快的当属IT技术了，大家使用新版本没有问题，可是有时候因为技术发展中的历史遗留问题例如Python2.7和Python3、Unity4.X和Unity5.X，这个时候可能出现版本不兼容的问题，这个时候如果网络上的资源没有及时更新，建议大家还是及时查看官方的最新文档，因为在博主看来网络上的书籍或者相关文章都是用来参考的，古话说：尽信书不如无书，只有客观、冷静地判断知识的正确与否，我们方能学到真正有用的知识。

  好了，现在我们编写完这个扩展方法以后，就可以像下面这样使用扩展方法了：

1. string str = "1234";
2. int val = str.ToInt();

这个示例向大家展示了如何编写一个无参数的扩展方法，那么当我们需要在扩展方法中传入参数的时候该怎么做呢？我们只需要在第一个参数后继续加入参数的声明就好了。例如我们在Unity3D中常常需要给一个3D物体设置坐标，通常我们可以通过下面的代码来实现：

transform.position = new Vector3(1,1,1);

这个代码到目前为止是比较简洁的，可是我们知道在Unity3D中除了position属性以外还有localPosition属性，如果我们的代码中再涉及坐标计算的话，我相信这个代码一定会变得非常的长。更有甚者，有时候我们只想改变三维坐标中的一个维度，可是我们必须给transform.position一个三维坐标，毫无意外地此时的代码会变得更长。为了解决这个问题，我们可以扩展出三个方法SetPositionX、SetPositionY、SetPositionZ来分别为x、y、z三个坐标分量进行赋值，我们继续在SomeClass这个类中添加方法：

1. ///<summary>
2. ///设置Tranform的X坐标
3. ///</summary>
4. ///<param name="tran">当前Transform</param>
5. ///<param name="x">X坐标</param>
6. public static void SetPositionX(this Transform tran, float x)
7. {
8.     tran.position = new Vector3(x, tran.position.y, tran.position.z);
9. }

10.

11.///<summary>

12.///设置Tranform的Y坐标

13.///</summary>

14.///<param name="tran">当前Transform</param>

15.///<param name="x">Y坐标</param>

16.public static void SetPositionY(this Transform tran, float y)

17.{

1. tran.position = new Vector3(tran.position.x, y, tran.position.z);

19.}

20.

21.///<summary>

22.///设置Tranform的Z坐标

23.///</summary>

24.///<param name="tran">当前Transform</param>

25.///<param name="x">Z坐标</param>

26.public static void SetPositionZ(this Transform tran, float z)

27.{

1. tran.position = new Vector3(tran.position.x, tran.position.y, z);

29.}

使用扩展方法的利弊

  扩展方法使用起来得心应手，所以我们这里来讨论下使用扩展方法的利弊。好处当然是自由而任性地使用扩展方法对类进行扩展，而且扩展方法在Visual Studio中的智能提示会以蓝色向下箭头进行标识。扩展方法的坏处则是要看设计扩展方法的人能否较好的驾驭这个特性啦，其实所有的技术都是一样的，我常常在游戏群里听到人鄙视Unity3D引擎，以UnReal Engine4为游戏引擎世界里的泰山北斗，我承认UE4的画面效果好，可是能真正用好这个引擎的人有多少呢？扩展方法在使用的时候应该遵守就近原则，即是在最小的范围内使用扩展方法，对具体类而非抽象类实现扩展方法。我们使用扩展方法无非是因为它在逻辑层需要这样的功能，所以我们没有必要去改变抽象层的逻辑，因为这样会“污染”整个代码。举一个简单的例子，我们知道.NET中的基类是object，如果我们对这个类进行扩展，毫无疑问它会影响所有继承自object的类，这样就会造成“污染”，显然是不可取的。

小结

• 在C#中实现扩展方法的类必须是静态类且类的名称和实现扩展方法的类无关
• 实现扩展方法的类方法必须是静态方法
• 实现扩展方法的类方法的第一个参数必须是使用this关键字指明要实现扩展方法的类
• 实现扩展方法应遵守就近原则，在最小的范围内使用扩展方法以避免造成“污染”

GPS平台、网站建设、软件开发、系统运维，找森大网络科技！
http://cnsendnet.taobao.com
来自森大科技官方博客
http://www.cnsendblog.com/index.php/?p=476