SpringBoot实现参数校验拦截(采取AOP方式)

一、AOP是什么？

    目的：分离横切关注点（如日记记录、事件管理）与核心业务逻辑。
  优势：提高代码的可读性和可维护性。
  
  关键概念
  

• 切面（Aspect）：包含横切关注点代码的模块。
  
• 关照（Advice）：切面中的具体动作，比如方法调用之前或之后执行的代码。
  
• 毗连点（Join Point）：步伐执行的某个具体点，比如方法调用。
  
• 切入点（Pointcut）：定义在哪些毗连点应用关照。
  

  
二、使用步骤

1.引入库

代码如下（示例）：

1. <dependencies>
2.     <!-- 引入SpringBoot Aop依赖 -->
3.     <dependency>
4.         <groupId>org.springframework.boot</groupId>
5.         <artifactId>spring-boot-starter-aop</artifactId>
6.     </dependency>
8.     <!-- 引入Aspectj依赖 -->
9.     <dependency>
10.         <groupId>org.aspectj</groupId>
11.         <artifactId>aspectjweaver</artifactId>
12.         <version>1.9.7</version>
13.     </dependency>
14. </dependencies>

复制代码

2.定义注解

   定义注解GlobalInterceptor
  代码示例:如下

1. @Target({ElementType.METHOD})//注解的目标类型是方法
2. @Retention(RetentionPolicy.RUNTIME)//注解在运行的时候生效
3. @Documented
4. @Mapping
5. public @interface GlobalInterceptor {
6.     /**
7.      * 校验参数
8.      * @return
9.      */
10.     boolean checkParams() default false;
11. }

复制代码

   定义注解用来校验具体参数

1. @Retention(RetentionPolicy.RUNTIME)//运行时校验
2. @Target({ElementType.PARAMETER,ElementType.FIELD})// 指定该注解可以应用的目标类型为参数和字段
3. public @interface VerifyParam {
5.     int min() default -1;//校验最小长度
7.     int max() default -1;//检验最大长度
9.     boolean required() default false; //校验是否必传
11.     VerifyRegexEnum regex() default VerifyRegexEnum.NO;//校验正则，默认状态是不校验的
13. }

复制代码

 可以看到上方的VerifyRegexEnum，这里是一个枚举，重要是来校验参数的,那么枚举代码示例如下:

1. public enum VerifyRegexEnum {
2.     NO("","不校验"),
3.     EMAII("^[\\w-]+(\\.[\\w-]+)*@[\\w-]+(\\.[\\w-]+)+$","邮箱"),
4.     PASSWORD("^(?=.*\\d)(?=.*[a-zA-Z])[\\da-zA-Z~!@#$号^&* ]{8,}$","只能是数字，字母，特殊字符 8-18位");
6.     private String regex;
7.     private String desc;
9.     VerifyRegexEnum(String regex, String desc) {
10.         this.regex = regex;
11.         this.desc = desc;
12.     }
14.     public String getRegex() {
15.         return regex;
16.     }
18.     public String getDesc() {
19.         return desc;
20.     }
21. }

复制代码

 由于这里我的项目中只是简朴的校验了一下邮箱和暗码，需要的话，大家可以自行加入校验方式
 3.定义切面类

