技术图文：C# 语言中的扩展方法

背景

前段时间，在知识星球立了一个Flag，在总结 Leetcode 刷题的第五篇图文时遇到了扩展方法 这个知识点，于是先总结一下。

1．扩展方法概述

扩展方法能够向现有类型“添加”方法，而无需创建新的派生类型、重新编译或以其它方式修改原始类型。

最常见的扩展方法是 LINQ 标准查询运算符，它将查询功能添加到现有的 System.Collection.IEnumerable和Syste.Collection.Generic.IEnumerable<T> 类型。

若要使用标准查询运算符，要先使用 using System.Linq 指令将它们置于范围中。然后，任何实现了 IEnumerable<T> 的类型都具有 GroupBy<TSource,Tkey>、OrderBy<TSource,TKey>、Average 等实例方法。在 IEnumerable<T> 类型的实例（如 List<T>或Array）后键入“.”时，可以在 IntelliSense 语句完成中看到这些附加方法。

class Program
{static void Main(string[] args){int[] nums = new int[] { 10, 45, 15, 39, 21, 26 };List<int> result = nums.SelectMany(g =>{List<int> lst = new List<int>();if (g > 20) lst.Add(g);return lst;}).ToList();Show(result);result = nums.OrderBy(g => g).ToList();Show(result);}static void Show(List<int> lst){foreach (int i in lst){Console.Write(i + "\t");}Console.WriteLine();}
}// 45      39      21      26
// 10      15      21      26      39      45

2．扩展方法的实现与调用

扩展方法必须在非泛型静态类中定义，且该方法必须是静态（static）方法，通过实例方法语法进行调用。

第一个参数指定该方法所操作的类型，并且该参数以 this 修饰符为前缀。仅当使用 using 指令将命名空间显式导入到源代码中之后，扩展方法才位于范围中。

下面示例演示了在非嵌套的、非泛型静态类型内部，为 System.String 类定义一个扩展方法。

程序代码如下：

namespace CustomExtensions
{//定义一个静态类以包含扩展方法public static class MyExtensions{public static int WordCount(this string str){int result = str.Split(new char[] {' ', '.', '?'},StringSplitOptions.RemoveEmptyEntries).Length;return result;}}
}//在调用代码中，添加一条using指令以指定包含扩展方法类的命名空间。
using CustomExtensions;
namespace Sample
{class Program{static void Main(string[] args){string s = "The quick brown fox jumped over the lazy dog.";//按照与调用类型上的实例方法一样的方式调用扩展方法。int i = s.WordCount();Console.WriteLine("World count of s is {0}", i);}}
}
// World count of s is 9

3. 为枚举创建新方法

可以使用扩展方法对枚举类型进行扩展。

程序代码如下：

public enum Grades
{A = 4,B = 3,C = 2,D = 1,F = 0
}public static class Extensions
{public static Grades MinPassing = Grades.D;public static bool Passing(this Grades grade){return grade >= MinPassing;}
}class Program
{static void Main(string[] args){Grades g1 = Grades.D;Grades g2 = Grades.F;Console.WriteLine("First {0} a passing grade.", g1.Passing() ? "is" : "is not");Console.WriteLine("Second {0} a passing grade.", g2.Passing() ? "is" : "is not");Extensions.MinPassing = Grades.C;Console.WriteLine("First {0} a passing grade.", g1.Passing() ? "is" : "is not");Console.WriteLine("Second {0} a passing grade.", g2.Passing() ? "is" : "is not");}
}// First is a passing grade.
// Second is not a passing grade.
// First is not a passing grade.
// Second is not a passing grade.

4．在编译时绑定扩展方法的规则

可以使用扩展方法来扩展类或接口，但不能重写（override）扩展方法。与接口或类方法具有相同名称和签名的扩展方法永远不会被调用。

编译时，扩展方法的优先级总是比类型本身中定义的实例方法低。当编译器遇到方法调用时，它首先在该类型的实例方法中寻找匹配的方法。如果未找到任何匹配方法，编译器将搜索为该类型定义的任何扩展方法，并且绑定到它找到的第一个扩展方法。

程序代码如下：

namespace DefineIMyInterface
{public interface IMyInterface{void MethodB();}
}namespace Extensions
{using DefineIMyInterface;public static class Extension{public static void MethodA(this IMyInterface myInterface, int i){Console.WriteLine("Extension.MethodA(this IMyInterface myInterface, int i)");}public static void MethodA(this IMyInterface myInterface,string s){Console.WriteLine("Extension.MethodA(this IMyInterface myInterface, string s)");}public static void MethodB(this IMyInterface myInterface){Console.WriteLine("Extension.MethodB(this IMyInterface myInterface)");}}
}namespace Sample
{using DefineIMyInterface;using Extensions;class A : IMyInterface{public void MethodB(){Console.WriteLine("A.MethodB()");}}class B : IMyInterface{public void MethodB(){Console.WriteLine("B.MethodB()");}public void MethodA(int i){Console.WriteLine("B.MethodA(int i)");}}class C : IMyInterface{public void MethodB(){Console.WriteLine("C.MethodB()");}public void MethodA(object obj){Console.WriteLine("C.MethodA(object obj)");}}class Program{static void Main(string[] args){A a = new A();B b = new B();C c = new C();a.MethodA(1);a.MethodA("hello");a.MethodB();Console.WriteLine("----------");b.MethodA(1);b.MethodB();b.MethodA("hello");Console.WriteLine("----------");c.MethodA(1);c.MethodA("hello");c.MethodB();}}
}// Extension.MethodA(this IMyInterface myInterface, int i)
// Extension.MethodA(this IMyInterface myInterface, string s)
// A.MethodB()
// ----------
// B.MethodA(int i)
// B.MethodB()
// Extension.MethodA(this IMyInterface myInterface, string s)
// ----------
// C.MethodA(object obj)
// C.MethodA(object obj)
// C.MethodB()

参考文献

https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/classes-and-structs/extension-methods

当前活动

我是终身学习者“老马”，一个长期践行“结伴式学习”理念的 中年大叔。

我崇尚分享，渴望成长，于2010年创立了“LSGO软件技术团队”，并加入了国内著名的开源组织“Datawhale”，也是“Dre@mtech”、“智能机器人研究中心”和“大数据与哲学社会科学实验室”的一员。

愿我们一起学习，一起进步，相互陪伴，共同成长。

后台回复「搜搜搜」，随机获取电子资源！
欢迎关注，请扫描二维码：