《C# in Depth：深入理解C#》读书笔记 - 委托

委托的基本概念
进一步理解委托

委托的基本概念

最近在看深入理解C#，发现这是一本很不错的书，将很多C#的知识点联系了起来，更像是一本C#历史书，从C# 1一步步介绍到C# 4。

所以准备一边看，一边整理读书笔记。那么就先从委托开始。

委托是C#中一个非常重要的概念，从C# 1开始就有了委托这个核心概念，在C# 2和C# 3中委托又有了很多改进。

通过委托，我们可以将一个方法当作对象封装起来，并且在运行时，我们可以通过这个对象来完成方法的调用。

委托的使用

首先，来个简单的例子，苹果只负责设计iphone，而把组装iphone的工作委托给富士康做。

class Apple
{
    //声明委托类型
    public delegate void AssembleIphoneHandler();
    public AssembleIphoneHandler AssembleIphone;

    public void DesignIphone()
    {
        Console.WriteLine("Design Iphone By Apple");
    }
}

class Foxconn
{
    //与委托类型签名相同的方法
    public void AssembleIphone()
    {
        Console.WriteLine("Assemble Iphone By Foxconn");
    }
}

class Program
{
    static void Main(string[] args)
    {
        Apple apple = new Apple();
        Foxconn foxconn = new Foxconn();

        //创建委托实例
        apple.AssembleIphone = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);

        apple.DesignIphone();
        //委托实例的调用
        apple.AssembleIphone();
        //通过Invoke进行显示调用
        //apple.AssembleIphone.Invoke();

        Console.Read();
    }
}

从上面的例子中，可以体会一下委托的使用。使用委托需要满足4个条件：

声明一个委托类型
找到一个跟委托类型具有相同签名的方法（可以是实例方法，也可以是静态方法）
通过相同签名的方法来创建一个委托实例
通过委托实例的调用完成对方法的调用

委托类型和委托实例

当我们使用委托的时候，一定要注意这两个概念。

委托类型，是通过delegate关键字声明的一种类型，例如上面例子中的：

public delegate void AssembleIphoneHandler();

注意，”AssembleIphoneHandler”是一个委托类型，它有自己的方法，可以创建相关的实例。通过”ILSpy”可以看到”AssembleIphoneHandler”的方法以及父类信息。
这里写图片描述

委托类型的声明过程中描述了该委托类型的签名（返回类型，参数列表），这个签名就决定了那个方法可以用来创建一个改委托类型的委托实例；同时，这个签名还表示了该委托实例调用的签名。

而委托实例，就是通过委托类型进行实例化的对象，例如上面例子中的：

apple.AssembleIphone = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);

在创建委托实例的过程中，我们需要找到一个跟委托类型签名相同的方法来完成委托实例的创建。

委托的合并和删除

在前面的例子中，委托实例（apple.AssembleIphone）只对应一个操作（方法foxconn.AssembleIphone）。但是，每个委托实例都有一个操作列表，称为委托实例的调用列表（invocation list）。在System.Delegate类中，有两个静态方法Combine和Remove，通过这两个静态方法，我们就可以进行两个委托实例的调用列表的合并和删除。

接着上面的例子进行修改，这次来看看委托的合并和删除。

class Foxconn
{
    //与委托类型签名相同的方法
    public void AssembleIphone()
    {
        Console.WriteLine("Assemble Iphone By Foxconn");
    }

    public void PackIphone()
    {
        Console.WriteLine("Pack Ipnone By Foxconn");
    }

    public void ShipIphone()
    {
        Console.WriteLine("Ship Iphone By Foxconn");
    }
}


class Program
{
    static void Main(string[] args)
    {
        Apple apple = new Apple();
        Foxconn foxconn = new Foxconn();

        //创建委托实例
        apple.AssembleIphone = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);
        //apple.AssembleIphone += new Apple.AssembleIphoneHandler(foxconn.PackIphone);
        apple.AssembleIphone = (Apple.AssembleIphoneHandler)Delegate.Combine(apple.AssembleIphone, new Apple.AssembleIphoneHandler(foxconn.PackIphone));
        apple.AssembleIphone += new Apple.AssembleIphoneHandler(foxconn.ShipIphone);

