详解C#扩展方法原理及其使用
作者:艾心❤
1、写在前面
今天群里一个小伙伴问了这样一个问题,扩展方法与实例方法的执行顺序是什么样子的,谁先谁后(这个问题会在文章结尾回答)。所以写了这边文章,力图从原理角度解释扩展方法及其使用。
以下为主要内容:
- 什么是扩展方法
- 扩展方法原理及自定义扩展方法
- 扩展方法的使用及其注意事项
2、什么是扩展方法
一般而言,扩展方法为现有类型添加新的方法(从面向对象的角度来说,是为现有对象添加新的行为)而无需修改原有类型,这是一种无侵入而且非常安全的方式。扩展方法是静态的,它的使用和其他实例方法几乎没有什么区别。常见的扩展方法有Linq扩展、有IEnumerable扩展等。
先让我们来感受一下.NET中自带的扩展方法,其中OrderBy和Aggregate都是系统自带的扩展方法
using System; using System.Collections.Generic; using System.Linq; namespace Test { class Program { static void Main(string[] args) { List<int> lst = new List<int> { 2, 1, 4, 3 }; string result = lst.OrderBy(p => p).Aggregate(string.Empty, (next, p) => next += p + ","); Console.WriteLine(result); Console.ReadLine(); } } }
是不是感觉扩展方法很优美,使用起来和实例方法几乎没有区别。不得不说.NET在这方面做得很精致,很让人钦佩,那么接下来我们来看看扩展方法的原理
3、扩展方法原理及自定义扩展方法
首先我们,先看看如何自定义扩展方法
using System; using TestExtension; namespace Test { class Program { static void Main(string[] args) { Console.WriteLine("2".ToInt32()); Console.ReadLine(); } } } namespace TestExtension { public static class StringExtension { public static int ToInt32(this string str) { if (int.TryParse(str, out int result)) { return result; } throw new ArgumentException("无法转换为Int32类型"); } } }
- 必须是静态类,扩展方法也为静态方法
- 此方法的第一个参数指定方法所操作的类型;此参数前面必须加上 this 修饰符
- 在调用代码中,如何不再同一个命名空间,需要添加 using 指令,导入需要调用的扩展方法所在的命名空间
- 需要注意的是,第一个this标记的参数并非是实参,而是标识该扩展所指定的类型,调用的时候只需要提供this后的形参即可
接下来我们来探究一下扩展方法反编译后的效果:
这是StringExtension编译后的代码,可以看到扩展方法在编译后被标记了ExtensionAttribute这个特性,也就是说扩展方法在编译期就已经被绑定成扩展方法了
.class public auto ansi abstract sealed beforefieldinit TestExtension.StringExtension extends [System.Runtime]System.Object { .custom instance void [System.Runtime]System.Runtime.CompilerServices.ExtensionAttribute ::.ctor() = ( 01 00 00 00 ) // Methods .method public hidebysig static int32 ToInt32 ( string str ) cil managed { .custom instance void [System.Runtime]System.Runtime.CompilerServices.ExtensionAttribute ::.ctor() = ( 01 00 00 00 ) // Method begins at RVA 0x2050 // Code size 31 (0x1f) .maxstack 2 .locals init ( [0] int32, [1] bool, [2] int32 ) IL_0000: nop IL_0001: ldarg.0 IL_0002: ldloca.s 0 IL_0004: call bool [System.Runtime]System.Int32::TryParse(string, int32&) IL_0009: stloc.1 IL_000a: ldloc.1 IL_000b: brfalse.s IL_0012 IL_000d: nop IL_000e: ldloc.0 IL_000f: stloc.2 IL_0010: br.s IL_001d IL_0012: ldstr "无法转换为Int32类型" IL_0017: newobj instance void [System.Runtime]System.ArgumentException::.ctor(string) IL_001c: throw IL_001d: ldloc.2 IL_001e: ret } // end of method StringExtension::ToInt32 } // end of class TestExtension.StringExtension
我们看一下调用后的效果,和直接调用静态方法一样TestExtension.StringExtension::ToInt32(string) ,至此,我们已经知道了扩展方法的使用了,编译器绑定,底层调用和静态调用一直,这也解释了一个问题,就是当类型为空的时候,为什么调用扩展方法了
.namespace Test { .class private auto ansi beforefieldinit Test.Program extends [System.Runtime]System.Object { // Methods .method private hidebysig static void Main ( string[] args ) cil managed { // Method begins at RVA 0x207b // Code size 24 (0x18) .maxstack 8 .entrypoint IL_0000: nop IL_0001: ldstr "2" IL_0006: call int32 TestExtension.StringExtension::ToInt32(string) IL_000b: call void [System.Console]System.Console::WriteLine(int32) IL_0010: nop IL_0011: call string [System.Console]System.Console::ReadLine() IL_0016: pop IL_0017: ret } // end of method Program::Main .method public hidebysig specialname rtspecialname instance void .ctor () cil managed { // Method begins at RVA 0x2094 // Code size 8 (0x8) .maxstack 8 IL_0000: ldarg.0 IL_0001: call instance void [System.Runtime]System.Object::.ctor() IL_0006: nop IL_0007: ret } // end of method Program::.ctor } // end of class Test.Program }
4、扩展方法的使用及其注意事项
扩展方法虽然很好用,但是如果我们扩展的对象发生了版本迭代,则会增加扩展方法失效的风险。
一下是在使用扩展方法时需要注意的地方
- 扩展方法与该类型中定义的方法具有相同的签名,编译器总是绑定到该实例方法,也就是扩展方法永远不会被调用,这也就回答了题目刚开始所说的问题。同时这个地方应该是考虑到了程序安全的问题,不然很容易出现代码注入问题。
- 当出现命名空间不同时,则需要使用using导入命名空间
- 同时扩展方法可以被修饰为internal,public,但需要类和扩展方法保持同样的修饰标识
以上就是详解C#扩展方法原理及其使用的详细内容,更多关于c# 扩展方法的资料请关注脚本之家其它相关文章!