一、背景
C#的事件机制一种监听器机制语法类似:
public void AddEvent() { myButton.Click += new EventHandler(MyMethod); } public void MyMethod() { //do something }
这种写法是在编译期指定事件的处理逻辑,而有时候,情况往往比我们想象中复杂,比如:通过配置指定某Form界面的Button点击事件在不同的情况下,有不同的逻辑,当然我们可以写If语句,但用户的需求变化会让IF越来越多,代码越来越难维护。从产品化的角度,我们要兼容各种情况,而又不希望过多修改原有代码。这都意味着,我们需要一种通过配置实现动态事件的机制。
二、分析
通过分析,我们可以了解到动态事件需要实现以下两项特性:
- 委托工厂(Delegate Factory):读取配置的事件、引用类、引用类方法名,实例化出事件;
- 动态添加事件:通过反射,从事件工厂中取出事件设置到事件(Event)中;
委托工厂的实现难点只在委托的实例化,微软对委托的定义:“委托是一种数据结构,它引用静态方法或引用类实例及该类的实例方法。”,其仅仅是一种数据结构,而且非常特殊,仅仅依赖普通的反射,无法做到实例化,因为委托的实例化往往需要一个方法实例,而方法实例无法在Activator.CreateInstance时作为参数传入。可幸的是,CSharp本身对动态委托是有支持的,主要是使用Delegate.CreateDelegate(Type type, object arget, string methodName)方法,其实这个方法,就是委托工厂的实现,只不过我们需要加入一些配置功能,代码示例如下:
public class DelegatFactory { private Dictionary<string, DelegateConfig> _Configs; private bool _ConfigRead; public Delegate CreateDelegate(string configIdentity) { DelegateConfig config = GetDelegateConfig(configIdentity); string delegateName = config.DelegateName; object delegateTarget = CreateDelegateRefObj(config); string methodName = config.MethodName; return Delegate.CreateDelegate(Type.GetType(delegateName), delegateTarget, methodName); } private void ReadConfigFromDb() { //if (!_ConfigRead) 从数据库读取配置 } private DelegateConfig GetDelegateConfig(string configIdentity) { //ReadConfigFormDb(); 从数据库读取配置 } private object CreateDelegateRefObj(DelegateConfig config) { //反射生成引用类 } }
动态添加事件就比较简单了,使用反射可以很轻松做到这一点,示例代码如下:
public void AddEvent(object eventHolder, string eventName, Delegate delegate) { Type type = eventHolder.GetType(); EventInfo eventInfo = type.GetEvent(eventName); eventInfo.AddEventHandler(eventHolder, delegate); }
三、遗留问题
有几个问题在使用这种机制时需要注意的:
- 方法的定义必须与对应的委托定义一致,参数数目、类型一致;
- 配置时的类型检查或者运行时的检查在示例代码中没有体现,在实际项目应用中应当小心处理;
- 动态处理只是用于需求变化比较频繁的情景,实际代码中,可固化的内容应当固化在代码中;