Forcing Derived type to apply custom attribute

Introduction

This article illustrates options to force attributes on derived types.

Background

In .NET eco system, Attributes are not inheritable. This means any attribute applied on base class are not applied/inherited on derived class. This article looks at different options available to forcer the attributes on derived types at compile time and at run time.

Approach

There are two approaches (with different intensions)

1. Forcing at run time : The base class constructor code will check for the presence of attribute and throw error runtime if attribute is not changed.

2. Forcing at compile time: Using ObsoleteAttribute, the Mandatory attribute will be reflected at compile time and will raise the error. This information is taken from this question on Stackoverflow.com

Using the Code

Forcing attribute at run time

1. Creating a Custom Attribute

   class CustomAttribute : System.Attribute { }  

2. In the constructor of base check the attribute

   publicBase() { CheckCustomAttribute(); }
   

3. If class type is base, skip the attribute check

   if (!(this.GetType() == typeof(Base)))
   

4. If class is derived type, check whether attribute exists or not.

   var attr = System.Attribute.GetCustomAttributes(
                            this.GetType())
                           .SingleOrDefault(t => typeof(CustomAttribute)
                           .IsAssignableFrom(t.GetType()));

The IsAssignableFrom take care of any attribute that derives from CustomAttribute.

5. Throw error is attribute does not exist.

   if (attr == null)
    {
        throw new Exception(String.Format(
                            "Derived class {0} doesnot apply {1} attribute",
                            this.GetType().Name,
                            typeof(CustomAttribute).Name));
    }

Forcing attribute at compile time

There is a special attribute ObsoleteAttribute. It is sealed so cannot be subclassed. The C# compiler has special handling for this attribute.

However to use Obsolete attribute rather awkwardly, It can be applied to a custom attribute. Then applying that custom attribute (on class/structs) will force compiler to show error

1. Create a custom attribute

   public class MandatoryAttribute : Attribute{}

2. Decorate the custom attribute with ObsoleteAttribute

   [Obsolete("MandatoryAttribute is required", true)]
   public class MandatoryAttribute : Attribute{}

    

3. Apply Custom attribute to class/member to get notification (as compile time error) on any type

   //[MandatoryAttribute]
   public class Base
   {
    //[MandatoryAttribute]
    public void SayHello() {}
   }

Uncommenting MandatoryAttribute raises awkard compile time error.

This is awkawrd because the error message is like

“MandatoryAttribute’ is obsolete: ‘MandatoryAttribute is required’    <filename>    <projectname>’”

Download source code from src link for this post.