SpringAOP-SpringBoot切面AOP实现权限校验-《Java笔记》

admin 2025-10-19 04:21:23 编程 来源:ZONE.CI 全球网 0 阅读模式

Java Spring SpringBoot AOP

1、理解AOP

1.1 什么是AOP

AOP(Aspect Oriented Programming),面向切面思想,是Spring的三大核心思想之一(两外两个:IOC-控制反转、DI-依赖注入)。那么AOP为何那么重要呢?在程序中,经常存在一些系统性的需求,比如权限校验、日志记录、统计等,这些代码会散落穿插在各个业务逻辑中,非常冗余且不利于维护。例如下面这个示意图:有多少业务操作,就要写多少重复的校验和日志记录代码,这显然是无法接受的。当然,用面向对象的思想,可以把这些重复的代码抽离出来,写成公共方法,就是下面这样:这样,代码冗余和可维护性的问题得到了解决,但每个业务方法中依然要依次手动调用这些公共方法,也是略显繁琐。有没有更好的方式呢?有的,那就是AOP,AOP将权限校验、日志记录等非业务代码完全提取出来,与业务代码分离,并寻找节点切入业务代码中:

1.2%20AOP体系与概念

简单地去理解,其实AOP要做三类事:

  • 在哪里切入,也就是权限校验等非业务操作在哪些业务代码中执行。
  • 在什么时候切入,是业务代码执行前还是执行后。
  • 切入后做什么事,比如做权限校验、日志记录等。

因此,AOP的体系可以梳理为下图:一些概念详解:

  • Pointcut:切点,决定处理如权限校验、日志记录等在何处切入业务代码中(即织入切面)。切点分为execution方式和annotation方式。前者可以用路径表达式指定哪些类织入切面,后者可以指定被哪些注解修饰的代码织入切面。
  • Advice:处理,包括处理时机和处理内容。处理内容就是要做什么事,比如校验权限和记录日志。处理时机就是在什么时机执行处理内容,分为前置处理(即业务代码执行前)、后置处理(业务代码执行后)等。
  • Aspect:切面,即PointcutAdvice
  • Joint%20point:连接点,是程序执行的一个点。例如,一个方法的执行或者一个异常的处理。在%20Spring%20AOP%20中,一个连接点总是代表一个方法执行。
  • Weaving:织入,就是通过动态代理,在目标对象方法中执行处理内容的过程。 2、AOP实例实践出真知,接下来就写代码来实现一下AOP。使用%20AOP,首先需要引入%20AOP%20的依赖。<dependency>
  • %20%20<groupId>org.springframework.boot</groupId>%20%20<artifactId>spring-boot-starter-aop</artifactId></dependency> 2.1%20第一个实例接下来,先看一个极简的例子:所有的get请求被调用前在控制台输出一句”get请求的advice触发了”。具体实现如下:
  1. 创建一个AOP切面类,只要在类上加个%20@Aspect%20注解即可。@Aspect%20注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component%20注解将该类交给%20Spring%20来管理。在这个类里实现advice: ```java import%20org.aspectj.lang.annotation.Aspect; import%20org.aspectj.lang.annotation.Before; import%20org.aspectj.lang.annotation.Pointcut; import%20org.springframework.stereotype.Component;

@Aspect @Component public%20class%20LogAdvice%20{ %20%20%20%20//%20定义一个切点:所有被GetMapping注解修饰的方法会织入advice %20%20%20%20@Pointcut(“@annotation(org.springframework.web.bind.annotation.GetMapping)”) %20%20%20%20private%20void%20logAdvicePointcut()%20{}

%20//%20Before表示logAdvice将在目标方法执行前执行 %20%20%20%20@Before(“logAdvicePointcut()”) %20%20%20%20public%20void%20logAdvice(){ %20%20%20%20%20//%20这里只是一个示例,你可以写任何处理逻辑 %20%20%20%20%20%20%20%20System.out.println(“get请求的advice触发了”); %20%20%20%20} }

1.%20创建一个接口类,内部创建一个get请求:```javaimport%20com.alibaba.fastjson.JSON;import%20com.alibaba.fastjson.JSONObject;import%20org.springframework.web.bind.annotation.*;@RestController@RequestMapping(value%20=%20"/aop")public%20class%20AopController%20{%20%20%20%20@GetMapping(value%20=%20"/getTest")%20%20%20%20public%20JSONObject%20aopTest()%20{%20%20%20%20%20%20%20%20return%20JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");%20%20%20%20}%20@PostMapping(value%20=%20"/postTest")%20%20%20%20public%20JSONObject%20aopTest2(@RequestParam("id")%20String%20id)%20{%20%20%20%20%20%20%20%20return%20JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");%20%20%20%20}}