        apple.DesignIphone();
        //委托实例的调用
        apple.AssembleIphone();
        //通过Invoke进行显示调用
        //apple.AssembleIphone.Invoke();

        Console.Read();
    }
}

这次，我们在Foxconn类中加了打包和运输的方法，这样，可以通过Combine方法将组装、打包和运输三个操作合并到委托实例apple.AssembleIphone的调用列表中。

当我们调用委托实例的时候，委托实例的调用列表中的所有操作会依次被执行。

注意，一般在代码中，很少直接使用Combine和Remove方法的显式调用，而是通过”+=”和”-=”操作符来实现。

委托是不易变的

这里有一点要提的是，委托是不易变的，一旦创建了一个委托实例后，这个实例的所有内容都不能被改变了（就像string一样，string也是不易变的）。

所以说Combine和Remove都没有改变委托实例，都是新建了一个委托实例。

委托调用列表

在使用调用列表的时候，有些关键点需要注意一下，假如说一个委托实例的调用列表为[methodA, methodB, methodC]。那么当我们调用委托实例的时候，methodA, methodB, methodC会依次被执行。

如果上面A-C三个方法都有返回值，我们只能得到最后一个操作的返回值，其他的返回值都将被忽略。
如果调用列表中的一个操作有异常，那么所有的下游操作都不会被执行。
举例，我们在PackIphone方法中加入一个异常，那么委托列表中的ShipIphone操作将不会被执行到：

class Foxconn
{
    //与委托类型签名相同的方法
    public void AssembleIphone()
    {
        Console.WriteLine("Assemble Iphone By Foxconn");
    }

    public void PackIphone()
    {
        throw new NotImplementedException();
    }

    public void ShipIphone()
    {
        Console.WriteLine("Ship Iphone By Foxconn");
    }
}


class Program
{
    static void Main(string[] args)
    {
        Apple apple = new Apple();
        Foxconn foxconn = new Foxconn();

        //创建委托实例
        apple.AssembleIphone = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);
        //apple.AssembleIphone += new Apple.AssembleIphoneHandler(foxconn.PackIphone);
        apple.AssembleIphone = (Apple.AssembleIphoneHandler)Delegate.Combine(apple.AssembleIphone, new Apple.AssembleIphoneHandler(foxconn.PackIphone));
        apple.AssembleIphone += new Apple.AssembleIphoneHandler(foxconn.ShipIphone);

        apple.DesignIphone();
        //委托实例的调用
        try
        {
            apple.AssembleIphone();
        }
        catch
        {
            Console.WriteLine("an exception happened");
        }

        Console.Read();
    }
}

GetInvocationList

对于上面两个问题，我们可以通过委托实例的GetInvocationList()方法，通过这个方法可以得到调用列表中的所有操作。

这样，就可以显示调用委托来进行异常处理或者返回值的保存。

foreach (Apple.AssembleIphoneHandler method in apple.AssembleIphone.GetInvocationList())
{
    try
    {
        method();
    }
    catch
    {
        Console.WriteLine("an exception happened");
    }
}

总结

本文介绍了委托的基本概念，以及委托类型和委托实例的区别。

委托本质上是一个派生自System.MulticastDelegate的类，我们可以通过特定的（与委托类型签名相同）的方法创建委托实例，通过委托是，可以间接完成某些操作。

同时，可以通过Combine和Remove操作来进行委托实例的调用列表的合并和删除。

进一步理解委托

前面一篇文章介绍了委托的基本知识，接下来就进一步研究一下委托。

委托类型

其实，刚开始觉得委托类型是一个比较难理解的概念，怎么也不觉得下面的”AssembleIphoneHandler”是一个类型。

public delegate void AssembleIphoneHandler();

按照正常的情况，如果我们要创建一个委托类型应该是：

public class AssembleIphoneHandler : System.MulticastDelegate
{
}

但是，这种写法是编译不过的，会提示不能从”System.MulticastDelegate”派生子类。

其实，这里是编译器为我们做了一个转换，当我们使用delegate关键字声明一个委托类型的时候，编译器就会按照上面代码片段中的方式为我们创建一个委托类型。

