Can we enable or disable Aspect based on value of any flag or through configuration file?

Question

I have added following dependency in pom.xml

<dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.8.5</version>
        </dependency>

        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.5</version>
        </dependency>

And enable AspectJ in appContext.xml as follows:

And define aspect as follows:

@Component
@Aspect
public class AuthenticationServiceAspect {


@Before("execution(* com.service.impl.AuthenticationServiceImpl.*(..))")
    public void adviceMethod(JoinPoint joinPoint) {

        if(true){
            throw new Exception();
        }


}

Now I want to disable this AOP so that above code won't get execute? How can I do this?

score 28 · Answer 1 · answered Jun 29 '17 at 18:48

28

You may use enabling/disabling component with properties with ConditionalOnExpression annotation. When component is disabled the aspect is too.

@Component
@Aspect
@ConditionalOnExpression("${authentication.service.enabled:true}")// enabled by default
public class AuthenticationServiceAspect {
    @Before("execution(* com.service.impl.AuthenticationServiceImpl.*(..))")
    public void adviceMethod(JoinPoint joinPoint) {
        if(true){
            throw new Exception();
        }
    }
}

To disabling the aspect, just add authentication.service.enabled=false to your application.properties.

answered Jun 29 '17 at 18:48

Eric Georges

281
3
3

Thanks this annotation @ConditionalOnExpression is perfect for my solution. – Maciej Aug 09 '18 at 13:07
How can we use configuration in yml file ? – user280960 Aug 24 '18 at 20:43
1

This doesn't work with aspectJ compile time weaving... – Radu Sebastian LAZIN Sep 19 '21 at 15:09

score 1 · Answer 2 · edited Aug 05 '15 at 21:35

It appears Spring does not support AspectJ's if() pointcut primitive.

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'foo': Initialization of bean failed; nested exception is org.aspectj.weaver.tools.UnsupportedPointcutPrimitiveException: Pointcut expression 'execution(* doSomething(..)) && if()' contains unsupported pointcut primitive 'if'

score -1 · Answer 3 · edited Feb 15 '18 at 16:03

There is always the if() pointcut expression that allows you to define a condition to be checked by the advice: https://www.eclipse.org/aspectj/doc/next/adk15notebook/ataspectj-pcadvice.html#d0e3697

And... your aspect already is a Spring @Component. Why not just inject properties via @Value and decide on them whether your advice should execute? You can do that via the if() pointcut described above or by just checking the value in the advice and either executing or skipping because of it.

@Component
@Aspect
public class AuthenticationServiceAspect {

    @Value("${aspect.active}")
    private boolean active = true;

    @Pointcut("execution(* com.service.impl.AuthenticationServiceImpl.*(..)) && if()")
    public static boolean conditionalPointcut() {
        return active;
    }

    @Before("conditionalPointcut()")
    public void adviceMethod(JoinPoint joinPoint) {
        if(true){
            throw new Exception();
        }
    }
}

This doesn't work, because `active` is not static and hence cannot be returned from the static method `conditionalPointcut`. — Mack, Apr 06 '17 at 20:46

Can we enable or disable Aspect based on value of any flag or through configuration file?

3 Answers3

Linked