项目启动后,请求http://localhost:8085/aop/getTest接口:2021-06-06-19-07-27-380151.png2021-06-06-19-07-27-891782.png请求http://localhost:8085/aop/postTest接口,控制台无输出,证明切点确实是只针对被`GetMapping`修饰的方法。

2.2 第二个实例

下面将问题复杂化一些,该例的场景是:

  1. 自定义一个注解PermissionsAnnotation
  2. 创建一个切面类,切点设置为拦截所有标注PermissionsAnnotation的方法,截取到接口的参数,进行简单的权限校验
  3. PermissionsAnnotation标注在测试接口类的测试接口test上

具体的实现步骤:

  1. 使用@Target@Retention@Documented自定义一个注解:

    1. @Target(ElementType.METHOD)
    2. @Retention(RetentionPolicy.RUNTIME)
    3. @Documented
    4. public @interface PermissionAnnotation{
    5. }
  2. 创建第一个AOP切面类,,只要在类上加个 @Aspect 注解即可。@Aspect 注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component 注解将该类交给 Spring 来管理。在这个类里实现第一步权限校验逻辑: ```java import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.springframework.web.bind.annotation.*;

@RestController @RequestMapping(value = “/permission”) public class TestController { @RequestMapping(value = “/check”, method = RequestMethod.POST) // 添加这个注解 @PermissionsAnnotation() public JSONObject getGroupList(@RequestBody JSONObject request) { return JSON.parseObject(“{\”message\”:\”SUCCESS\”,\”code\”:200}”); } }

  1. 1. 创建接口类,并在目标方法上标注自定义注解 PermissionsAnnotation
  2. ```java
  3. import com.alibaba.fastjson.JSON;
  4. import com.alibaba.fastjson.JSONObject;
  5. import org.springframework.web.bind.annotation.*;
  6. @RestController
  7. @RequestMapping(value = "/permission")
  8. public class TestController {
  9. @RequestMapping(value = "/check", method = RequestMethod.POST)
  10. // 添加这个注解
  11. @PermissionsAnnotation()
  12. public JSONObject getGroupList(@RequestBody JSONObject request) {
  13. return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");
  14. }
  15. }

在这里,先进行一个测试。首先,填好请求地址和header:2021-06-06-19-07-26-705957.png其次,构造正常的参数:2021-06-06-19-07-26-823639.png可以拿到正常的响应结果:2021-06-06-19-07-26-925368.png然后,构造一个异常参数,再次请求:2021-06-06-19-07-27-044050.png响应结果显示,切面类进行了判断,并返回相应结果:如果一个接口想设置多个切面类进行校验怎么办?这些切面的执行顺序如何管理?很简单,一个自定义的AOP注解可以对应多个切面类,这些切面类执行顺序由@Order注解管理,该注解后的数字越小,所在切面类越先执行。下面在实例中进行演示:创建第二个AOP切面类,在这个类里实现第二步权限校验:

