Search code examples
c#reflectionattributestddassert

How to check if method has an attribute


I have an example class

public class MyClass{

    ActionResult Method1(){
        ....
    } 

    [Authorize]
    ActionResult Method2(){
       ....
    }

    [Authorize]    
    ActionResult Method3(int value){
       ....
    }

}

Now what I want is to write a function returning true/false that can be executed like this

var controller = new MyClass();

Assert.IsFalse(MethodHasAuthorizeAttribute(controller.Method1));
Assert.IsTrue(MethodHasAuthorizeAttribute(controller.Method2));
Assert.IsTrue(MethodHasAuthorizeAttribute(controller.Method3));

I got to the point where

public bool MethodHasAuthorizeAttribute(Func<int, ActionResult> function)
{
    return function.Method.GetCustomAttributes(typeof(AuthorizeAttribute), false).Length > 0;
}

would work for Method3. Now how can I do that generic in a way that it'll take strings and classes as parameters as well?


Solution

  • The issue with your code is the signature of public bool MethodHasAuthorizeAttribute(Func<int, ActionResult> function). MethodHasAuthorizeAttribute can only be used with arguments matching the signature of the delegate you specified. In this case a method returning an ActionResult with a parameter of type int.

    When you call this method like MethodHasAuthorizeAttribute(controller.Method3), the Compiler will do a method group conversion. This might not always be desired and can yield unexpected results (Method group conversions aren't always straigthforward). If you try to call MethodHasAuthorizeAttribute(controller.Method1) you will get a compiler error because there's no conversion.

    A more general solution can be constructed with expression trees and the famous "MethodOf" trick. It employs compiler generated expression trees to find the invocation target:

    public static MethodInfo MethodOf( Expression<System.Action> expression )
    {
        MethodCallExpression body = (MethodCallExpression)expression.Body;
        return body.Method;
    }
    

    You can use it like this, but it can also be used with any method:

    MethodInfo method = MethodOf( () => controller.Method3( default( int ) ) );
    

    With that out of the way, we can build a general implementation:

    public static bool MethodHasAuthorizeAttribute( Expression<System.Action> expression )
    {
        var method = MethodOf( expression );
    
        const bool includeInherited = false;
        return method.GetCustomAttributes( typeof( AuthorizeAttribute ), includeInherited ).Any();
    }
    

    Okay, thats for methods. Now, if you want to apply the Attribute check on classes or fields to (I'll spare properties because they are actually methods), we need to perform our check on MemberInfo, which is the inheritance root for Type, FieldInfo and MethodInfo. This as easy as extracting the Attribute search into a separate method and providing appropriate adapter methods with nice names:

    public static bool MethodHasAuthorizeAttribute( Expression<System.Action> expression )
    {
        MemberInfo member = MethodOf( expression );
        return MemberHasAuthorizeAttribute( member );
    }
    
    public static bool TypeHasAuthorizeAttribute( Type t)
    {
        return MemberHasAuthorizeAttribute( t );
    }
    
    private static bool MemberHasAuthorizeAttribute( MemberInfo member )
    {
        const bool includeInherited = false;
        return member.GetCustomAttributes( typeof( AuthorizeAttribute ), includeInherited ).Any();
    }
    

    I'll leave the implementation for fields as an exercise, you can employ the same trick as MethodOf.