“协变”、“逆变”与Delegate类型转换

我在发表了《Delegate如何进行类型转换？》之后又想到了其他一些相关的东西，除了简单地分析如何通过Emit实现EventHandler的类型转换之外，还加上关于Delegate“协变”与“逆变”的一些东西，算是对前一篇文章的完善。

目录
一、从Delegate的“协变”与“逆变”说起
二、EventHandler<TEventArgs>是否换一种定义方式更好？
三、“统一的事件注册”能否应用于一般形式？
四、通过Emit实现EventHandler的类型转换
五、最简单的转换方式

一、从Delegate的“协变”与“逆变”说起

根据Delegate“协变”与“逆变”的原理，对于两个具有相同声明的两个Delegate（A和B），如果B的所有输入（输入参数）类是A的子类或者类型相同，而A的输出（返回值、输出参数）类型是B的子类或者类型相同，那么在B能够使用的地方A也能够使用。我们在定义泛型Delegate的时候可以利用C#“协变”与“逆变”，使类型为A对象能够赋值给类型为B的变量。具体来说，我们需要将输出定义为协变体（通过out关键字），而将输入定义为逆变体（通过in关键字）。比如我们熟悉的Func<T, TResult>的定义：

public delegate TResult Func<in T, out TResult>(T arg);

如下面的代码片断所示，自定义类型Bar是Foo的子类，那么我们就可以将一个Func<Foo, Bar> 对象赋值给Func<Bar, Foo>变量。换言之，Func<Bar, Foo>能够使用的地方，Func<Foo, Bar> 就可以使用。

class Program
{
    static void Main()
    {
        Func<Foo, Bar> getBarByFoo = foo => new Bar();
        Func<Bar, Foo> GetFooByBar = getBarByFoo;
    }
}
class Foo { }
class Bar : Foo { }

二、EventHandler<TEventArgs>是否换一种定义方式更好？

事件（Event）是Delegate一项重要的使用领域，一般情况下事件成员的类型都是EventHandler。如果具有特殊的EventArgs类型，我们倾向于使用泛型的EventHandler<TEventArgs>。EventHandler和EventHandler<TEventArgs>这两个特殊的Delegate类型定义如下，两者是没有任何关系的。

public delegate void EventHandler(object sender, EventArgs e);
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);

根据Delegate“协变”与“逆变”的原理，对于EventHandler<TEventArgs>，其实应该将作为输入参数类型的TEventArgs定义成逆变形式，像下面一样：

public delegate void EventHandler<in TEventArgs>(object sender, TEventArgs e) where TEventArgs: EventArgs;

如果是这样的话，EventHandler<EventArgs>就可以用于处理任意EventHandler<TEventArgs>类型的事件了。假设我们需要注册一个全局的EventHandler，让它在某个对象任何一个事件触发的时候被执行，如果我们能够保证所有的事件类型都是通过协变形式定义的EventHandler<TEventArgs>，我们可以按照如下的方式对目标对象的所有事件进行注册：

public static class EventRegistry<T>
{
    public static void Register(T target, EventHandler<EventArgs> eventHandler)
    {
        foreach (EventInfo eventInfo in typeof(T).GetEvents())
        {
            eventInfo.AddEventHandler(target, eventHandler);
        }
    }
}

假设我们具有如下一个类型Foo，它具有三个事件Bar、Baz和Qux，对应的类型分别是EventHandler<BarEventArgs>、EventHandler<BazEventArgs>和EventHandler<QuxEventArgs>，当方法RaiseEvents执行的时候，被注册的事件被触发。

public class BarEventArgs : EventArgs
{ }
public class BazEventArgs : EventArgs
{ }
public class QuxEventArgs : EventArgs
{ }

public class Foo
{
    public event EventHandler<BarEventArgs> Bar;
    public event EventHandler<BazEventArgs> Baz;
    public event EventHandler<QuxEventArgs> Qux;

    public void RaiseEvents()
    {
        if (null != Bar) Bar(this, new BarEventArgs());
        if (null != Baz) Baz(this, new BazEventArgs());
        if (null != Qux) Qux(this, new QuxEventArgs());
    }
}

比如现在我们需要在Foo对象的任何一个事件触发的时候进行相应的日志记录，我们只需要利用上面定义的EventRegistry<T>对创建的Foo对象进行批量事件注册。

public class Propgram
{
    static void Main()
    {
        Foo foo = new Foo();
        EventRegistry<Foo>.Register(foo, Log);
        foo.RaiseEvents();
    }
    static void Log(object sender, EventArgs e)
    {
        Console.WriteLine("{0}: {1}", sender.GetType().Name, e.GetType().Name);
    }
}

三、“统一的事件注册”能否应用于一般形式？

原则上讲，事件可以是任意类型的Delegate，但是我们使用的事件一般具有如下两个共同点：

• 不具有返回类型，或者返回类型为void；
• 有且只有两个输入参数，其一个参数类型为Object，第二个类型是EventArgs的子类。

如果事件类型对于得Delegate并没有采用逆变方式定义，那么要求我们注册一个与之类型完全一致的Delegate。如果我们需要将一个EventHandler对象注册给某个对象任意类型的事件，我们就不得不将注册的EventHandler转换成具体事件的类型。如下所示的时借助于类型转换的EventRegistry<T>的定义，类型转换通过调用EventHandlerConverter的Convert方法来完成。

