同一个方法上多个自定义注解的执行顺序问题分析

需求背景

在社交化电商项目中，除了需要对用户提交的敏感词进行拦截，也需要对黑名单用户进行拦截。因此，项目通过自定义注解的方式实现了两个注解@TextBlock和@BlackBlock，并实现了对应的拦截处理。

当笔者将两个注解注释在同一个方法（比如：用户发布帖子）上时，突然意识到一个问题：这两个注解的处理逻辑谁先谁后？笔者项目中的业务逻辑：黑名单拦截必须在敏感词拦截之前。

问题分析

针对上述问题，有两种观点：
（1）按照注解标注的顺序先后执行对应的拦截逻辑；
（2）按照注解名称的大小（以字符串形式进行比较），小的先执行，大的后执行；

接下来我们一起来看实践一下，实践出真知。

先定义两个注解和对应的切面类

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface A {
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface B {
}

@Slf4j
@Aspect
@Component
public class AAspect {
    @SneakyThrows
    @Around("@annotation(a)")
    public Object around(ProceedingJoinPoint point, A a) {
        log.info("注解A拦截处理");
        return point.proceed();
    }
}

@Slf4j
@Aspect
@Component
public class BAspect {
    @SneakyThrows
    @Around("@annotation(b)")
    public Object around(ProceedingJoinPoint point, B b) {
        log.info("注解B拦截处理");
        return point.proceed();
    }
}

再定义一个Service类来使用这些注解，代码如下：

@Component
@Slf4j
public class AbService {

	@B
	@A
	public void ab() {
		log.info("======ab======");
	}
}

请注意：上述代码中@B标注在@A之前，执行结果如下：

注解A拦截处理
注解B拦截处理
======ab======

由此，我们可以断定第1个观点时错误的。

接下来，我们将@A和@B交换注释位置之后，执行结果仍然不变。

注解A拦截处理
注解B拦截处理
======ab======

由此，我们可以推出第2个观点是正确的。

那如果想让@B先执行呢？就如电商中实际的需求，黑名单拦截必须先于敏感词拦截执行。

在注解对应的Aspect类上使用@Order注解指定执行顺序，指定值越小越先执行。如未指定，默认值为Integer.MAX_VALUE，即2147483647。

@Slf4j
@Aspect
@Component
@Order(10000)
public class BAspect {
    @SneakyThrows
    @Around("@annotation(b)")
    public Object around(ProceedingJoinPoint point, B b) {
        log.info("注解B拦截处理");
        return point.proceed();
    }
}

在BAspect类上加上注解@Order(10000)，由于10000小于AAspect默认的顺序Integer.MAX_VALUE，因此该逻辑会先执行。执行结果如下：

注解B拦截处理
注解A拦截处理
======ab======

问题结论

• 同一个方法上多个自定义注解，如果对应的切面类顺序相同，则注解名称小的先执行。默认情况注解A的逻辑优先注解B的逻辑；
• 如果通过@Order指定了切面类顺序，则顺序值越小越先执行。

参考文档

• Java项目中实现敏感词过滤功能