实现.net下的动态代理

 

实现.net下的动态代理

一、动态代理可以解决哪些问题

 

本文描述的动态代理可以解决以下问题：

 

问题1：接口约束问题

 

场景A：ComboBox类与ToolStripComboBox类的行为大部分相似，它们却不共享某个粒度较大的接口，以至于对这两个类的操作代码难以公用。

 

场景B：在泛型程序中，我们必需为泛型类型声明一个接口约束，才能使用该类型所对应接口约束的方法与属性。这样以来有一个问题：存在接口A，类型B，A中的所有属性和方法签名B都有，但B不是A的实现，不能由B转换为A。而由于某些原因，我们无法获得B的代码或者虽然能够获得B的代码，却由于种种考虑不能更改B的代码；

大多数情况下，可以新写一个类C，使类C继承自B，再让C实现接口A。然而，其一，代码量较大；其二，当B为Sealed时不能继承；其三：不方便使用继承（如：继承后，IDE中的设计器无法给新类提供支持）。

 

此时，我们希望动态代理能解决这个问题：

 

假定我们有一个接口：

 

    public interface TInterface
    {
        String A { get; }
        String B(Object a, Object b, Object c, Object d, Object e);
    }

 

有一个类：

 

 1    public class ClassA
 2    {
 3        public String A 
 4        {
 5            get
 6            {
 7                return String.Empty;
 8            }
 9        }

        public String B(Object a, Object b, Object c, Object d, Object e)
        {
            return String.Empty;
        }
    }

 

我们需要这个动态代理类（假定为 TypeTemplate）提供一个方法，能够方便的生成一个代理类实例，将ClassA的实例包装一下，转变为 TInterface 的实例：

 

        public static TInterface Create<TInterface, TImple>(TImple instance) 
            where TInterface : class
            where TImple : class
        {
            ……
        }

 

该方法生成一个实现TInterface的动态类的实例。对于TInterface中的每一个属性或方法，该实例直接调用instance实例中具有同样签名的属性或方法，如果没有匹配的属性或方法，则抛出NotImplementedException异常。

 

问题2：快速生成现有实例类的Wrapper

 

场景C：假定接口TInterface有10个方法，类TImple中有9个方法与TInterface对应，为了实现TInterface，需要新写一个Wrapper类。最方便的写法是令Wrapper继承自TImple且实现接口TInterface，Wrapper只需新添实现那个未实现的方法即可。然而，如前面所述，很多情况下使用继承不是最佳选择。不用继承的话，则需要Wrapper类实现TInterface的全部10个方法，枯燥又乏味。

 

此时，我们期待存在这样一种动态代理：它能够将几个实例B，C，D一起打包，使它适合接口A。这样一来，针对场景C，我们只需要写一个简单的Wrapper类，实现那个未实现的方法，然后与TImple实例一起由动态代理工厂打包生成一个新的代理类实例即可。

 

即：我们需要动态代理工厂TypeTemplate能够提供以下方法：

 

        public static TInterface Create<TInterface>(TInterface instance, params Object[] impleInstances)
            where TInterface : class
        {
            …
        }

 

该方法生成一个实现TInterface的类实例。对于TInterface中的每一个属性或方法，该实例依次从impleInstances中寻找具有同样签名的属性或方法，如果没有匹配的属性或方法，则抛出NotImplementedException异常。

 

问题3：AOP应用

 

场景D：当需要对方法进行拦截时我们需要动态代理。

 

AOP是动态代理最经典的应用，无需赘述。

 

这种情况下，我们需要 TypeTemplate 类提供以下的方法向代理类中加入钩子：

 

        public delegate void Handler<TImple>(TImple imple) where TImple: class;

        public static TInterface CreateIntercepted<TInterface, TImple>(TImple instance, Handler<TImple> before, Handler<TImple> after)
            where TInterface : class
            where TImple : class
        {
            …
        }

 

二、实现

 

 

下面来实现动态代理类工厂TypeTemplate。由于时间有限，只实现 static TInterface Create<TInterface, TImple>(TImple instance) 方法原型。其它几个静态方法可以用类似的方式实现。

 

实现思路：

 

对于问题1中的接口TInterface和类ClassA，通过Emit生成如下类型InterfaceImple_ClassA的IL代码。

 

 

 1    public class InterfaceImple_ClassA : TInterface
 2    {
 3        private ClassA __wrappedInstance;
 4
 5        public InterfaceImple_ClassA(ClassA instance)
 6        {
 7            __wrappedInstance = instance;
 8        }
 9
        public String A
        {
            get { return __wrappedInstance.A; }
            set { throw new NotImplementedException(); }
        }

        public String B(Object a, Object b, Object c, Object d, Object e)
        {
            return __wrappedInstance.B(a,b,c,d,e);
        }
    }

 