public static class EventRegistry<T>
{
    public static void Register(T target, EventHandler eventHandler)
    {
        foreach (EventInfo eventInfo in typeof(T).GetEvents())
        {
            eventInfo.AddEventHandler(target, EventHandlerConverter.Convert(eventHandler, eventInfo.EventHandlerType));
        }
    }
}

那么现在我们将Foo类型的三个事件类型定义成普通的Delegage：BarEventHandler、BazEventHandler和QuxEventHandler，实际上我们上面的代码依然可以执行。

public delegate void BarEventHandler(object sender, BarEventArgs e);
public delegate void BazEventHandler(object sender, BazEventArgs e);
public delegate void QuxEventHandler(object sender, QuxEventArgs e);

public class Foo
{
    public event BarEventHandler Bar;
    public event BazEventHandler Baz;
    public event QuxEventHandler Qux;
}

四、通过Emit实现EventHandler的类型转换

我们通过Emit的形式实现了这个类型转换。如下面的代码片断所示，实现在EventHandlerConverter的静态方法Convert方法中的EventHandler与兼容Delegate类型之间的转换是通过“Emit”的机制实现，具体的实现逻辑如下面的代码片断所示。IsValidEventHandler方法用于验证指定的类型是否与EventHandler兼容（按照上面提及的标准进行验证），在Convert方法中我们通过Emit的方式创建了一个DynamicMethod 对象，并最终调用CreateDelegate方法将指定的Delegate对象转换成目标Delegate类型。泛型方法Convert<TDelegate>以强类型的方式指定转换的目标类型。

public static class EventHandlerConverter
{
    public static bool IsValidEventHandler(Type eventHandlerType, out ParameterInfo[] parameters)
    {
        Guard.ArgumentNotNull(eventHandlerType, "eventHandlerType");
        if (!typeof(Delegate).IsAssignableFrom(eventHandlerType))
        {
            parameters = new ParameterInfo[0];
            return false;
        }

        MethodInfo invokeMethod = eventHandlerType.GetMethod("Invoke");
        if (invokeMethod.ReturnType != typeof(void))
        {
            parameters = new ParameterInfo[0];
            return false;
        }
        parameters = invokeMethod.GetParameters();
        if (parameters.Length != 2 || parameters[0].ParameterType != typeof(object))
        {
            return false;
        }
        if (!typeof(EventArgs).IsAssignableFrom(parameters[1].ParameterType))
        {
            return false;
        }
        return true;
    }

    public static Delegate Convert(Delegate eventHandler, Type eventHandlerType)
    {
        Guard.ArgumentNotNull(eventHandler, "eventHandler");
        Guard.ArgumentNotNull(eventHandlerType, "eventHandlerType");

        ParameterInfo[] destinationParameters;
        if (!IsValidEventHandler(eventHandlerType, out destinationParameters))
        {
            throw new InvalidOperationException();
        }

        if (eventHandler.GetType() == eventHandlerType)
        {
            return eventHandler;
        }

        ParameterInfo[] sourceParameters;
        if (!IsValidEventHandler(eventHandler.GetType(), out sourceParameters))
        {
            throw new InvalidOperationException();
        }
        Type[] paramTypes = new Type[destinationParameters.Length + 1];
        paramTypes[0] = eventHandler.GetType();
        for (int i = 0; i < destinationParameters.Length; i++)
        {
            paramTypes[i + 1] = destinationParameters[i].ParameterType;
        }
        DynamicMethod method = new DynamicMethod("WrappedEventHandler", null, paramTypes);
        MethodInfo invoker = paramTypes[0].GetMethod("Invoke");
        ILGenerator il = method.GetILGenerator();
        il.Emit(OpCodes.Ldarg_0);
        il.Emit(OpCodes.Ldarg_1);
        il.Emit(OpCodes.Ldarg_2);
        if (!sourceParameters[1].ParameterType.IsAssignableFrom(destinationParameters[1].ParameterType))
        {
            il.Emit(OpCodes.Castclass, sourceParameters[1].ParameterType);
        }
        il.Emit(OpCodes.Call, invoker);
        il.Emit(OpCodes.Ret);
        return method.CreateDelegate(eventHandlerType, eventHandler);
    }

    public static TDelegate Convert<TDelegate>(Delegate eventHandler)
    {
        return (TDelegate)(object)Convert(eventHandler, typeof(TDelegate));
    }
}

五、最简单的转换方式

其实较之上面介绍的Emit的方式，还有一种最简单的方式，那就是按照如下的代码所示：直接调用Delegate的静态方法CreateDelegate：

public static class EventHandlerConverter
{
    public static Delegate Convert(Delegate eventHandler, Type eventHandlerType)
    {
        Guard.ArgumentNotNull(eventHandler, "eventHandler");
        Guard.ArgumentNotNull(eventHandlerType, "eventHandlerType");
        return Delegate.CreateDelegate(eventHandlerType, eventHandler.Method);
    }

    public static TDelegate Convert<TDelegate>(Delegate eventHandler)
    {
        return (TDelegate)(object)Convert(eventHandler, typeof(TDelegate));
    }
}