知道了这些东西，对于委托类型的理解就比较容易了，通过delegate声明的委托类型就是一个从”System.MulticastDelegate”派生出来的子类。

建立委托链

下面我们通过一个例子来看看委托链的建立，以及调用列表的变化，基于前面一篇文章中的例子进行一些修改。

class Program
{
    static void Main(string[] args)
    {
        Apple apple = new Apple();
        Foxconn foxconn = new Foxconn();

        Apple.AssembleIphoneHandler d1, d2, d3, d4 = null;
        d1 = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);
        d2 = new Apple.AssembleIphoneHandler(foxconn.PackIphone);
        d3 = new Apple.AssembleIphoneHandler(foxconn.ShipIphone);

        d4 += d1;
        d4 += d2;
        d4 += d3;

        d4();

        Console.Read();
    }
}

我们接下来进行一下单步调试看看委托链建立的过程。

当下面三句执行完成后，可以通过VS看到d1、d2和d3的详细信息

d1 = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);

这里写图片描述

d2 = new Apple.AssembleIphoneHandler(foxconn.PackIphone);

这里写图片描述

d3 = new Apple.AssembleIphoneHandler(foxconn.ShipIphone);

这里写图片描述

对于上面三个委托实例来说：

调用列表为空，所以_invocationCount为0，_invocationList为空
_target代表创建委托实例的方法来自Foxconn的实例；如果是静态方法创建的委托实例_target值为null
_methodPtr代表这个方法的唯一标识，可以理解为句柄
_methodBase包含创建委托实例的方法的信息，方法名、返回类型等等
2. 通过”+=”操作符来进行委托合并

d4 += d1;

这里写图片描述

这时，由于d4初始值为null，在使用”+=”操作（Combine方法）构造委托链时，将返回另外一个参数d1，再将d1的引用赋给d4（通过”ILSpy”查看，如下图）。也就是说，这时d4将指向d1所指向的对象。
这里写图片描述

继续执行委托合并，并查看d4的变化

d4 += d2;

这里写图片描述

这时可以看到调用列表的变化，_invocationList包含两个元素，分别是d1和d2.

最后进行一次委托合并，把d3合并到d4中

d4 += d3;

这里写图片描述

可以看到最新的d4实例中，调用列表已经包含了d3。

注意：由于委托是不可变的，所以这里应该描述为，d3和d4的Combine 产生了一个新的委托实例，新的委托实例的调用列表是d3和d4的合并；操作完成后，d4变量将指向新的委托实例的引用。

疑问：其实在这步调试过程中有个疑问，_invocationCount的值是3，但是_invocationList中有四个元素，最后一个为null，找了一下也没发现为什么，望高手看到帮忙解答。

所以对委托链建立的方法Delegate.Combine(Delegate A, Delegate B)，可以进行下面的概括：

如果A和B均为null，则返回null。
如果A或B一个为null而另一个不为null，则返回不为null的委托。
如果A和B均不为null，返回一个新的委托（委托是不可变的），该委托_invocationList字段为一个委托数组，该数组中委托的顺序为：A中_invacationList所指向的委托数组 + B中_invacationList所指向的委托数组。

移除委托链

我们可以通过Delegate类的静态方法Remove，从一个委托链中移除一个委托，这里就不做演示了。

注意：当调用Remove时，会遍历（倒序）第一个参数中的中的调用列表（_invocationList），找到与第二个参数的_target和_methodPtr字段相匹配的委托，并将其从委托列表中移除。

当有多个匹配的情况是，Remove方法只移除第一个匹配的委托；但是，可以通过RemoeAll方法来移除所有匹配的委托。

同样对委托移除的方法Delegate.Remove(Delegate A, Delegate B)，可以进行下面的概括：

如果A为null，返回null。
如果B为null，返回A。
如果A的_invocationList为null，即不包含委托链，那么如果A本身与B匹配，则返回null，否则返回A。
如果A的_invocationList中不包含与B匹配的委托，则返回A。
如果A的_invocationList中包含与B匹配的委托，则从链表中移除B，然后
如果A的链表中只剩下一个委托，则返回该委托。
如果A的链表中还剩下多个委托，将重新构建一个新的委托，并且新的委托的_invocationList为A的_invocationList移除了B之后的List。