1. @Aspect//表明这是一个切面类
2. @Component("globalOperatcionAspect")// 交给Spring管理
3. public class GlobalOperatcionAspect {
5.     private static final Logger logger = LoggerFactory.getLogger(GlobalOperatcionAspect.class);
7.     private static final String[] TYPE_BASE = {"java.lang.String","java.lang.Integer","java.lang.Long"};
9.     //@Pointcut 定义切入点表达式，用于匹配目标方法，此处匹配带有@GlobalInterceptor注解的方法
10.     @Pointcut("@annotation(com.easypan.annotation.GlobalInterceptor)")
11.     private void requestInterceptor(){
12.         // 方法体为空，只是作为一个切入点标识
13.     }
14.     //@Before 在目标方法执行前执行
15.     @Before("requestInterceptor()")
16.     public void interceptorDo(JoinPoint point) throws BusinessException {
17.         try {
18.             Object target = point.getTarget();// 获取目标对象
19.             Object[] arguments = point.getArgs(); // 获取方法参数
20.             String methodName = point.getSignature().getName(); // 获取方法名
21.             Class<?>[] parameterTypes = ((MethodSignature) point.getSignature()).getMethod().getParameterTypes(); // 获取方法参数类型
22.             Method method = target.getClass().getMethod(methodName, parameterTypes); // 获取目标方法
23.             GlobalInterceptor interceptor = method.getAnnotation(GlobalInterceptor.class); // 获取方法上的全局拦截器注解
24.             if (null == interceptor) { // 如果注解为空则不执行拦截器逻辑
25.                 return;
26.             }
28.             /**
29.              * 检验参数
30.              */
31.             if (interceptor.checkParams()) { // 如果需要检验参数
32.                 validateParams(method, arguments); // 执行参数校验
33.             }
35.         } catch (BusinessException e) {
36.             logger.error("全局拦截器异常", e); // 记录异常日志
37.             throw e; // 抛出业务异常
38.         } catch (Exception e) {
39.             logger.error("全局拦截器异常", e); // 记录异常日志
40.             throw new BusinessException(ResponseCodeEnum.CODE_500); // 抛出业务异常
41.         } catch (Throwable e) {
42.             logger.error("全局拦截器异常", e); // 记录异常日志
43.             throw new BusinessException(ResponseCodeEnum.CODE_500); // 抛出业务异常
44.         }
45.     }
47.     /**
48.      * 检验规则
49.      * @param method 方法
50.      * @param arguments 参数列表
51.      */
52.     private void validateParams(Method method, Object[] arguments) {
53.         Parameter[] parameters = method.getParameters(); // 获取方法参数列表
54.         for (int i = 0; i < parameters.length; i++) { // 遍历参数列表
55.             Parameter parameter = parameters[i]; // 获取参数
56.             Object value = arguments[i]; // 获取参数值
57.             VerifyParam verifyParam = parameter.getAnnotation(VerifyParam.class); // 获取参数上的校验注解
58.             if (verifyParam == null) { // 如果注解为空则跳过
59.                 continue;
60.             }
61.             if (ArrayUtils.contains(TYPE_BASE, parameter.getParameterizedType().getTypeName())) { // 如果是基本类型
62.                 checkValue(value, verifyParam); // 执行值校验
63.             } else {
64.                 checkBObjValue(parameter, value); // 执行对象值校验
65.             }
66.         }
67.     }
69.     /**
70.      * 对象值校验
71.      * @param parameter 参数
72.      * @param value 参数值
73.      */
74.     private void checkBObjValue(Parameter parameter, Object value) {
75.         try {
76.             String typeName = parameter.getParameterizedType().getTypeName(); // 获取参数类型名
77.             Class classz = Class.forName(typeName); // 获取类对象
78.             Field[] fields = classz.getDeclaredFields(); // 获取类的所有字段
79.             for (Field field : fields) { // 遍历字段
80.                 VerifyParam fieldVerifyParam = field.getAnnotation(VerifyParam.class); // 获取字段上的校验注解
81.                 if (fieldVerifyParam == null) { // 如果注解为空则跳过
82.                     continue;
83.                 }
84.                 field.setAccessible(true); // 设置字段可访问
85.                 Object resultValue = field.get(value); // 获取字段值
86.                 checkValue(resultValue, fieldVerifyParam); // 执行值校验
87.             }
88.         } catch (BusinessException e) {
89.             logger.error("校验参数失败", e); // 记录异常日志
90.             throw e; // 抛出业务异常
91.         } catch (Exception e) {
92.             logger.error("校验参数失败", e); // 记录异常日志
93.             throw new BusinessException(ResponseCodeEnum.CODE_600); // 抛出业务异常
94.         }
95.     }
97.     /**
98.      * 值校验
99.      * @param value 值
100.      * @param verifyParam 校验参数
101.      */
102.     private void checkValue(Object value, VerifyParam verifyParam) {
103.         Boolean isEmpty = value == null || StringTools.isEmpty(value.toString()); // 判断值是否为空
104.         Integer length = value == null ? 0 : value.toString().length(); // 获取值长度
105.         /**
106.          * 检验空
107.          */
108.         if (isEmpty && verifyParam.required()) { // 如果值为空且需要校验空
109.             throw new BusinessException(ResponseCodeEnum.CODE_600); // 抛出业务异常
110.         }
112.         /**
113.          * 检验长度
114.          */
115.         if (!isEmpty && (verifyParam.max() != -1 && verifyParam.max() < length) || (verifyParam.min() != -1 && verifyParam.min() > length)) { // 如果值不为空且长度不符合规则
116.             throw new BusinessException(ResponseCodeEnum.CODE_600); // 抛出业务异常
117.         }
119.         /**
120.          * 校验正则
121.          */
122.         if (!isEmpty && !StringTools.isEmpty(verifyParam.regex().getRegex()) && !VerifyUtils.verify(verifyParam.regex(), String.valueOf(value))) { // 如果值不为空且不符合正则规则
123.             throw new BusinessException(ResponseCodeEnum.CODE_600); // 抛出业务异常
124.         }
125.     }
126. }

复制代码

---

总结

 去欣赏器直接调用这个路径，没有传参数的话，报错

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。