C#使用Activator.CreateInstance

Question

昨天我问了一个关于使用反射或策略模式动态调用方法的问题.

但是,从那时起,我决定将方法更改为实现公共接口的各个类.原因是,每个类虽然具有一些相似之处,但也执行该类所特有的某些方法.

我一直在使用这样的策略:

switch (method)
{
    case "Pivot":
        return new Pivot(originalData);
    case "GroupBy":
        return new GroupBy(originalData);
    case "Standard deviation":
        return new StandardDeviation(originalData);
    case "% phospho PRAS Protein":
        return new PhosphoPRASPercentage(originalData);
    case "AveragePPPperTreatment":
        return new AveragePPPperTreatment(originalData);
    case "AvgPPPNControl":
        return new AvgPPPNControl(originalData);
    case "PercentageInhibition":
        return new PercentageInhibition(originalData);
    default:
        throw new Exception("ERROR: Method " + method + " does not exist.");
}

但是,随着潜在类数量的增加,我将需要不断添加新类,从而打破关闭修改规则.

相反,我使用了一个解决方案:

var test = Activator.CreateInstance(null, "MBDDXDataViews."+ _class);
       ICalculation instance = (ICalculation)test.Unwrap();
       return instance;

实际上,_class参数是在运行时传入的类的名称.这是一种常见的方法,这会有任何性能问题吗？

我很反思,所以欢迎你提出建议.

Answer 1

使用反射时,您首先应该问自己几个问题,因为您最终可能会遇到难以维护的过度复杂的解决方案:

1. 有没有办法使用泛型或类/接口继承来解决问题？
2. 我可以使用dynamic调用(仅限.NET 4.0及更高版本)解决问题吗？
3. 性能是否重要,即我的反射方法或实例化调用是否会被调用一次,两次或一百万次？
4. 我可以结合技术来获得智能但可行/可理解的解决方案吗？
5. 我没有丢失编译时类型安全吗？

通用/动态

根据您的描述,我假设您在编译时不知道类型,您只知道它们共享接口ICalculation.如果这是正确的,那么您的方案中可能无法使用上面的数字(1)和(2).

性能

这是一个要问的重要问题.使用反射的开销可能会导致超过400倍的惩罚:即使是适量的呼叫也会减慢速度.

分辨率相对简单:Activator.CreateInstance使用工厂方法(您已经拥有),查找MethodInfo创建委托,缓存它并从此使用委托,而不是使用它.这在第一次调用时仅产生一个惩罚,后续调用具有接近本机的性能.

结合技术

这里有很多可能,但我真的需要了解更多你的情况以协助这个方向.通常,我最终会dynamic与泛型相结合,并使用缓存反射.当使用信息隐藏(如在OOP正常),你可以用一个快速,稳定,仍然良好扩展的解决方案告终.

丢失编译时类型安全

在这五个问题中,这可能是最重要的一个问题.创建自己的异常非常重要,可以提供有关反射错误的明确信息.这意味着:基于输入字符串或其他未经检查的信息对方法,构造函数或属性的每次调用都必须包装在try/catch中.只抓住特定的例外(一如既往,我的意思是:永远不会抓住Exception自己).

专注于TargetException(方法不存在),TargetInvocationException(方法存在,但在调用时上升为exc.)TargetParameterCountException,MethodAccessException(不是正确的权限,在ASP.NET中发生了很多),InvalidOperationException(发生在泛型类型中).您并不总是需要尝试捕获所有这些,这取决于预期的输入和预期的目标对象.

把它们加起来

摆脱你的Activator.CreateInstance并使用MethodInfo来找到factory-create方法,并用于Delegate.CreateDelegate创建和缓存委托.只需将其存储在静态中Dictionary,其中键等于示例代码中的类字符串.下面是一种快速但不那么脏的方法,可以安全地进行此操作,而不会丢失太多的类型安全性.

示例代码

public class TestDynamicFactory
{
    // static storage
    private static Dictionary<string, Func<ICalculate>> InstanceCreateCache = new Dictionary<string, Func<ICalculate>>();

