Spring AOP Exclude Some Classes

Harshil Sharma picture Harshil Sharma · Aug 8, 2016 · Viewed 13.6k times · Source

I'm using Spring AspectJ for logging method execution statistics, however, I want to exclude some classes and methods from this without changing the pointcut expression.

To exclude certain methods I created a custom annotation which I use to filter out. However I'm unable to do the same with classes.

Here is my aspect definition -

@Around("execution(* com.foo.bar.web.controller.*.*(..)) "
            + "&& !@annotation(com.foo.bar.util.NoLogging)")
public Object log(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
    // logging logic here
}

NoLogging is my custom annotation for excluding methods.

So how can I filter out certain classes without changing pointcut expression and without adding new advisors?

Answer

Harshil Sharma picture Harshil Sharma · Aug 10, 2016

Okay so I found the solution - use @target PCD (pointcut designators) to filter out classes with specific annotation. In this case I already have the @NoLogging annotation so I can use that. The updated pointcut expression will then become as follows -

@Around("execution(* com.foo.bar.web.controller.*.*(..)) "
            + "&& !@annotation(com.foo.bar.util.NoLogging)" 
            + "&& !@target(com.foo.bar.util.NoLogging)")
public Object log(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
    // logging logic here
}

Explanation -

execution(* com.foo.bar.web.controller.*.*(..)) - all methods of all classes in c.f.b.w.controller package

"&& !@annotation(com.foo.bar.util.NoLogging)" - which do NOT have @NoLogging annotation on them

"&& !@target(com.foo.bar.util.NoLogging)" - and whose class also does NOT have @NoLogging annotation.

So now I simply have to add @NoLogging annotation to any class whose methods I want to be excluded from the aspect.

More PCD can be found in Spring AOP documentation - http://docs.spring.io/spring/docs/current/spring-framework-reference/html/aop.html#aop-pointcuts-designators