Spring 下基于自定义注解拦截方法调用

其实很多年前就做过如此的实验,一翻开自己的日志有关于 aspectj site:unmi.cc, 可以找到  2008 年写的日志。真是流光容易把人抛,红了樱桃,绿了巴蕉。只是那时候 Spring 刚步入 2.0, 才翻开强大 AOP 的篇章,还记得彼时只要是直接使用 AspectJ 就要写  *.aj 文件。而如今 Spring 都到 5.0 了,也就是一年前才重拾起 Spring, 这期间 AspectJ 早就可以不用 *.aj 文件,只需普通 Java 文件,加上 @Aspect 和 @Pointcut 之类的注解就行。

本文内容与几年前写过的日志大体相差不大,再缀上一篇纯粹是个人笔记。这里不以 Spring 5.0 为例,仍然是最新的 4.3.11.RELEASE, 并且直接用 Spring, 而非选择  Spring Boot, 因为用了 Spring Boot 常常搞不清楚哪些是自动配置了的。原生的 Spring 可以使自己掌握一个 Spring AOP 的基本要素。

需求:@LogStartTime 注解的方法,在每次进入该方法时把当前时间写入 ThreadLocal 中去,被 @LogStartTime 注解的方法中随时可以获得进入方法的时间

接下来怎么能离开最具说明问题的代码呢?我们会通过 Main 方法和测试用例来验证。

这是项目所有的文件,下面逐一列出内容(为不值钱的篇幅考虑还是会对内容有所裁剪,比如省略 import 部分)

pom.xml, 用到以下依赖,用简洁的格式表示

@LogStartTime, 有该注解的方法将被拦截

MethodStartAspect, 定义切面和 Advice

这个类里就是用的 AspectJ 的语法来定义切面和 Advice 的,也可以定义普通方法。它同样是一个必须由 Spring 来管理的 Bean, 所以有 @Name 注解。代码中有详细的注释。

Spring AOP 只支持基于方法的拦截,可以拦截到 public, protected 和 package-visible 方法,从设计交互上应该只拦截 public 方法。其他诸如属性,构造函数等的拦截就得用真正的 AspectJ 了.

切面的定义还可以内联,如上面的 @Before("logStartTime()") 可以一句话写成 @Before("annotation(cc.unmi.aspects.LogStartTime)").

AppConfig, Spring  的 Java  Config 文件

这个配置要能扫描到切面定义(@Aspect) 的类,如上面的 MethodStartAspect

UserService, 有我们要拦截的方法

HelloAop, 应用类

执行后输出如下:

saved method start time in threadLocal
start time: 1506746277397, execution time: 2033
nameOf234

HelloAopTest, 测试类中看效果

执行后绿了

今天测试中碰到过在多模块的 Maven 项目中,把切面定义类 MethodStartAspect 放到另一个模块中方法拦截便失效了,不过刚刚的实验却是正常的,不知为何。

再进一步,在注解 @LogStartTime 中,我们可以定义属性,然后在切面中根据注解属性的不同作出不同的行为响应,如清楚日志的 MDC ContextMap 等。

如何获得注解参数

如果我们给注解 @LogStartTime 加个参数,那么它的声明就是

这时候要在切面中获得该注解的  value 参数的写法如下

Spring 中运用 AOP 时有三种写法风格:

  1. AspectJ language code style:  就是我原来写过的 *.aj 文件的语法。Java5 之前的无奈之选
  2. AspectJ annotation style: Java 代码却不失 *.aj 的特性,我的钟爱。而且它是 Spring AOP 和 AspectJ 同时能理解的
  3. Spring XML style: 这都什么年代了,缺点多多

本文完整代码可查看 Github 仓库 spring-annotation-aop

最好的帮助应该还是 Spring 的官方文档 AOP 篇。

类别: Spring. 标签: . 阅读(45). 订阅评论. TrackBack.

Leave a Reply

Be the First to Comment!

avatar