    // how to invoke it
    static int Main()
    {
        // invoke it, this is lightning fast and the first-time cache will be arranged
        // also, no need to give the full method anymore, just the classname, as we
        // use an interface for the rest. Almost full type safety!
        ICalculate instanceOfCalculator = this.CreateCachableICalculate("RandomNumber");
        int result = instanceOfCalculator.ExecuteCalculation();
    }

    // searches for the class, initiates it (calls factory method) and returns the instance
    // TODO: add a lot of error handling!
    ICalculate CreateCachableICalculate(string className)
    {
        if(!InstanceCreateCache.ContainsKey(className))
        {
            // get the type (several ways exist, this is an eays one)
            Type type = TypeDelegator.GetType("TestDynamicFactory." + className);

            // NOTE: this can be tempting, but do NOT use the following, because you cannot 
            // create a delegate from a ctor and will loose many performance benefits
            //ConstructorInfo constructorInfo = type.GetConstructor(Type.EmptyTypes);

            // works with public instance/static methods
            MethodInfo mi = type.GetMethod("Create");

            // the "magic", turn it into a delegate
            var createInstanceDelegate = (Func<ICalculate>) Delegate.CreateDelegate(typeof (Func<ICalculate>), mi);

            // store for future reference
            InstanceCreateCache.Add(className, createInstanceDelegate);
        }

        return InstanceCreateCache[className].Invoke();

    }
}

// example of your ICalculate interface
public interface ICalculate
{
    void Initialize();
    int ExecuteCalculation();
}

// example of an ICalculate class
public class RandomNumber : ICalculate
{
    private static Random  _random;

    public static RandomNumber Create()
    {
        var random = new RandomNumber();
        random.Initialize();
        return random;
    }

    public void Initialize()
    {
        _random = new Random(DateTime.Now.Millisecond);
    }

    public int ExecuteCalculation()
    {
        return _random.Next();
    }
}

Answer 2

我建议你给工厂实现一个方法RegisterImplementation.因此,每个新类只是对该方法的调用,而您不会更改工厂代码.

更新:
我的意思是这样的:

创建定义计算的接口.根据你的代码,你已经这样做了.为了完整起见,我将在其余的答案中使用以下界面:

public interface ICalculation
{
    void Initialize(string originalData);
    void DoWork();
}

你的工厂看起来像这样:

public class CalculationFactory
{
    private readonly Dictionary<string, Func<string, ICalculation>> _calculations = 
                        new Dictionary<string, Func<string, ICalculation>>();

    public void RegisterCalculation<T>(string method)
        where T : ICalculation, new()
    {
        _calculations.Add(method, originalData =>
                                  {
                                      var calculation = new T();
                                      calculation.Initialize(originalData);
                                      return calculation;
                                  });
    }

    public ICalculation CreateInstance(string method, string originalData)
    {
        return _calculations[method](originalData);
    }
}

出于简单的原因,这个简单的工厂类缺少错误检查.

更新2:
您可以在应用程序初始化例程中的某处初始化它:

CalculationFactory _factory = new CalculationFactory();

public void RegisterCalculations()
{
    _factory.RegisterCalculation<Pivot>("Pivot");
    _factory.RegisterCalculation<GroupBy>("GroupBy");
    _factory.RegisterCalculation<StandardDeviation>("Standard deviation");
    _factory.RegisterCalculation<PhosphoPRASPercentage>("% phospho PRAS Protein");
    _factory.RegisterCalculation<AveragePPPperTreatment>("AveragePPPperTreatment");
    _factory.RegisterCalculation<AvgPPPNControl>("AvgPPPNControl");
    _factory.RegisterCalculation<PercentageInhibition>("PercentageInhibition");
}

Answer 3

仅作为示例如何在构造函数中添加初始化:

类似的东西:

Activator.CreateInstance(Type.GetType("ConsoleApplication1.Operation1"), initializationData);

但是用Linq Expression编写,部分代码在这里:

public class Operation1 
{
    public Operation1(object data)
    { 
    }
}

public class Operation2 
{
    public Operation2(object data)
    {
    }
}

public class ActivatorsStorage
{
    public delegate object ObjectActivator(params object[] args);

