切面注解
快速开始
@Aspect
@Component
public class LogAspectHandler {
}
这里主要介绍几个常用的注解及使用:
- @Pointcut:定义一个切面,即上面所描述的关注的某件事入口。
- @Before:在做某件事之前做的事。
- @After:在做某件事之后做的事。
- @AfterReturning:在做某件事之后,对其返回值做增强处理。
- @AfterThrowing:在做某件事抛出异常时,处理。
@Pointcut 注解
@Aspect
@Component
public class LogAspectHandler {
/**
* 定义一个切面,拦截com.test.controller包和子包下的所有方法
*/
@Pointcut("execution(* com.test.controller..*.*(..))")
public void pointCut() {}
}
execution(*com.test.controller.*.*(..)))
表达式为例,语法如下:
execution()
为表达式主体,第一个*
号的位置:表示返回值类型,*
表示所有类型。- 包名:表示需要拦截的包名,后面的两个句点表示当前包和当前包的所有子包,
com.test.controller
包、子包下所有类的方法 - 第二个
*
号的位置:表示类名,*
表示所有类 *(..)
:这个星号表示方法名,*
表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数
@Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)")
public void annotationCut() {}
然后使用该切面的话,就会切入注解是
@Before 注解
@Aspect
@Component
public class LogAspectHandler {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* 在上面定义的切面方法之前执行该方法
* @param joinPoint jointPoint
*/
@Before("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);
}
}
@After 注解
@Aspect
@Component
public class LogAspectHandler {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* 定义一个切面,拦截com.test.course09.controller包下的所有方法
*/
@Pointcut("execution(* com.test.course09.controller..*.*(..))")
public void pointCut() {}
/**
* 在上面定义的切面方法之后执行该方法
* @param joinPoint jointPoint
*/
@After("pointCut()")
public void doAfter(JoinPoint joinPoint) {
logger.info("====doAfter方法进入了====");
Signature signature = joinPoint.getSignature();
String method = signature.getName();
logger.info("方法{}已经执行完", method);
}
}
到这里,我们来写一个
@RestController
@RequestMapping("/aop")
public class AopController {
@GetMapping("/{name}")
public String testAop(@PathVariable String name) {
return "Hello " + name;
}
}
启动项目,在浏览器中输入
====doBefore方法进入了====
即将执行方法为: testAop,属于com.test.course09.controller.AopController包
用户请求的url为:http://localhost:8080/aop/name,ip地址为:0:0:0:0:0:0:0:1
====doAfter方法进入了====
方法testAop已经执行完
从打印出来的
@AfterReturning 注解
@Aspect
@Component
public class LogAspectHandler {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* 在上面定义的切面方法返回后执行该方法,可以捕获返回对象或者对返回对象进行增强
* @param joinPoint joinPoint
* @param result result
*/
@AfterReturning(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 + "增强版");
}
}
需要注意的是:在
@AfterThrowing 注解
顾名思义,
@Aspect
@Component
public class LogAspectHandler {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* 在上面定义的切面方法执行抛异常时,执行该方法
* @param joinPoint jointPoint
* @param ex ex
*/
@AfterThrowing(pointcut = "pointCut()", throwing = "ex")
public void afterThrowing(JoinPoint joinPoint, Throwable ex) {
Signature signature = joinPoint.getSignature();
String method = signature.getName();
// 处理异常的逻辑
logger.info("执行方法{}出错,异常为:{}", method, ex);
}
}