import%20com.alibaba.fastjson.JSON;import%20com.alibaba.fastjson.JSONObject;import%20org.aspectj.lang.ProceedingJoinPoint;import%20org.aspectj.lang.annotation.Around;import%20org.aspectj.lang.annotation.Aspect;import%20org.aspectj.lang.annotation.Pointcut;import%20org.springframework.core.annotation.Order;import%20org.springframework.stereotype.Component;@Aspect@Component@Order(0)public%20class%20PermissionSecondAdvice%20{%20%20%20@Pointcut("@annotation(com.example.demo.PermissionsAnnotation)")%20%20%20private%20void%20permissionCheck()%20{%20%20%20}%20%20%20@Around("permissionCheck()")%20%20%20public%20Object%20permissionCheckSecond(ProceedingJoinPoint%20joinPoint)%20throws%20Throwable%20{%20%20%20%20%20%20%20System.out.println("===================第二个切面===================:"%20+%20System.currentTimeMillis());%20%20%20%20%20%20%20//获取请求参数,详见接口类%20%20%20%20%20%20%20Object[]%20objects%20=%20joinPoint.getArgs();%20%20%20%20%20%20%20Long%20id%20=%20((JSONObject)%20objects[0]).getLong("id");%20%20%20%20%20%20%20String%20name%20=%20((JSONObject)%20objects[0]).getString("name");%20%20%20%20%20%20%20System.out.println("id->>>>>>>>>>>>>>>>>>>>>>"%20+%20id);%20%20%20%20%20%20%20System.out.println("name->>>>>>>>>>>>>>>>>>>>>>"%20+%20name);%20%20%20%20%20%20%20//%20name不是管理员则抛出异常%20%20%20%20%20%20%20if%20(!name.equals("admin"))%20{%20%20%20%20%20%20%20%20%20%20%20return%20JSON.parseObject("{\"message\":\"not%20admin\",\"code\":403}");%20%20%20%20%20%20%20}%20%20%20%20%20%20%20return%20joinPoint.proceed();%20%20%20}}

重启项目,继续测试,构造两个参数都异常的情况:响应结果,表面第二个切面类执行顺序更靠前:Spring Boot 切面AOP实现权限校验 - 图14

3、AOP相关注解

上面的案例中,用到了诸多注解,下面针对这些注解进行详解。

3.1 @Pointcut

@Pointcut 注解,用来定义一个切面,即上文中所关注的某件事情的入口,切入点定义了事件触发时机。

  1. @Aspect
  2. @Component
  3. public class LogAspectHandler {
  4. /**
  5. * 定义一个切面,拦截 com.itcodai.course09.controller 包和子包下的所有方法
  6. */
  7. @Pointcut("execution(* com.mutest.controller..*.*(..))")
  8. public void pointCut() {}
  9. }

@Pointcut 注解指定一个切面,定义需要拦截的东西,这里介绍两个常用的表达式:一个是使用 execution(),另一个是使用 annotation()execution表达式:以 execution(* * com.mutest.controller..*.*(..))) 表达式为例:

  • 第一个 * 号的位置:表示返回值类型,* 表示所有类型。
  • 包名:表示需要拦截的包名,后面的两个句点表示当前包和当前包的所有子包,在本例中指 com.mutest.controller包、子包下所有类的方法。
  • 第二个 * 号的位置:表示类名,* 表示所有类。
  • *(..):这个星号表示方法名,* 表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数。

annotation() 表达式:annotation() 方式是针对某个注解来定义切面,比如对具有 @PostMapping 注解的方法做切面,可以如下定义切面:

  1. @Pointcut("@annotation(org.springframework.web.bind.annotation.PostMapping)")
  2. public void annotationPointcut() {}

然后使用该切面的话,就会切入注解是 @PostMapping 的所有方法。这种方式很适合处理 @GetMapping@PostMapping@DeleteMapping不同注解有各种特定处理逻辑的场景。还有就是如上面案例所示,针对自定义注解来定义切面。

  1. @Pointcut("@annotation(com.example.demo.PermissionsAnnotation)")
  2. private void permissionCheck() {}

3.2 @Around

@Around注解用于修饰Around增强处理,Around增强处理非常强大,表现在:

  1. @Around可以自由选择增强动作与目标方法的执行顺序,也就是说可以在增强动作前后,甚至过程中执行目标方法。这个特性的实现在于,调用ProceedingJoinPoint参数的procedd()方法才会执行目标方法。
  2. @Around可以改变执行目标方法的参数值,也可以改变执行目标方法之后的返回值。

Around增强处理有以下特点:

  1. 当定义一个Around增强处理方法时,该方法的第一个形参必须是 ProceedingJoinPoint 类型(至少一个形参)。在增强处理方法体内,调用ProceedingJoinPointproceed方法才会执行目标方法:这就是@Around增强处理可以完全控制目标方法执行时机、如何执行的关键;如果程序没有调用ProceedingJoinPointproceed方法,则目标方法不会执行。
  2. 调用ProceedingJoinPointproceed方法时,还可以传入一个Object[ ]对象,该数组中的值将被传入目标方法作为实参——这就是Around增强处理方法可以改变目标方法参数值的关键。这就是如果传入的Object[ ]数组长度与目标方法所需要的参数个数不相等,或者Object[ ]数组元素与目标方法所需参数的类型不匹配,程序就会出现异常。

@Around功能虽然强大,但通常需要在线程安全的环境下使用。因此,如果使用普通的BeforeAfterReturning就能解决的问题,就没有必要使用Around了。如果需要目标方法执行之前和之后共享某种状态数据,则应该考虑使用Around。尤其是需要使用增强处理阻止目标的执行,或需要改变目标方法的返回值时,则只能使用Around增强处理了。下面,在前面例子上做一些改造,来观察@Around的特点。自定义注解类不变。首先,定义接口类:

  1. import com.alibaba.fastjson.JSON;
  2. import com.alibaba.fastjson.JSONObject;
  3. import org.springframework.web.bind.annotation.*;
  4. @RestController
  5. @RequestMapping(value = "/permission")
  6. public class TestController {
  7. @RequestMapping(value = "/check", method = RequestMethod.POST)
  8. @PermissionsAnnotation()
  9. public JSONObject getGroupList(@RequestBody JSONObject request) {
  10. return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200,\"data\":" + request + "}");
  11. }
  12. }

