前段时间学习 AOP(面向切面编程) 的知识,翻译了一篇文章:Spring AOP 最热门面试题及答案,没想到发布之后阅读量非常高(看来,标题真的很重要),但其实那篇译文讲得并不是很好,在文章最前面我也说了,只是因为概念介绍比较全面,所以翻译过来加深印象,意想不到的是这篇文章居然在百度“SpringAOP面试”关键词排名第一位。
在比较深入的学习了 AOP 的知识并应用于实际开发中,解决了很多问题之后,我就一直打算写几篇关于 AOP 的文章。前几天接到读者来信,说自己很疑惑,不知道AOP究竟是怎么回事,实践工作中也用不上。因此,我觉得更加有必要从根上来讲讲 AOP 究竟是怎么回事,为什么需要 AOP,什么场景下会用到 AOP。
一项技术肯定是为了解决特定的问题而生的,可以从“为什么不得不用”,这个角度入手,然后再去探究“有哪些实现”和“实现的原理”。
典型场景举例
有过开发经验的同学,想必对这样的 Controller 方法非常熟悉:
- 收到请求的时候打印请求信息和参数
- 记录开始时间
- 调用 Service 方法
- 调用结束后,打印成功信息和耗时,若发生异常则记录异常信息
- 统一的返回结果
我们仔细思考一下,这样的方法中,实际上有用的代码就只有一行
return ResultUtil.successResult(userService.getById(id));
但是我们却用了超过 10 行来写,想像一下,如果你维护的项目有 1000 个接口,那么你写的 10000 行代码中有 9000 行是重复的,多么可怕!DRY!!!
怎么办?(注意体会这里的不得不,我们不是为了用而用,而是有需求无法满足,而不得不使用新的模式或技术)
如果可以这样就好了
仔细观察,我们会发现,像日志、耗时分析、异常处理这样的需求很像夹心饼干:
这个“夹心饼干”的每一层都是我们的关注点(concern),我们称业务逻辑为核心关注点(core concern),而围绕着它要完成的切面功能,则为横切关注点(cross-cutting concern),如日志、安全、事务等。
如果在代码执行的时候,可以给我们一个通知(Advice):
- “大哥,我现在准备要调用UserController.getById这个方法了,参数是 xxx” --前置通知Before
- “大哥,UserController.getById这个方法,我用参数 xxx 调用之后正常返回了,结果是xxxx” –返回后通知AfterReturning
- “大哥,UserController.getById这个方法,我用参数 xxx 调用之后抛异常了,异常给你,你来决定要继续抛出还是把异常记录下来然后正常返回” –抛出异常后通知AfterThrowing
- “大哥,UserController.getById这个方法执行完了,执行状态都在这,您看看还有什么吩咐” –后置通知After
还可以有第五种:“嘿,老兄,UserController.getById这个方法被触发了,参数在这,要不要执行,怎么执行都交给你了” –环绕绕通知Around,简单起见,我们先不做介绍。
如果有了这些通知,我们就可以不用为了记录方法执行信息或者处理异常而重复地写那么多代码了!
可是,Java 没有直接提供这样的通知机制,我们要怎么做才能得到这些通知呢?
如何得到通知(Advice)
有一个相对可行的方法,就是代理。
静态代理
目标类
改写上面提到的Controller方法,我们只关心实际的业务代码(简单起见,我们省略注解,先不统计耗时;还有,为后面讲解方便,我们让这个 Controller 实现一个接口):
public interface IUserController {
public ReturnData<User> getById(int id);
}
public class UserController implements IUserController {
@Override
public ReturnData<User> getById(int id) {
if (id < 0) {
throw new IllegalArgumentException("id不能为负数");
}
return ResultUtil.successResult(userService.getById(id));
}
}
静态代理类
public class UserControllerProxy implements IUserController {
private UserController userController;
public UserControllerProxy(UserController userController){
this.userController = userController;
}
@Override
public ReturnData<User> getById(int id) {
// 大哥,我现在准备要调用 UserController.getById 这个方法了,参数给你
before(id);
ReturnData<User> result = null;
Throwable throwable = null;
try {
result = userController.getById(id);
// 大哥,UserController.getById这个方法,我用参数 xxx 调用之后正常返回了,结果是xxxx
afterReturning(id, result);
return result;
} catch (Throwable t) {
throwable = t;
// 大哥,UserController.getById这个方法,我用参数 xxx 调用之后抛异常了,异常给你
return afterThrowing(id, t);
} finally {
// 大哥,UserController.getById这个方法执行完了,执行状态都在这,您看看还有什么吩咐
after(id, result, throwable);
}
}
// 各个通知方法
...
}
这样我们就获取到上面提到的各种通知了
方法实现示例
这时我们就可以在各个相应的的方法中写我们的代码了:
public void before(int id) {
log.info("根据主键id获取用户信息开始, id: {}", id);
}
public void afterReturning(int id, ReturnData<User> result) {
log.info("根据主键id获取用户信息成功, id: {}, 结果: {}", id, result);
}
public ReturnData<User> afterThrowing(int id, Throwable t) {
log.error("据主键id获取用户信息发生异常, id: {}", id, t);
// 统一异常返回值
return new ReturnData<>(0, "据主键id获取用户发生异常, id: " + id);
}
public void after(int id, ReturnData<User> result, Throwable t) {
log.info("据主键id获取用户信息方法调用结束 id: {},是否成功: {}", id, t == null);
}
写个测试方法:
@Test
public void invokeStaticProxy