    private readonly Dictionary<string, ObjectActivator> activators = new Dictionary<string,ObjectActivator>();

    private ObjectActivator CreateActivator(ConstructorInfo ctor)
    {
        Type type = ctor.DeclaringType;

        ParameterInfo[] paramsInfo = ctor.GetParameters();
        ParameterExpression param = Expression.Parameter(typeof(object[]), "args");

        Expression[] argsExp = new Expression[paramsInfo.Length];

        for (int i = 0; i < paramsInfo.Length; i++)
        {
            Expression index = Expression.Constant(i);
            Type paramType = paramsInfo[i].ParameterType;

            Expression paramAccessorExp = Expression.ArrayIndex(param, index);

            Expression paramCastExp = Expression.Convert(paramAccessorExp, paramType);

            argsExp[i] = paramCastExp;
        }

        NewExpression newExp = Expression.New(ctor, argsExp);

        LambdaExpression lambda = Expression.Lambda(typeof(ObjectActivator), newExp, param);

        return (ObjectActivator)lambda.Compile();
    }

    private ObjectActivator CreateActivator(string className)
    {
        Type type = Type.GetType(className);
        if (type == null)
            throw new ArgumentException("Incorrect class name", "className");

        // Get contructor with one parameter
        ConstructorInfo ctor = type.GetConstructors()
            .SingleOrDefault(w => w.GetParameters().Length == 1 
                && w.GetParameters()[0].ParameterType == typeof(object));

        if (ctor == null)
                throw new Exception("There is no any constructor with 1 object parameter.");

        return CreateActivator(ctor);
    }

    public ObjectActivator GetActivator(string className)
    {
        ObjectActivator activator;

        if (activators.TryGetValue(className, out activator))
        {
            return activator;
        }
        activator = CreateActivator(className);
        activators[className] = activator;
        return activator;
    }
}

用法如下:

ActivatorsStorage ast = new ActivatorsStorage();
var a = ast.GetActivator("ConsoleApplication1.Operation1")(initializationData);
var b = ast.GetActivator("ConsoleApplication1.Operation2")(initializationData);

DynamicMethods也可以实现相同的功能.

此外,不需要从同一接口或基类继承类.

谢谢,Vitaliy

Answer 4

我在这种情况下使用的一种策略是使用特殊属性标记我的各种实现以指示其键,并使用该键扫描活动程序集中的类型:

[AttributeUsage(AttributeTargets.Class)]
public class OperationAttribute : System.Attribute
{ 
    public OperationAttribute(string opKey)
    {
        _opKey = opKey;
    }

    private string _opKey;
    public string OpKey {get {return _opKey;}}
}

[Operation("Standard deviation")]
public class StandardDeviation : IOperation
{
    public void Initialize(object originalData)
    {
        //...
    }
}

public interface IOperation
{
    void Initialize(object originalData);
}

public class OperationFactory
{
    static OperationFactory()
    {
        _opTypesByKey = 
            (from a in AppDomain.CurrentDomain.GetAssemblies()
             from t in a.GetTypes()
             let att = t.GetCustomAttributes(typeof(OperationAttribute), false).FirstOrDefault()
             where att != null
             select new { ((OperationAttribute)att).OpKey, t})
             .ToDictionary(e => e.OpKey, e => e.t);
    }
    private static IDictionary<string, Type> _opTypesByKey;
    public IOperation GetOperation(string opKey, object originalData)
    {
        var op = (IOperation)Activator.CreateInstance(_opTypesByKey[opKey]);
        op.Initialize(originalData);
        return op;
    }
}

这样,只需创建一个带有新密钥字符串的新类,就可以自动"插入"工厂,而无需修改工厂代码.

您还会注意到,我不是依赖于每个实现来提供特定的构造函数,而是在接口上创建了一个我希望类实现的Initialize方法.只要他们实现了界面,我就能够将"originalData"发送给他们,而不会产生任何反射怪异.

我还建议使用像Ninject这样的依赖注入框架,而不是使用Activator.CreateInstance.这样,您的操作实现可以使用构造函数注入它们的各种依赖项.