唯一切面类(前面案例有两个切面类,这里只需保留一个即可):

  1. import com.alibaba.fastjson.JSONObject;
  2. import org.aspectj.lang.ProceedingJoinPoint;
  3. import org.aspectj.lang.annotation.Around;
  4. import org.aspectj.lang.annotation.Aspect;
  5. import org.aspectj.lang.annotation.Pointcut;
  6. import org.springframework.core.annotation.Order;
  7. import org.springframework.stereotype.Component;
  8. @Aspect
  9. @Component
  10. @Order(1)
  11. public class PermissionAdvice {
  12. @Pointcut("@annotation(com.example.demo.PermissionsAnnotation)")
  13. private void permissionCheck() {
  14. }
  15. @Around("permissionCheck()")
  16. public Object permissionCheck(ProceedingJoinPoint joinPoint) throws Throwable {
  17. System.out.println("===================开始增强处理===================");
  18. //获取请求参数,详见接口类
  19. Object[] objects = joinPoint.getArgs();
  20. Long id = ((JSONObject) objects[0]).getLong("id");
  21. String name = ((JSONObject) objects[0]).getString("name");
  22. System.out.println("id1->>>>>>>>>>>>>>>>>>>>>>" + id);
  23. System.out.println("name1->>>>>>>>>>>>>>>>>>>>>>" + name);
  24. // 修改入参
  25. JSONObject object = new JSONObject();
  26. object.put("id", 8);
  27. object.put("name", "lisi");
  28. objects[0] = object;
  29. // 将修改后的参数传入
  30. return joinPoint.proceed(objects);
  31. }
  32. }

同样使用JMeter调用接口,传入参数:{"id":-5,"name":"admin"},响应结果表明:@Around截取到了接口的入参,并使接口返回了切面类中的结果。Spring Boot 切面AOP实现权限校验 - 图15

3.3 @Before

@Before 注解指定的方法在切面切入目标方法之前执行,可以做一些 Log 处理,也可以做一些信息的统计,比如获取用户的请求 URL 以及用户的 IP 地址等等,这个在做个人站点的时候都能用得到,都是常用的方法。例如下面代码:

  1. @Aspect
  2. @Component
  3. @Slf4j
  4. public class LogAspectHandler {
  5. /**
  6. * 在上面定义的切面方法之前执行该方法
  7. * @param joinPoint jointPoint
  8. */
  9. @Before("pointCut()")
  10. public void doBefore(JoinPoint joinPoint) {
  11. log.info("====doBefore方法进入了====");
  12. // 获取签名
  13. Signature signature = joinPoint.getSignature();
  14. // 获取切入的包名
  15. String declaringTypeName = signature.getDeclaringTypeName();
  16. // 获取即将执行的方法名
  17. String funcName = signature.getName();
  18. log.info("即将执行方法为: {},属于{}包", funcName, declaringTypeName);
  19. // 也可以用来记录一些信息,比如获取请求的 URL 和 IP
  20. ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  21. HttpServletRequest request = attributes.getRequest();
  22. // 获取请求 URL
  23. String url = request.getRequestURL().toString();
  24. // 获取请求 IP
  25. String ip = request.getRemoteAddr();
  26. log.info("用户请求的url为:{},ip地址为:{}", url, ip);
  27. }
  28. }

JointPoint 对象很有用,可以用它来获取一个签名,利用签名可以获取请求的包名、方法名,包括参数(通过 joinPoint.getArgs() 获取)等。

3.4 @After

@After 注解和 @Before 注解相对应,指定的方法在切面切入目标方法之后执行,也可以做一些完成某方法之后的 Log 处理。

  1. @Aspect
  2. @Component
  3. @Slf4j
  4. public class LogAspectHandler {
  5. /**
  6. * 定义一个切面,拦截 com.mutest.controller 包下的所有方法
  7. */
  8. @Pointcut("execution(* com.mutest.controller..*.*(..))")
  9. public void pointCut() {}
  10. /**
  11. * 在上面定义的切面方法之后执行该方法
  12. * @param joinPoint jointPoint
  13. */
  14. @After("pointCut()")
  15. public void doAfter(JoinPoint joinPoint) {
  16. log.info("==== doAfter 方法进入了====");
  17. Signature signature = joinPoint.getSignature();
  18. String method = signature.getName();
  19. log.info("方法{}已经执行完", method);
  20. }
  21. }

