使用注解装配AOP


上一节我们讲解了使用AspectJ的注解,并配合一个复杂的execution(* xxx.Xyz.*(..))语法来定义应该如何装配AOP。

在实际项目中,这种写法其实很少使用。假设你写了一个SecurityAspect

  1. @Aspect
  2. @Component
  3. public class SecurityAspect {
  4. @Before("execution(public * com.itranswarp.learnjava.service.*.*(..))")
  5. public void check() {
  6. if (SecurityContext.getCurrentUser() == null) {
  7. throw new RuntimeException("check failed");
  8. }
  9. }
  10. }

基本能实现无差别全覆盖,即某个包下面的所有Bean的所有方法都会被这个check()方法拦截。

还有的童鞋喜欢用方法名前缀进行拦截:

  1. @Around("execution(public * update*(..))")
  2. public Object doLogging(ProceedingJoinPoint pjp) throws Throwable {
  3. // 对update开头的方法切换数据源:
  4. String old = setCurrentDataSource("master");
  5. Object retVal = pjp.proceed();
  6. restoreCurrentDataSource(old);
  7. return retVal;
  8. }

这种非精准打击误伤面更大,因为从方法前缀区分是否是数据库操作是非常不可取的。

我们在使用AOP时,要注意到虽然Spring容器可以把指定的方法通过AOP规则装配到指定的Bean的指定方法前后,但是,如果自动装配时,因为不恰当的范围,容易导致意想不到的结果,即很多不需要AOP代理的Bean也被自动代理了,并且,后续新增的Bean,如果不清楚现有的AOP装配规则,容易被强迫装配。

使用AOP时,被装配的Bean最好自己能清清楚楚地知道自己被安排了。例如,Spring提供的@Transactional就是一个非常好的例子。如果我们自己写的Bean希望在一个数据库事务中被调用,就标注上@Transactional

  1. @Component
  2. public class UserService {
  3. // 有事务:
  4. @Transactional
  5. public User createUser(String name) {
  6. ...
  7. }
  8. // 无事务:
  9. public boolean isValidName(String name) {
  10. ...
  11. }
  12. // 有事务:
  13. @Transactional
  14. public void updateUser(User user) {
  15. ...
  16. }
  17. }

或者直接在class级别注解,表示“所有public方法都被安排了”:

  1. @Component
  2. @Transactional
  3. public class UserService {
  4. ...
  5. }

通过@Transactional,某个方法是否启用了事务就一清二楚了。因此,装配AOP的时候,使用注解是最好的方式。

我们以一个实际例子演示如何使用注解实现AOP装配。为了监控应用程序的性能,我们定义一个性能监控的注解:

  1. @Target(METHOD)
  2. @Retention(RUNTIME)
  3. public @interface MetricTime {
  4. String value();
  5. }

在需要被监控的关键方法上标注该注解:

  1. @Component
  2. public class UserService {
  3. // 监控register()方法性能:
  4. @MetricTime("register")
  5. public User register(String email, String password, String name) {
  6. ...
  7. }
  8. ...
  9. }

然后,我们定义MetricAspect

  1. @Aspect
  2. @Component
  3. public class MetricAspect {
  4. @Around("@annotation(metricTime)")
  5. public Object metric(ProceedingJoinPoint joinPoint, MetricTime metricTime) throws Throwable {
  6. String name = metricTime.value();
  7. long start = System.currentTimeMillis();
  8. try {
  9. return joinPoint.proceed();
  10. } finally {
  11. long t = System.currentTimeMillis() - start;
  12. // 写入日志或发送至JMX:
  13. System.err.println("[Metrics] " + name + ": " + t + "ms");
  14. }
  15. }
  16. }

注意metric()方法标注了@Around("@annotation(metricTime)"),它的意思是,符合条件的目标方法是带有@MetricTime注解的方法,因为metric()方法参数类型是MetricTime(注意参数名是metricTime不是MetricTime),我们通过它获取性能监控的名称。

有了@MetricTime注解,再配合MetricAspect,任何Bean,只要方法标注了@MetricTime注解,就可以自动实现性能监控。运行代码,输出结果如下:

  1. Welcome, Bob!
  2. [Metrics] register: 16ms

练习

使用注解装配AOP - 图1下载练习:使用注解+AOP实现性能监控 (推荐使用IDE练习插件快速下载)

小结

使用注解实现AOP需要先定义注解,然后使用@Around("@annotation(name)")实现装配;

使用注解既简单,又能明确标识AOP装配,是使用AOP推荐的方式。

读后有收获可以支付宝请作者喝咖啡:

使用注解装配AOP - 图2