Library tutorials & articles

Attributed Programming in .NET Using C#

Implementing a Custom Attribute

The power of attributes can be further extended by implementing your own custom attributes. In this section, we will discuss the implementation of a custom attribute to restrict the length of the member fields in the User class declared above. This will illustrate how to define a custom attribute and then use reflection on the attribute target to accomplish our goal.

Before defining the custom attribute, let us discuss how do we accomplish our goal without using any attribute. We want to restrict the userID and password fields between four and eight characters and e-mail to a minimum of four characters and a maximum of 60 characters. There is no restriction on city; it can even be null. Also, we want to validate the fields before they are serialized, and if one or more fields are invalid, according to our validation criteria, we want to abandon serialization and display a message to the user informing him/her the field(s) that is/are invalid. To accomplish this goal, we need a class, Validator, with a method, IsValid, and we need to call this method, before running the serialization code, for each field that requires validation. Each time we add a field, requiring validation, to the class, we have to add codes for its validation. Also, if we declare other classes with fields that require similar validation, we have to duplicate codes to validate each field of every class. So, field validation is our crosscutting concern and the use of a simple Validator class does not provide a clean, modular approach to address this concern. We will see that an attribute, along with the Validator class, will provide a cleaner approach to our validation concern.

Let us say that we have defined an attribute, ValidLength. The attribute accepts two positional parameters for minimum and maximum length, and an optional named parameter for the message that will be displayed to the user. If no value for the optional parameter is supplied, we will display a generic message to the user. Now, let us apply the attribute to User class as:

using System;
using System.IO;
using System.Runtime.Serialization.Formatters.Soap;
using System.Reflection;
using System.Collections;

[Serializable]
public class User{
    [ValidLength(4,8,Message="UserID should be between 4 and 8 characters long")]
    public string userID;

    [ValidLength(4,8,Message="Password should be between 4 and 6 characters long")]
    public string password;

    [ValidLength(4,60)]
    public string email;
    public string city;

    public void Save(string fileName){
         FileStream s=new FileStream(fileName,FileMode.Create);
         SoapFormatter sf=new SoapFormatter();
         sf.Serialize(s,this);
    }

    static void Main(string[] args){
         User u=new User();
         u.userID="first";
         u.password="Zxfd12Qs";
         u.email=".com";
         u.city="";
         Validator v=new Validator();
         if(!v.IsValid(u)){
              foreach(string message in v.Messages)
                   Console.WriteLine(message);
         }
         else {u.Save("user.txt");}
    }
}

As you can see above, in the redefined User class, userID, password, and email fields are annotated with ValidLength attribute. To validate a User object, we pass the object to IsValid method of a Validator object. The Validator class can now be used to validate an object of any class by calling the IsValid method. If the string type fields of that object are targets of ValidLength attribute, IsValid will return true or false depending on the parameters of ValidLength attributes. We have completely decoupled our validation codes from the class that requires validation and the class where the validation is performed.

Comments

  1. 03 May 2004 at 03:26

    Hi
    Good article.I have a qus here. I have used a ot of attributes and have tried writing mine as well. Now the basic qus of when to write one of our own is still a little difficult for me. I understand simple using [SERIALIZABLE] makes life easier, but to really appreciate this perhaps I would want to understand whats the tought way of doing the same.
    Could anybody explain with an example how attribute is giving ab advantage.


    Thanks
    sourabh

  2. 06 Mar 2004 at 17:38
    how can I Add a reference to assembly System.Runtime.Serialization.Formatters.Soap.dll ???
  3. 10 Jan 2003 at 05:52
    This is a very good article.  

    The example shown used public modifier for the class attributes, is there any way to get it to work with private/protected attributes?  I tried the example code using private and was unable to get it to work.
  4. 06 Jan 2003 at 15:36

    I have absolutely no knowledge of C# and attributes, but I could understand the article very easily.  Good Write-up!

  5. 12 Nov 2002 at 17:52
    Well the attributed programming started from MIDL/COM programming and .NET also supports this concept widely.
    The advantages provided with attributed programming is amazing and simultaneously it has a drawback.
    The growth of attributes in each model like MIDL,MTS/COM+ and .NET is quite alarming.It increases the learning curve for a developer to use that Runtime.
    And it seems whatever the runtime Environment is not able to do is kept as attributes and Developer has to provide it.

    For example
    void  GetData(CMyObject  obj1,CMyObject  &obj2);

    In the above method all C++ compiler recognizes that obj1 is passed by value and obj2 is passed by reference.If the Runtime environment can have the equivalent inteligence then no requirement of marking [SERIALIAZABLE] attribute to the class if we want to pass the object by value.
    And what ever feature is not provided by any of the existing Object Oriented Language can be used as attributes.

    Ghanshyam.
  6. 31 Oct 2002 at 07:28

    The article is nice

  7. 01 Jan 1999 at 00:00

    This thread is for discussions of Attributed Programming in .NET Using C#.

Leave a comment

Sign in or Join us (it's free).

Deepak Dutta

Related podcasts

  • A Practical Look at Silverlight 2 Part 1

    Now that Silverlight 2 is at the Olympics and making a big splash, we wanted to explore this fascinating technology more. Microsoft Silverlight 2 is a cross-browser, cross-platform, and cross-device plug-in for delivering the next generation of .NET based media experiences and rich interactive ap...

Events coming up

  • Dec 9

    GL.net Group Meeting - December 2009

    Gloucester, United Kingdom

    The beginning of this year holiday season will belong to mocks. Ronnie and Stephen will take us for a tour around exciting world of unit testing.

Want to stay in touch with what's going on? Follow us on twitter!