假定生成上面这个类型的方法为:

 

        public static Type DynamicTypeGen<TInterface, TImple>()
            where TInterface: class where TImple : class

 

则可用Activator轻松生成动态代理类实例：

 

        public static TInterface Create<TInterface, TImple>(TImple instance) 
            where TInterface : class
            where TImple : class
        {
            Type type = DynamicTypeGen<TInterface, TImple>();
            return Activator.CreateInstance(type, instance) as TInterface;
        }

 

下面是具体代码：

 

 

  1using System;
  2using System.Collections.Generic;
  3using System.Text;
  4using System.Reflection;
  5using System.Reflection.Emit;
  6
  7namespace Orc.Generics
  8{
  9    public sealed class TypeTemplate
 10    {
 11        public delegate void Handler<TImple>(TImple imple) where TImple: class;
 12
 13        public static TInterface Create<TInterface, TImple>(TImple instance) 
 14            where TInterface : class
 15            where TImple : class
 16        {
 17            Type type = DynamicTypeGen<TInterface, TImple>();
 18            return Activator.CreateInstance(type, instance) as TInterface;
 19        }
 20
 21        public static TInterface Create<TInterface>(TInterface instance, params Object[] impleInstances)
 22            where TInterface : class
 23        {
 24            throw new NotImplementedException();
 25        }
 26
 27        public static TInterface CreateIntercepted<TInterface, TImple>(TImple instance, Handler<TImple> before, Handler<TImple> after)
 28            where TInterface : class
 29            where TImple : class
 30        {
 31            throw new NotImplementedException();
 32        }
 33
 34        public static Type DynamicTypeGen<TInterface, TImple>()
 35            where TInterface: class where TImple : class
 36        {
 37            Type tInterface = typeof(TInterface);
 38            Type tImple = typeof(TImple);
 39
 40            PropertyInfo[] pisInterface = tInterface.GetProperties(BindingFlags.Public | BindingFlags.Instance);
 41            MethodInfo[] misInterface = tInterface.GetMethods(BindingFlags.Public | BindingFlags.Instance);
 42            List<MethodInfo> misInterfaceList = new List<MethodInfo>();
 43            foreach (var item in misInterface)
 44            {
 45                if (item.IsSpecialName == false) misInterfaceList.Add(item);
 46            }
 47
 48            MethodInfo[] misImple = tImple.GetMethods(BindingFlags.Public | BindingFlags.Instance);
 49            AssemblyName aName = new AssemblyName("Orc.Generics.DynamicTypes");
 50            AssemblyBuilder ab =
 51                AppDomain.CurrentDomain.DefineDynamicAssembly(
 52                    aName,
 53                    AssemblyBuilderAccess.RunAndSave);
 54            ModuleBuilder mb =
 55                ab.DefineDynamicModule(aName.Name, aName.Name + ".dll");
 56            TypeBuilder tb = mb.DefineType(GetDynamicTypeName<TInterface, TImple>(),
 57                TypeAttributes.Public, null, new Type[] { tInterface });
 58            FieldBuilder fbInstance = tb.DefineField(
 59                "__wrappedInstance",
 60                tImple,
 61                FieldAttributes.Private);
 62
 63            ConstructorBuilder ctor1 = tb.DefineConstructor(
 64                MethodAttributes.Public,
 65                CallingConventions.Standard,
 66                new Type[] {tImple});
 67
 68            ILGenerator ctor1IL = ctor1.GetILGenerator();
 69            ctor1IL.Emit(OpCodes.Ldarg_0);
 70            ctor1IL.Emit(OpCodes.Call,
 71                typeof(object).GetConstructor(Type.EmptyTypes));
 72            ctor1IL.Emit(OpCodes.Ldarg_0);
 73            ctor1IL.Emit(OpCodes.Ldarg_1);
 74            ctor1IL.Emit(OpCodes.Stfld, fbInstance);
 75            ctor1IL.Emit(OpCodes.Ret);
 76
 77            foreach (var item in pisInterface)
 78            {
 79                MethodInfo getMi = FindGetMethodInfo(misImple, item);
 80                MethodInfo setMi = FindSetMethodInfo(misImple, item);
 81                CreateProperty(tb, fbInstance, item, getMi, setMi);
 82            }
 83
 84            foreach (var item in misInterfaceList)
 85            {
 86                MethodInfo instanceMi = FindMethodInfo(misImple, item);
 87                CreateMethod(tb, fbInstance, item, instanceMi);
 88            }
 89            
 90            return tb.CreateType();
 91        }
 92
 93        private static MethodInfo FindGetMethodInfo(MethodInfo[] miList, PropertyInfo pi)
 94        {
 95            foreach (var item in miList)
 96            {
 97                if (item.Name.Equals("get_" + pi.Name) && item.IsSpecialName) return item;
 98            }
 99
            return null;
        }

        private static MethodInfo FindSetMethodInfo(MethodInfo[] miList, PropertyInfo pi)
        {
            foreach (var item in miList)
            {
                if (item.Name.Equals("set_" + pi.Name) && item.IsSpecialName) return item;
            }
            
            return null;
        }

        private static MethodInfo FindMethodInfo(MethodInfo[] miList, MethodInfo mi)
        {
            foreach (var item in miList)
            {
                if (MethodInfoEqual(item,mi)) return item;
            }

            return null;
        }

        private static Boolean MethodInfoEqual(MethodInfo mi1, MethodInfo mi2)
        {
            if (mi1.IsSpecialName == true || mi2.IsSpecialName == true) return false;
            if (mi1.Name != mi2.Name) return false;
            if (mi1.ReturnType != mi2.ReturnType) return false;
            ParameterInfo[] pis1 = mi1.GetParameters();
            ParameterInfo[] pis2 = mi2.GetParameters();
            if (pis1.Length != pis2.Length) return false;
            for (int i = 0; i < pis1.Length; i++)
            {
                ParameterInfo pi1 = pis1[i];
                ParameterInfo pi2 = pis2[i];
                if (pi1.ParameterType != pi2.ParameterType) return false;
            }
            return true;
        }

        private static void CreateProperty(TypeBuilder tb, FieldBuilder fbInstance, PropertyInfo pi, MethodInfo getMi, MethodInfo setMi)
        {
            String name = pi.Name;
            Type type = pi.PropertyType;

            PropertyBuilder pb = tb.DefineProperty(
                name,
                PropertyAttributes.HasDefault,
                type,
                null);

            MethodAttributes getSetAttr = MethodAttributes.Public |
                MethodAttributes.SpecialName | MethodAttributes.HideBySig | MethodAttributes.NewSlot | MethodAttributes.Virtual | MethodAttributes.Final ;
            MethodBuilder mbGetAccessor = tb.DefineMethod(
                "get_" + name,
                getSetAttr,
                type,
                Type.EmptyTypes);

            ILGenerator getIL = mbGetAccessor.GetILGenerator();
            if (getMi == null)
            {
                getIL.Emit(OpCodes.Newobj, typeof(NotImplementedException).GetConstructor(new Type[]{}));
                getIL.Emit(OpCodes.Throw);
            }
            else
            {
                getIL.Emit(OpCodes.Ldarg_0);
                getIL.Emit(OpCodes.Ldfld, fbInstance);
                getIL.Emit(OpCodes.Callvirt, getMi);
                getIL.Emit(OpCodes.Ret);
            }

            MethodBuilder mbSetAccessor = tb.DefineMethod(
                "set_"+ name,
                getSetAttr,
                null,
                new Type[] { type });

            ILGenerator setIL = mbSetAccessor.GetILGenerator();
            if (setMi == null)
            {
                setIL.Emit(OpCodes.Newobj, typeof(NotImplementedException).GetConstructor(new Type[] { }));
                setIL.Emit(OpCodes.Throw);
            }
            else
            {
                setIL.Emit(OpCodes.Ldarg_0);
                setIL.Emit(OpCodes.Ldfld, fbInstance);
                setIL.Emit(OpCodes.Ldarg_1);
                setIL.Emit(OpCodes.Callvirt, setMi);
                setIL.Emit(OpCodes.Ret);
            }

            pb.SetGetMethod(mbGetAccessor);
            pb.SetSetMethod(mbSetAccessor);
        }

        private static void CreateMethod(TypeBuilder tb, FieldBuilder fbInstance, MethodInfo mi, MethodInfo instanceMi)
        {
            List<Type> paramTyleList = new List<Type>();
            foreach(var item in mi.GetParameters())
                paramTyleList.Add(item.ParameterType);

            MethodBuilder mb = tb.DefineMethod(
              mi.Name,
              MethodAttributes.Public | MethodAttributes.HideBySig | MethodAttributes.NewSlot | MethodAttributes.Virtual | MethodAttributes.Final,
              mi.ReturnType,
              paramTyleList.ToArray());

            ILGenerator il = mb.GetILGenerator();
            if (instanceMi == null)
            {
                il.Emit(OpCodes.Newobj, typeof(NotImplementedException).GetConstructor(new Type[] { }));
                il.Emit(OpCodes.Throw);
            }
            else
            {
                il.Emit(OpCodes.Ldarg_0);
                il.Emit(OpCodes.Ldfld, fbInstance);
                switch (paramTyleList.Count)
                {
                    case 0:
                        break;
                    case 1:
                        il.Emit(OpCodes.Ldarg_1);
                        break;
                    case 2:
                        il.Emit(OpCodes.Ldarg_1);
                        il.Emit(OpCodes.Ldarg_2);
                        break;
                    case 3:
                        il.Emit(OpCodes.Ldarg_1);
                        il.Emit(OpCodes.Ldarg_2);
                        il.Emit(OpCodes.Ldarg_3);
                        break;
                    default:
                        il.Emit(OpCodes.Ldarg_1);
                        il.Emit(OpCodes.Ldarg_2);
                        il.Emit(OpCodes.Ldarg_3);

                        Int32 sCount = Math.Min(paramTyleList.Count, 127);
                        for (int i = 4; i <= sCount; i++)
                        {
                            il.Emit(OpCodes.Ldarg_S, i);
                        }

                        for (int i = 128; i <= paramTyleList.Count; i++)
                        {
                            il.Emit(OpCodes.Ldarg, i);
                        }

                        break;
                }

                il.Emit(OpCodes.Callvirt, instanceMi);
                il.Emit(OpCodes.Ret);
            }
        }

        private static String GetDynamicTypeName<TInterface, TImple>()
            where TInterface : class
            where TImple : class
        {
            return "_DynamicTypes" + typeof(TInterface).ToString() + "_" + typeof(TImple);
        }
    }

    public interface TInterface
    {
        String A { get; }
        String B(int a, int b);
    }

    public class ClassA
    {
        public String A 
        {
            get
            {
                return String.Empty;
            }
        }

        public String B(int a, int b)
        {
            return (a+b).ToString();
        }
    }

    public class InterfaceImple_ClassA : TInterface
    {
        private ClassA __wrappedInstance;

        public InterfaceImple_ClassA(ClassA instance)
        {
            __wrappedInstance = instance;
        }

        public String A
        {
            get { return __wrappedInstance.A; }
            set { throw new NotImplementedException(); }
        }

        public String B(int a, int b)
        {
            return __wrappedInstance.B(a,b);
        }
    }

    public class InterfaceImple_ClassA_Factory
    {
        public readonly String Name = "InterfaceImple_ClassA_Factory";
        public InterfaceImple_ClassA Create(ClassA a)
        {
            return new InterfaceImple_ClassA(a);
        }
    }
}

 

