通过反射或类似方式动态生成属性getter / setter

时间:2012-04-04 20:12:51

标签: c# reflection metaprogramming

想象一下以下课程:

public class Settings
{
    [FileBackedProperty("foo.txt")]
    public string Foo { get; set; }
}

我希望能够写出类似于上面的内容,并从文件“foo.txt”中读取settings.Foo,并将settings.Foo = "bar"写入“foo.txt”。

显然这是一个简化的例子,我不会在生产应用程序中执行上述操作,但还有其他示例,例如,如果我希望Foo存储在ASP.net会话状态“foo”中,但我厌倦了一遍又一遍地编写以下代码:

public int Foo
{
    get
    {
        if (Session["foo"] != null)
            return Convert.ToInt32(Session["foo"]);
        else
            // Throw an exception or return a default value
    }
    set
    {
        Session["foo"] = value;
    }
}

(再一次这个例子是简化的,我不会写上面的代码,实际上我在撒谎,我有上面的代码并正在努力重构它,因此这个问题)

上述示例很好,除非您有50个不同的会话值都具有相似的逻辑。那么我有可能将第二个属性转换为类似于第一个属性的东西吗? (使用属性和反射,或者其他一些方法?)

6 个答案:

答案 0 :(得分:6)

我知道这不是你(也是我)所需要的;但这是最接近不使用第三方库的。您可以更改get& set方法的逻辑并为GetProperty和GetCustomAttributes方法添加一些cahcing,或者如果您已经有一个基类,则可以在辅助类中将get& set方法写为static。再次不是完美的答案,也可能表现不佳,但至少会减少你复制和粘贴的代码(:

注意:将属性设置为虚拟以防止编译器内联它们非常重要。

public class SampleClass : SessionObject
{
    [Session(Key = "SS_PROP")]
    public virtual int SampleProperty
    {
        get { return get(); }
        set { set(value); }
    }

    [Session(Key = "SS_PROP2")]
    public virtual string SampleProperty2
    {
        get { return get(); }
        set { set(value); }
    }
}

[AttributeUsage(AttributeTargets.Property)]
public class SessionAttribute : Attribute
{
    public string Key { get; set; }
}

public abstract class SessionObject
{
    Dictionary<string, object> Session = new Dictionary<string, object>();

    protected void set(object value)
    {
        StackFrame caller = new StackFrame(1);
        MethodBase method = caller.GetMethod();
        string propName = method.Name.Substring(4);
        Type type = method.ReflectedType;
        PropertyInfo pi = type.GetProperty(propName);
        object[] attributes = pi.GetCustomAttributes(typeof(SessionAttribute), true);
        if (attributes != null && attributes.Length == 1)
        {
            SessionAttribute ssAttr = attributes[0] as SessionAttribute;
            Session[ssAttr.Key] = value;
        }
    }

    protected dynamic get()
    {
        StackFrame caller = new StackFrame(1);
        MethodBase method = caller.GetMethod();
        string propName = method.Name.Substring(4);
        Type type = method.ReflectedType;
        PropertyInfo pi = type.GetProperty(propName);
        object[] attributes = pi.GetCustomAttributes(typeof(SessionAttribute), true);
        if (attributes != null && attributes.Length == 1)
        {
            SessionAttribute ssAttr = attributes[0] as SessionAttribute;
            if (Session.ContainsKey(ssAttr.Key))
            {
                return Session[ssAttr.Key];
            }
        }
        return default(dynamic);
    }
}

答案 1 :(得分:3)

另一种选择可能是使用PostSharp。 您定义属性并在最终代码中注入IL,因此它不会更改您的源代码。哪有它的坏处和它的货物。

此产品不是免费的。

一些Getting started提示。

希望这有帮助。

答案 2 :(得分:1)

如果你想避免编写这么多的getter代码,请编写一个辅助方法:

public int Foo
{
    get
    {
        return GetHelper<int>("foo");
    }
    set
    {
        Session["foo"] = value;
    }
}

public T GetHelper<T>(string name, T defaultValue = default(T))
{
    if (Session[name] != null)
        return (T)Session[name];
    else
    {
        return defaultValue;
    }
}

如果您可以访问动态,那么您可以使用动态对象来包装会话:

internal class DynamicSession : DynamicObject
{
    private HttpSessionState_session;

    public DynamicSession()
    {
        _session = HttpContext.Current.Session;
    }

    public override bool TryGetMember(GetMemberBinder binder, out object result)
    {
        if (_session[binder.Name] != null)
        {
            result = _session[binder.Name];
            return true;
        }
        result = null;
        return false;
    }

    public override bool TrySetMember(SetMemberBinder binder, object value)
    {
        _session[binder.Name] = value;
        return true;
    }
}

然后你可以这样使用它:

dynamic session = new DynamicSession();
    //These properties are "magically" put in and taken out of session!
//get
int foo = session.Foo;
//set
session.Foo = 3;

最后一个选项就像Resharper中的Live Templates一样,只是简单地输入代码。

答案 3 :(得分:1)

如果您希望在运行时执行此操作,请参阅以下Dr. Dobbs文章Generating Code at Run Time With Reflection.Emit

答案 4 :(得分:1)

您要做的事情被称为“面向方面编程”,对于某些任务来说,这是相对常见的,否则必要的代码会被重复多次,只需进行非常小的更改。你的榜样当然有资格。

基本思路如下;您可以创建一个可用于装饰类或类成员的属性。该属性为CLR中的消息传递系统定义了一个“上下文”,允许您将方法拦截器挂接到将在调用它时运行的方法。

了解所涉及的性能受到严重影响;具有由属性修饰的成员的对象必须继承自MarshallByRefObject或ContextBoundObject;即使您实际上没有进行任何属性装饰,其中任何一个都会在运行时产生大约10倍的对象性能。

以下是一些示例代码:http://www.developerfusion.com/article/5307/aspect-oriented-programming-using-net/3/

您还可以使用动态代理根据属性修饰或其他基于反射的信息“动态”创建对象。这是C#开发人员认为理所当然的大量技术,如ORM,IoC框架等等。你基本上会使用像Castle DynamicProxy这样的东西来创建一个看起来像你的基础对象的对象,但是已经覆盖了属性的定义用具有基于文件的填充/持久性逻辑的属性修饰。

答案 5 :(得分:0)

您还可以使用DynamicProxy nuget package from Castle.Core来实现此行为。

您可以拦截对类的所有虚拟属性的Get和Set方法的调用。但是,您要修改的所有属性getter和setter都必须是虚拟的。

我在这里提供了一个更完整的答案: https://stackoverflow.com/a/48764825/5103354 并且有一个要点here

应遵守以下行为:

    [Fact]
    public void SuccessFullyRegisterGetAndSetEvents()
    {
        ProxyGenerator generator = new ProxyGenerator();
        var tracked = generator.CreateClassProxy<TrackedClass>(new GetSetInterceptor());
        tracked.SomeContent = "some content";
        Assert.Single(tracked.GetEvents());
        var eventAfterSomeContentAssigned = tracked.GetEvents().Last();
        Assert.Equal(EventType.Set, eventAfterSomeContentAssigned.EventType);
        Assert.Equal("some content", eventAfterSomeContentAssigned.Value);
        Assert.Equal("SomeContent", eventAfterSomeContentAssigned.PropertyInfo.Name);
        tracked.SomeInt = 1;
        Assert.Equal(2, tracked.GetEvents().Count);
        var eventAfterSomeIntAssigned = tracked.GetEvents().Last();
        Assert.Equal(EventType.Set, eventAfterSomeContentAssigned.EventType);
        Assert.Equal(1, eventAfterSomeIntAssigned.Value);
        Assert.Equal("SomeInt", eventAfterSomeIntAssigned.PropertyInfo.Name);
        var x = tracked.SomeInt;
        Assert.Equal(3, tracked.GetEvents().Count);
        var eventAfterSomeIntAccessed = tracked.GetEvents().Last();
        Assert.Equal(EventType.Get, eventAfterSomeIntAccessed.EventType);
        Assert.Equal(1, eventAfterSomeIntAccessed.Value);
        Assert.Equal("SomeInt", eventAfterSomeIntAccessed.PropertyInfo.Name);
    }

希望这有帮助。