2.1 AOP 依赖
使用AOP,首先需要引入AOP的依赖。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
2.2 实现 AOP 切面
Spring Boot 中使用 AOP 非常简单,假如我们要在项目中打印一些 log,在引入了上面的依赖之后,我们新建一个类 LogAspectHandler,用来定义切面和处理方法。只要在类上加个@Aspect
注解即可。@Aspect
注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component
注解让该类交给 Spring 来管理。
public class LogAspectHandler { }
这里主要介绍几个常用的注解及使用:
1.@Pointcut:定义一个切面,即上面所描述的关注的某件事入口。 2.@Before:在做某件事之前做的事。 3.@After:在做某件事之后做的事。 4.@AfterReturning:在做某件事之后,对其返回值做增强处理。 5.@AfterThrowing:在做某件事抛出异常时,处理。
2.2.1 @Pointcut 注解
@Pointcut
注解:用来定义一个切面(切入点),即上文中所关注的某件事情的入口。切入点决定了连接点关注的内容,使得我们可以控制通知什么时候执行。
public class LogAspectHandler { /** * 定义一个切面,拦截com.itcodai.course09.controller包和子包下的所有方法 */ "execution(* com.itcodai.course09.controller..*.*(..))") ( public void pointCut() {} }
@Pointcut
注解指定一个切面,定义需要拦截的东西,这里介绍两个常用的表达式:一个是使用 execution()
,另一个是使用 annotation()
。 以 execution(* com.itcodai.course09.controller..*.*(..)))
表达式为例,语法如下:
execution()
为表达式主体 第一个 *
号的位置:表示返回值类型,*
表示所有类型 包名:表示需要拦截的包名,后面的两个句点表示当前包和当前包的所有子包,com.itcodai.course09.controller
包、子包下所有类的方法 第二个 *
号的位置:表示类名,*
表示所有类 *(..)
:这个星号表示方法名,*
表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数
annotation()
方式是针对某个注解来定义切面,比如我们对具有@GetMapping
注解的方法做切面,可以如下定义切面:
"@annotation(org.springframework.web.bind.annotation.GetMapping)") (public void annotationCut() {}
然后使用该切面的话,就会切入注解是 @GetMapping
的方法。因为在实际项目中,可能对于不同的注解有不同的逻辑处理,比如 @GetMapping
、@PostMapping
、@DeleteMapping
等。所以这种按照注解的切入方式在实际项目中也很常用。
2.2.2 @Before 注解
@Before
注解指定的方法在切面切入目标方法之前执行,可以做一些 log 处理,也可以做一些信息的统计,比如获取用户的请求 url 以及用户的 ip 地址等等,这个在做个人站点的时候都能用得到,都是常用的方法。例如:
public class LogAspectHandler { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * 在上面定义的切面方法之前执行该方法 * @param joinPoint jointPoint */ "pointCut()") ( public void doBefore(JoinPoint joinPoint) { logger.info("====doBefore方法进入了===="); // 获取签名 Signature signature = joinPoint.getSignature(); // 获取切入的包名 String declaringTypeName = signature.getDeclaringTypeName(); // 获取即将执行的方法名 String funcName = signature.getName(); logger.info("即将执行方法为: {},属于{}包", funcName, declaringTypeName); // 也可以用来记录一些信息,比如获取请求的url和ip ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); // 获取请求url String url = request.getRequestURL().toString(); // 获取请求ip String ip = request.getRemoteAddr(); logger.info("用户请求的url为:{},ip地址为:{}", url, ip); } }
JointPoint 对象很有用,可以用它来获取一个签名,然后利用签名可以获取请求的包名、方法名,包括参数(通过 joinPoint.getArgs()
获取)等等。
2.2.3 @After 注解
@After
注解和 @Before
注解相对应,指定的方法在切面切入目标方法之后执行,也可以做一些完成某方法之后的 log 处理。
public class LogAspectHandler { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * 定义一个切面,拦截com.itcodai.course09.controller包下的所有方法 */ "execution(* com.itcodai.course09.controller..*.*(..))") ( public void pointCut() {} /** * 在上面定义的切面方法之后执行该方法 * @param joinPoint jointPoint */ "pointCut()") ( public void doAfter(JoinPoint joinPoint) { logger.info("====doAfter方法进入了===="); Signature signature = joinPoint.getSignature(); String method = signature.getName(); logger.info("方法{}已经执行完", method); } }
到这里,我们来写一个 Controller 来测试一下执行结果,新建一个 AopController 如下:
"/aop") (public class AopController { "/{name}") ( public String testAop( String name) { return "Hello " + name; } }
启动项目,在浏览器中输入 localhost:8080/aop/CSDN
,观察一下控制台的输出信息:
====doBefore方法进入了====
即将执行方法为: testAop,属于com.itcodai.course09.controller.AopController包
用户请求的url为:http://localhost:8080/aop/name,ip地址为:0:0:0:0:0:0:0:1
====doAfter方法进入了====
方法testAop已经执行完
从打印出来的 log 中可以看出程序执行的逻辑与顺序,可以很直观的掌握 @Before
和 @After
两个注解的实际作用。
2.2.4 @AfterReturning 注解
@AfterReturning
注解和 @After
有些类似,区别在于 @AfterReturning
注解可以用来捕获切入方法执行完之后的返回值,对返回值进行业务逻辑上的增强处理,例如:
public class LogAspectHandler { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * 在上面定义的切面方法返回后执行该方法,可以捕获返回对象或者对返回对象进行增强 * @param joinPoint joinPoint * @param result result */ pointcut = "pointCut()", returning = "result") ( public void doAfterReturning(JoinPoint joinPoint, Object result) { Signature signature = joinPoint.getSignature(); String classMethod = signature.getName(); logger.info("方法{}执行完毕,返回参数为:{}", classMethod, result); // 实际项目中可以根据业务做具体的返回值增强 logger.info("对返回参数进行业务上的增强:{}", result + "增强版"); } }
需要注意的是:在 @AfterReturning
注解 中,属性 returning
的值必须要和参数保持一致,否则会检测不到。该方法中的第二个入参就是被切方法的返回值,在 doAfterReturning
方法中可以对返回值进行增强,可以根据业务需要做相应的封装。我们重启一下服务,再测试一下(多余的 log 我不贴出来了):
方法testAop执行完毕,返回参数为:Hello CSDN
对返回参数进行业务上的增强:Hello CSDN增强版
2.2.5 @AfterThrowing 注解
顾名思义,@AfterThrowing
注解是当被切方法执行时抛出异常时,会进入 @AfterThrowing
注解的方法中执行,在该方法中可以做一些异常的处理逻辑。要注意的是 throwing
属性的值必须要和参数一致,否则会报错。该方法中的第二个入参即为抛出的异常。
/** * 使用AOP处理log * @author shengwu ni * @date 2018/05/04 20:24 */ public class LogAspectHandler { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * 在上面定义的切面方法执行抛异常时,执行该方法 * @param joinPoint jointPoint * @param ex ex */ pointcut = "pointCut()", throwing = "ex") ( public void afterThrowing(JoinPoint joinPoint, Throwable ex) { Signature signature = joinPoint.getSignature(); String method = signature.getName(); // 处理异常的逻辑 logger.info("执行方法{}出错,异常为:{}", method, ex); } }