单元测试代码：

 

 1        [TestMethod]
 2        public void TestCreate()
 3        {
 4            ClassA a = new ClassA();
 5            TInterface i = TypeTemplate.Create<TInterface, ClassA>(a);
 6            Assert.AreNotEqual(null, i);
 7            Assert.AreEqual(String.Empty, i.A);
 8            Assert.AreEqual("3", i.B(1, 2));
 9        }

 

 

三、说明

 

1         上文只是 TypeTemplate的原型实现，我只进行了简单的单元测试，没有针对全部可能遇见的情况进行测试；在功能上，未生成event的动态代理；

2         static TInterface Create<TInterface>(TInterface instance, params Object[] impleInstances) 这个方法生成的代理类最好继承一个特殊接口，通过该接口能够接入被代理的实例；

3         如果第一部分所述的三个静态方法全部实现了的话，将是一个非常强大的代理工厂；

4         代理类实例的性能接近于直接调用相关方法或属性的性能，性能极佳；

5         代理类实例的生成是通过反射生成的，在性能上有很大的提升空间。可以通过emit动态生成一个工厂类。如，针对上面的ClassA，生成如下工厂类：

 

    public class InterfaceImple_ClassA_Factory
    {
        public readonly String Name = "InterfaceImple_ClassA_Factory";
        public InterfaceImple_ClassA Create(ClassA a)
        {
            return new InterfaceImple_ClassA(a);
        }
    }

 

         然后通过反射生成以上工厂类的实例，缓存住。当需要生成新的动态代理实例时，从缓存中查找对应的工厂，生成具体的代理类。