到这里,来写个 Controller 测试一下执行结果,新建一个 AopController 如下:

  1. @RestController
  2. @RequestMapping("/aop")
  3. public class AopController {
  4. @GetMapping("/{name}")
  5. public String testAop(@PathVariable String name) {
  6. return "Hello " + name;
  7. }
  8. }

启动项目,在浏览器中输入:localhost:8080/aop/test,观察一下控制台的输出信息:

  1. ====doBefore 方法进入了====
  2. 即将执行方法为: testAop,属于com.itcodai.mutest.AopController
  3. 用户请求的 url 为:http://localhost:8080/aop/name,ip地址为:0:0:0:0:0:0:0:1
  4. ==== doAfter 方法进入了====
  5. 方法 testAop 已经执行完

从打印出来的 Log 中可以看出程序执行的逻辑与顺序,可以很直观的掌握 @Before@After 两个注解的实际作用。

3.5 @AfterReturning

@AfterReturning 注解和 @After 有些类似,区别在于 @AfterReturning 注解可以用来捕获切入方法执行完之后的返回值,对返回值进行业务逻辑上的增强处理,例如:

  1. @Aspect
  2. @Component
  3. @Slf4j
  4. public class LogAspectHandler {
  5. /**
  6. * 在上面定义的切面方法返回后执行该方法,可以捕获返回对象或者对返回对象进行增强
  7. * @param joinPoint joinPoint
  8. * @param result result
  9. */
  10. @AfterReturning(pointcut = "pointCut()", returning = "result")
  11. public void doAfterReturning(JoinPoint joinPoint, Object result) {
  12. Signature signature = joinPoint.getSignature();
  13. String classMethod = signature.getName();
  14. log.info("方法{}执行完毕,返回参数为:{}", classMethod, result);
  15. // 实际项目中可以根据业务做具体的返回值增强
  16. log.info("对返回参数进行业务上的增强:{}", result + "增强版");
  17. }
  18. }

需要注意的是,在 @AfterReturning 注解 中,属性 returning 的值必须要和参数保持一致,否则会检测不到。该方法中的第二个入参就是被切方法的返回值,在 doAfterReturning 方法中可以对返回值进行增强,可以根据业务需要做相应的封装。重启一下服务,再测试一下:

  1. 方法 testAop 执行完毕,返回参数为:Hello
  2. 对返回参数进行业务上的增强:Hello 增强版

3.6 @AfterThrowing

当被切方法执行过程中抛出异常时,会进入 @AfterThrowing 注解的方法中执行,在该方法中可以做一些异常的处理逻辑。要注意的是 throwing 属性的值必须要和参数一致,否则会报错。该方法中的第二个入参即为抛出的异常。

  1. @Aspect
  2. @Component
  3. @Slf4j
  4. public class LogAspectHandler {
  5. /**
  6. * 在上面定义的切面方法执行抛异常时,执行该方法
  7. * @param joinPoint jointPoint
  8. * @param ex ex
  9. */
  10. @AfterThrowing(pointcut = "pointCut()", throwing = "ex")
  11. public void afterThrowing(JoinPoint joinPoint, Throwable ex) {
  12. Signature signature = joinPoint.getSignature();
  13. String method = signature.getName();
  14. // 处理异常的逻辑
  15. log.info("执行方法{}出错,异常为:{}", method, ex);
  16. }
  17. }
以太坊cppgolang区别 编程

以太坊cppgolang区别

以太坊是一种去中心化的开源平台,它采用智能合约技术,旨在构建和运行不受干扰的分布式应用程序。作为目前最受欢迎的区块链平台之一,以太坊提供了多种编程语言的支持,其
progolang 编程

progolang

Go语言(Golang)是由Google开发的一门静态类型编程语言。作为一名专业的Golang开发者,我深知这门语言的优势和特点。在本文中,我将介绍Golang
golangn个发送者 编程

golangn个发送者

Golang是一种开源的编程语言,由Google团队开发,旨在提高程序的并发性和简化软件开发过程。在Go语言中,有时需要向多个接收者发送信息。本文将介绍如何在G
golang技能图谱 编程

golang技能图谱

从互联网行业的快速发展到人工智能技术的日益成熟,各种编程语言也应运而生。而在这众多的编程语言中,Golang(即Go)作为一门强大且高效的开发语言备受关注。Go
评论:0   参与:  9