Tutorial :Custom Attributes on Class Members



Question:

I am using a Custom Attribute to define how a class's members are mapped to properties for posting as a form post (Payment Gateway). I have the custom attribute working just fine, and am able to get the attribute by "name", but would like to get the attribute by the member itself.

For example:

getFieldName("name");  

vs

getFieldName(obj.Name);  

The plan is to write a method to serialize the class with members into a postable string.

Here's the test code I have at this point, where ret is a string and PropertyMapping is the custom attribute:

foreach (MemberInfo i in (typeof(CustomClass)).GetMember("Name"))  {      foreach (object at in i.GetCustomAttributes(true))      {          PropertyMapping map = at as PropertyMapping;          if (map != null)          {              ret += map.FieldName;          }      }  }  

Thanks in advance!


Solution:1

You can't really do this, unless you're using C# 3.0 in which case you'll need to rely on LINQ (ehm, expression trees).

What you do is that you create a dummy method for a lambda expression which lets the compiler generate the expression tree (compiler does the type checking). Then you dig into that tree to get the member. Like so:

static FieldInfo GetField<TType, TMemberType>(      Expression<Func<TType, TMemberType>> accessor)  {      var member = accessor.Body as MemberExpression;      if (member != null)      {          return member.Member as FieldInfo;      }      return null; // or throw exception...  }  

Given the following class:

class MyClass  {      public int a;  }  

You can get the meta data like this:

// get FieldInfo of member 'a' in class 'MyClass'  var f = GetField((MyClass c) => c.a);   

With a reference to that field you can then dig up any attribute the usual way. i.e. reflection.

static TAttribute GetAttribute<TAttribute>(       this MemberInfo member ) where TAttribute: Attribute  {      return member.GetCustomAttributes( typeof( TAttribute ), false )          .Cast<TAttribute>().FirstOrDefault<TAttribute>();  }  

Now you can dig up an attribute on any field by something which is in large checked by the compiler. It also works with refactoring, if you rename 'a' Visual Studio will catch that.

var attr = GetField((MyClass c) => c.a).GetAttribute<DisplayNameAttribute>();  Console.WriteLine(attr.DisplayName);  

There's not a single literal string in that code there.


Solution:2

You can do half of it a bit more simply:

    foreach (PropertyMapping attrib in          Attribute.GetCustomAttributes(i, typeof(PropertyMapping)))      {          ret += map.FieldName; // whatever you want this to do...      }  

btw; you should make a habit of ending attributes with the word Attribute. Even if this causes duplication (see [XmlAttributeAttribute]).

However - re serialization; that isn't always trivial. A deceptive amount of code goes into serialization frameworks like Json.NET etc. The normal approach might be to get a type-converter, but in many ways this is easier with a PropertyDescriptor:

    foreach (PropertyDescriptor prop in TypeDescriptor.GetProperties(obj))      {          Console.WriteLine("{0}={1}",              prop.Name, prop.Converter.ConvertToInvariantString(                  prop.GetValue(obj)));      }  

Note:If u also have question or solution just comment us below or mail us on toontricks1994@gmail.com
Previous
Next Post »