扩展方法原理及使用

1、写在前面

 

今天群里一个小伙伴问了这样一个问题，扩展方法与实例方法的执行顺序是什么样子的，谁先谁后（这个问题将会在文章末尾回答），所以写了这边文章，力图从原理角度解释扩展方法及其使用。

以下为主要内容：

• 什么是扩展方法

• 扩展方法实现及其原理

• 扩展方法的使用及其注意事项

 

2、什么是扩展方法

一般而言，扩展方法为现有类型添加新的方法（从面向对象的角度来说，是为现有对象添加新的行为）而无需修改原有类型，这是一种无侵入而且非常安全的方式，同时扩展方法无法访问扩展类中的任何隐私数据。扩展方法是静态的，它的使用和其他实例方法几乎没有什么区别。常见的扩展方法有linq扩展、有ienumerable扩展等。

先让我们来感受一下，扩展方法：

using system;
using system.collections.generic;
using system.linq;

namespace consolelab
{
    class program
    {
        static void main(string[] args)
        {
            list<int> lst = new list<int> { 1, 2, 3, 4 };

            lst.orderby(p => p);

            console.writeline(lst.aggregate(string.empty, (next, str) => next += str + ","));

            console.read();
        }
    }
}

输出：

以上用到了list扩展里面的orderby和aggregate，不得不说，.net在这方面做得非常精致。可是话说回来，它是如何实现的呢。接下来我们重点关注一下

3、扩展方法实现及其原理

我们先看一个关于自定义扩展方法的范例

using consoleextension;
using system;

namespace consoleextension 
{
    internal static class stringextension
    {
        internal static int toint(this string str)
        {
            if (int.tryparse(str, out int result))
            {
                return result;
            }

            throw new argumentexception("无效参数");
        }
    }
}

namespace consolelab
{
    class program
    {
        static void main(string[] args)
        {
            console.writeline("2".toint());

            console.read();
        }
    }
}

通过以上示例，我们可以总结如下特点

• 定义的扩展方法必须包括在静态类中，其本身也是静态的
• 改静态的可见性至少与所在类的可见性相同，也就是同时public或者internal
• 此方法的第一个参数指定方法所操作的类型；此参数前面必须加上 this 修饰符
• 在调用代码中，添加 using 指令，用于指定包含扩展方法类的命名空间
• 调用方式和调用实例方法一样
• 空对象是可以直接调用扩展方法的（此处就不再加示例展示了，有兴趣的可以自己验证）

接下来，我们看下反编译后的效果，

.class public auto ansi abstract sealed beforefieldinit consolelab.stringextension
    extends [mscorlib]system.object
{
    .custom instance void [mscorlib]system.runtime.compilerservices.extensionattribute::.ctor() = (
        01 00 00 00
    )
    // methods
    .method public hidebysig static 
        int32 toint (
            string str
        ) cil managed 
    {
        .custom instance void [mscorlib]

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 [mscorlib]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 "无效参数"
        il_0017: newobj instance void [mscorlib]system.argumentexception::.ctor(string)
        il_001c: throw

        il_001d: ldloc.2
        il_001e: ret
    } // end of method stringextension::toint

} // end of class consolelab.stringextension

以上是stringextension.toint()后的效果，和普通方法其实也没有什么区别

.class private auto ansi beforefieldinit consolelab.program
    extends [mscorlib]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 consolelab.stringextension::toint(string)
        il_000b: call void [mscorlib]system.console::writeline(int32)
        il_0010: nop
        il_0011: call int32 [mscorlib]system.console::read()
        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 [mscorlib]system.object::.ctor()
        il_0006: nop
        il_0007: ret
    } // end of method program::.ctor

} // end of class consolelab.program

以上是program类反编译后的源码，其调用方式跟调用静态方法没有什么区别

到了这个地方，我们可以看到，编译后的代码调用其实和调用一个类的静态方法一样，也就是stringextension::toint。只不过是.net标记了这个方法为扩展方法，也就是我们看到的system.runtime.compilerservices.extensionattribute

4、写到最后

扩展方法虽然看起来挺不错的，但是我们也要谨慎的使用，因为扩展的源对象如果发生了变化，就会导致bug的出现如果确实为给定类型实现了扩展方法，请记住以下几点：

• 如果扩展方法与其实例方法具有相同的签名，扩展方法将无法被调用，这样也避免了扩展方法对原有代码所带来的损害，所以不存在谁先谁后的问题，这就回答了，文章开头所提出的问题

• 如果扩展方法和调用方不在同一个命名空的，需要使用using导入

---

以上为本篇文章的主要内容，希望大家多提提意见，如果喜欢记得点个赞哦