AOP+反射 批量参数校验

最新推荐文章于 2024-08-01 15:05:06 发布
最新推荐文章于 2024-08-01 15:05:06 发布
阅读量396 收藏 1
点赞数
文章标签： java spring 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_56079407/article/details/126317362
版权
  • 本案例包括4个核心类：
    AopUtils：抽取出来的公共方法
    @ValidateGroup
    @ValidateField
    ValidateAspectJHandler
  • 功能包括：长度、值范围、正则匹配、非空校验
  • 以下是设计思路、最终代码、测试结果
  • 后续扩展只需要修改@ValidateField 和 ValidateAspectJHandler

1.演示: 最终使用方法

以注册功能为例

@RestController
@RequestMapping("validater")
public class ValidateController {

  @ValidateGroup(fields = {
      @ValidateField(index = 0,notNull = true,maxLen = 10,code = "param1-error",message = "param1校验错误"),
      @ValidateField(index = 1,notNull = true,fieldName = "passWord",minLen = 6,code = "passWord-erro",message = "密码校验错误"),
      @ValidateField(index = 1,notNull = true,fieldName = "age",minVal = 0,code = "age-error",message = "年龄不能小于0"),
      @ValidateField(index = 1,notNull = true,fieldName = "tall",minVal = 0,maxVal = 250.9,code ="tall-error",message = "身高范围出错"),
      @ValidateField(index = 1,notNull = true,fieldName = "phone",regStr = "^(13[0-9]|14[01456879]|15[0-35-9]|16[2567]|17[0-8]|18[0-9]|19[0-35-9])\\d{8}$",code = "phone-error",message = "手机号错误")
  })
  @PostMapping("post")
  public String postValidater(@RequestParam String param1,  RegisterDto dto){

    System.out.println("成功通过校验");
    System.out.println("第一个参数是：" + param1);

    System.out.println("第二个参数是"+dto.toString());

    return "succeed";
  }	
}

其中：请求Dto包含name、passWord、phone等字段；
利用AspectJ对接口方法直接进行代理校验

2.流程分析

  • AspectJ代理注解@ValidateGroup标注的方法，而这个Group注解中的属性就是@ValidateField []
  • 获取到@ValidateField数组后，遍历。通过比对注解的参数 与 dto或者param中对应名字的参数来进行校验
  • 如果校验成功就放行，校验失败就抛异常终止

3.公共方法抽取AopUtils

经过流程分析可知：至少需要以下几个方法（并可以抽取为公共组件）

  • public Method getMethod(ProceedingJoinPoint pjp)：获取被AOP拦截的方法Method对象
  • public Annotation getAnnotationByMethod(Method method, Class annoClass)：获取目标方法对象的指定注解对象
  • public Object getFieldFromDtoByFieldName(Object dto , String fieldName) 从dto中，获取指定属性名的属性值

如下工具类也可以做成全静态方法

public class AopUtils {

private volatile static AopUtils aopUtils;


private AopUtils() {
}

public static AopUtils getInstance() {
    if (aopUtils == null) {
        synchronized (AopUtils.class) {
            if (aopUtils == null) {
                aopUtils = new AopUtils();
            }
        }
    }
    return aopUtils;
}

/**
 * 获取目标类的指定方法
 */
public Method getMethodByClassAndName(Class c, String methodName) {
    Method[] methods = c.getDeclaredMethods();
    for (Method method : methods) {
        if (method.getName().equals(methodName)) {
            return method;
        }
    }
    return null;
}

/**
 * 获取目标方法的指定注解
 * 相当于 method.getAnnotation(xxxx.class);
 */
public Annotation getAnnotationByMethod(Method method, Class annoClass) {
    Annotation all[] = method.getAnnotations();
    for (Annotation annotation : all) {
        if (annotation.annotationType() == annoClass) {
            return annotation;
        }
    }
    return null;
}

/**
 * 获取被拦截方法的对象
 * 配合使用，最终用于在Aspectj中获取被拦截方法上的注解
 * 例如：AopUtils.getMethod(pjp).getDeclaredAnnotation(被aop拦截的注解.class)
 */
public Method getMethod(ProceedingJoinPoint pjp) {
    //获取参数的签名
    MethodSignature msig = (MethodSignature) pjp.getSignature();
    // MethodSignature.getMethod() 获取的是顶层接口或者父类的方法对象 如果在实现类的方法上，应该使用反射获取当前对象的方法对象
    Object target = pjp.getTarget();//获取连接点所在的目标对象（被代理的对象）而不是父类or接口
    //方法名 + 方法形参 ————》获取指定的方法对象(重载)
    String methodName = msig.getName();
    Class[] parameterTypes = msig.getParameterTypes();
    Method method = null;
    try {
        method = target.getClass().getMethod(methodName, parameterTypes);
    } catch (NoSuchMethodException e) {
        //log.error(...);
    }
    return method;
}

/**
 * 从dto中，获取指定属性名的属性值；
 */
public Object getFieldFromDtoByFieldName(Object dto , String fieldName) throws NoSuchFieldException, IllegalAccessException {
    Class<?> dtoClazz = dto.getClass();
    Field field = dtoClazz.getDeclaredField(fieldName);
    field.setAccessible(true);
    return field.get(dto);
}

//  这个其实还有另一种写法
//  private Method getMethod(ProceedingJoinPoint joinPoint) {
//    try {
//      Class[] parameterTypes = ((MethodSignature) joinPoint.getSignature()).getMethod().getParameterTypes();
//      return joinPoint.getTarget().getClass().getMethod(joinPoint.getSignature().getName(), parameterTypes);
//    } catch (NoSuchMethodException e) {
//      e.printStackTrace();
//    }
//    return null;
//  }
}

4.注解及设计原理

4.1ValidateGroup

这个注解用于被AspectJ拦截，其属性是一个数组，用于参数校验

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface ValidateGroup {

  ValidateFiled[] fields();

}

4.2ValidateField

  • 当且仅当只有一个参数的时候可以不用指定index
  • index默认为0，例如public void register(@RequestParam String param1 , @RequestBody Dto dto){}中应该设置index = 1 ，这是由于joinPoint.getArgs()获取的形参是一个数组，需要用index指定位置
  • 所有参数都有默认值（不进行校验）

如下：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface ValidateField {

  /**
   * 参数索引位置：接口中有多个参数时用index指定需要校验的参数
   * 默认：0号索引，当且仅当接口方法只有一个参数
   */
  int index() default 0;

  /**
   * 默认：如果参数是基本数据类型或String，就不用指定该参数
   * 如果参数是对象，要验证对象里面某个属性，就用该参数指定属性名
   */
  String fieldName() default "";

  /**
   * 错误码，用于日志记录
   */
  String code() default "";

  /**
   * 错误提示语，用于日志记录
   */
  String message() default "";

  /**
   * 正则验证
   */
  String regStr() default "";

  /**
   * 非空校验，为true表示不能为空，false表示能够为空
   */
  boolean notNull() default false;

  /**
   * 字符串最大长度
   */
  int maxLen() default 0x7fffffff;

  /**
   * 字符串最小长度
   */
  int minLen() default 0;

  /**
   * 最大值，用于验证数值类型数据
   */
  double maxVal() default 0x1.fffffffffffffP+1023;

  /**
   * 最小值，用于验证数值类型数据
   */
  double minVal() default 0x0.0000000000001P-1022;

}

5.ValidateAspectJHandler

5.1大体结构

@Component
@Aspect
public class ValidateAspectHandler {

  private AopUtils aopUtils = AopUtils.getInstance();
  /**
   * 使用AOP对使用了ValidateGroup的方法进行代理校验
   */
  @Around("@annotation(ValidateGroup)")
  public Object validateAround(ProceedingJoinPoint joinPoint) throws Throwable {
//1.获取当前方法对象method
//2.根据method对象获取对应的ValidateGroup对象
//3.调用封装方法，将validateGroup.fields() 与 joinPoint.getArgs()形参数组传入，进行校验
//4.如果为true，则执行下一步
    return joinPoint.proceed();
  }


  /**
   * 封装方法：验证参数是否合法
   */
  private boolean validateField(ValidateFiled[] validateFields, Object[] args) {
    for (ValidateFiled validateFiled : validateFields) {
		//1.每次循环都是一个校验逻辑
		//2.index仍然是指定对第几号元素进行校验
		//3.fieldName如果不指定，那就是对基本数据类型即@RequestParam进行校验；如果指定，则对Dto即@RequestBody进行校验

}

5.2具体实现

@Component
@Aspect
public class ValidateAspctJHandler {

//    private static org.slf4j.Logger logger = LoggerFactory.getLogger("ValidateAspctJHandler");
    private AopUtils aopUtils = AopUtils.getInstance();

  /**
   * 使用AOP对使用了ValidateGroup的方法进行代理校验
   */
  //相当于用@Around + return joinPoint.proceed(); 
  //使用@Before的时候不能用ProceedingJoinPoint 只能用JoinPoint
    @Before("@annotation(ValidateGroup)")
    public void validateAround(JoinPoint joinPoint) throws Throwable {
        //获取被代理的方法对象
        Method method = aopUtils.getMethod(joinPoint);
        //获取被代理的方法对象对应的@ValidateGroup对象
        ValidateGroup validateGroup = (ValidateGroup)aopUtils.getAnnotationByMethod(method, ValidateGroup.class);
        //获取被代理方法的参数数组(这是参数值，而不是 method.getParameterTypes()返回的是Class[]  )
        Object[] args = joinPoint.getArgs();
        /*
         * args和validateGroup中包含了全部需要校验的信息，因此可以封装为一个方法
         * 在这个方法中，如果校验失败则用throws抛异常的方式终止
         */
        validateAllFields(validateGroup.fields(), args);
    }

    /**
     * 验证参数是否合法
     * ValidateField[]中每一条都是一个校验规则，每一条都对应一个属性
     * Object[] args中是所有的请求参数值，需要从args[validateFiled.index()中确定是对谁进行校验
     */
  private void validateAllFields(ValidateField[] validateFields, Object[] args) throws NoSuchFieldException, IllegalAccessException {
      //遍历：对每个@ValidateField进行校验
    for (ValidateField validateFiled : validateFields) {
      Object arg;
      //1.当fieldName为默认值""的时候，此时是对@RequestParam即基本数据类型orString进行校验
      if ("".equals(validateFiled.fieldName())) {
          //arg是基本数据类型orString
        arg = args[validateFiled.index()];
        //2.如果fieldName设置了，那就是对dto中的某个属性进行校验
      } else {
          //获取第index号参数dto指定的属性值
        arg = aopUtils.getFieldFromDtoByFieldName(args[validateFiled.index()], validateFiled.fieldName());
      }

      //3.以下是校验流程，需要同时考虑是对dto属性or基本数据类型orString
      //3.1判断参数是否为空
      if (validateFiled.notNull()) {
        if (arg == null || arg.equals("")) {
//            logger.error(validateFiled.code() + ":" + validateFiled.message());
          throw new RuntimeException(validateFiled.code()  + ":" + validateFiled.message());
        //如果该参数能够为空，并且当参数为空时，就不用判断后面的了 ，直接返回
        } }else {
        if (arg == null || arg.equals("")) {
          return;
        }
      }

      //3.2判断字符串最大长度  如果设置为一个负数则不校验  默认为最大int值
      if (validateFiled.maxLen() >= 0) {
        if (arg.toString().length() > validateFiled.maxLen()) {
//          logger.error(validateFiled.code() + ":" + validateFiled.message());
          throw new RuntimeException(validateFiled.code()  + ":" + validateFiled.message());
        }
      }
      //3.3判断字符串最小长度  如果设置为一个负数则不校验  默认为0
      if (validateFiled.minLen() >= 0) {
        if (arg.toString().length() < validateFiled.minLen()) {
//          logger.error(validateFiled.code() + ":" + validateFiled.message());
          throw new RuntimeException(validateFiled.code()  + ":" + validateFiled.message());
        }
      }
      //3.4判断数值最大值  当不是默认值0x1.fffffffffffffP+1023的时候进行判断
      if (validateFiled.maxVal() != 0x1.fffffffffffffP+1023) {
        if (Double.parseDouble(arg.toString()) > validateFiled.maxVal()) {
//          logger.error(validateFiled.code() + ":" + validateFiled.message());
          throw new RuntimeException(validateFiled.code()  + ":" + validateFiled.message());
        }
      }
      //3.5判断数值最小值   当不是默认值0x0.0000000000001P-1022的时候进行判断
      if (validateFiled.minVal() != 0x0.0000000000001P-1022) {
        if (Double.parseDouble(arg.toString()) < validateFiled.minVal()) {
//          logger.error(validateFiled.code() + ":" + validateFiled.message());
          throw new RuntimeException(validateFiled.code()  + ":" + validateFiled.message());
        }
      }

      //3.6判断正则 若未设置正则校验则跳过
      if (!"".equals(validateFiled.regStr())) {
        if (arg instanceof String || arg instanceof Integer || arg instanceof BigDecimal || arg instanceof Double) {
          if (!(arg.toString()).matches(validateFiled.regStr())) {
//            logger.error(validateFiled.code() + ":" + validateFiled.message());
            throw new RuntimeException(validateFiled.code()  + ":" + validateFiled.message());
          }
        }
      }
    }
    return;
  }
}

5.3接口测试

@RestController
@RequestMapping("validater")
public class ValidateController {

  @ValidateGroup(fields = {
  	//如果是index=0也可以省略不写
      @ValidateField(index = 0,notNull = true,maxLen = 10,code = "param1-error",message = "param1校验错误"),
      @ValidateField(index = 1,notNull = true,fieldName = "passWord",minLen = 6,code = "passWord-erro",message = "密码校验错误"),
      @ValidateField(index = 1,notNull = true,fieldName = "age",minVal = 0,code = "age-error",message = "年龄不能小于0"),
      @ValidateField(index = 1,notNull = true,fieldName = "tall",minVal = 0,maxVal = 250.9,code ="tall-error",message = "身高范围出错"),
      @ValidateField(index = 1,notNull = true,fieldName = "phone",regStr = "^(13[0-9]|14[01456879]|15[0-35-9]|16[2567]|17[0-8]|18[0-9]|19[0-35-9])\\d{8}$",code = "phone-error",message = "手机号错误")
  })
  @PostMapping("post")
  public String postValidater(@RequestParam String param1,  RegisterDto dto){

    System.out.println("成功通过校验");
    System.out.println("第一个参数是：" + param1);

    System.out.println("第二个参数是"+dto.toString());

    return "succeed";
  }
}


如果参数错误，则会直接抛异常终止请求

如果参数都正确就可以通过校验，如下：

ZJH'blog
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
java 统一校验规则_利用spring AOP 实现统一校验
weixin_30444625的博客
02-26 456
开发环境JDK: 1.7spring: 4.0.6aspect: 1.7.4应用背景在APP与后台通讯的过程中，我们一般都会有个authToken的字符串校验，判断那些请求是需要校验用户信息的，因为APP用户并不需要登录到我们的后台系统，所以一些基于session的权限控制(比如shiro)并不合适，所以导致我们又回到了解放前，很多请求都需要先校验这个用户的信息，不通过的就重定向到登录界面，比如下...
《深入浅出Spring》SpringAOP 详解AspectJ
ysj_2021的博客
07-22 568
Spring AOP AspectJ
AOP参数校验
weixin_63802890的博客
05-25 1539
在面试中，可能会问道AOP的适用场景有哪些，参数校验就是其中的一个例子在Java使用登录or注册功能时，会需要用户提交邮箱手机号等信息，此时前端可能会做参数校验，以下代码是基于后端的参数校验，可适用于大部分场景。
Java优雅的实现参数校验
weixin_51779902的博客
05-17 1440
JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。
spring boot+自定义 AOP 实现全局校验
weixin_30648963的博客
04-09 177
最近公司重构项目，重构为最热的微服务框架 spring boot， 重构的时候遇到几个可以统一处理的问题，也是项目中经常遇到，列如：统一校验参数，统一捕获异常。。。 仅凭代码 去控制参数的校验，有时候是冗余的，但通过框架支持的 去控制参数的校验，是对于开发者很友好，先看下面的例子 1 @NotEmpty(message="手机号不能为空") 2 @Size(min=1...
SpringBoot：自定义注解+反射实现excel导入的数据组装及字段校验
FrMaster的博客
04-22 646
批量导入还在写一个个的if判断？不累吗？求求了，放弃它好吗！这里有更好的方法。通过自定义注解+反射机制来实现，几十行代码就搞定不香吗？技术不存在会不会的问题，只看你想不得想得到~
SpringBoot 使用 AOP校验入参字段（DictVerify）和翻译响应字段（Dict）
weixin_45626288的博客
12-21 545
创建AOP切面 在方法上添加注解 在需要校验字段或者关联表数据是否存在的方法上添加注解，一般是新增和修改需要。 在需要校验的字段上添加注解 校验关联表是否存在数据 dicTable=表名， dicCode = “关联字段名”， dicText = “需要展示的字段名”，dicMsg = “用于前端的提示消息” 校验字典表是否存在数据 这里的dicCode就是字典表中字典类型 翻译响应字段 创建 Dict 注解 创建 Dict AOP切面 在需要翻译的字段上添加注解 需要关联表翻译的 dicTable=
使用java反射和AOP对比两个对象的属性来实现修改操作日志记录功能
skindow的博客
09-24 2857
使用注解来声明对象的哪些属性需要比对，新建注解 package com.skindow.annotion; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.a...
互联网应用主流框架整合【AOP】
Davieyang.D.Y
05-22 8920
SpringAOP详解、@Aspect、连接点、切面、切点、环绕通知、植入、引入（附源码）
SpringBoot AOP、事务
专注基础架构领域
03-17 781
Spring事务的本质其实就是数据库对事务的支持，没有数据库的事务支持，spring是无法提供事务功能的。假如当前正要运行的事务不在另外一个事务里，那么就起一个新的事务 比方说，ServiceB.methodB的事务级别定义PROPAGATION_REQUIRED, 那么因为执行ServiceA.methodA的时候，ServiceA.methodA已经起了事务。注解是不能继承的，这就意味着如果你正在使用基于类的代理时，那么事务的设置将不能被基于类的代理所识别，而且对象也将不会被事务代理所包装。
Spring Boot + validation + AOP 请求参数校验
12-20
Spring Boot + validation + AOP 请求参数校验 一、validation 校验注解 通用 @Null 被注释的属性必须为 null @NotNull被注释的属性必须不为 null @AssertTrue 被注释的属性必须为 true @AssertFalse 被注释的属性...
spring aop+自定义注解+反射实现统一校验脚手架
05-24
工程介绍：SpringBoot项目脚手架，利用spring aop+java反射实现自定义注解校验参数 源码里有使用都例子在DemoContorller example1：校验userName参数必填 @CheckParams(notNull = true) private String userName;...
SpringBoot+AOP+TraceID.pdf
01-04
SpringBoot+AOP+TraceID.pdf 本文档主要讲解了 SpringBoot 中 AOP（Aspect Oriented Programming）的应用和 TraceID 的实现。 AOP 基本概念 AOP 的 existence 目的是为了解耦，使得一组类可以共享相同的行为。在 ...
注解+AOP优雅的实现java项目的接口参数校验(含源码)
01-17
基于Spring boot + maven，以注解+AOP方式实现的java后端项目接口参数校验框架。迄今为止使用最简单、最容易理解的参数校验方案。博客地址：https://blog.csdn.net/weixin_42686388/article/details/104009771
使用hutool工具判断字符串是否全部是字母(包括大小写)，java判断字符串是否全部是字母(包括大小写)
qq_43700885的博客
07-29 565
1.导入hutool的maven依赖。2.复制一下代码执行。
社区养老服务小程序的设计
Karen198的博客
07-31 418
管理员账户功能包括：系统首页，个人中心，用户管理，服务人员管理，服务产品管理，服务预约管理，服务状态管理，服务退订管理，活动管理，视频管理。主要技术：Java,Spring,mybatis,mysql,jquery,html。服务器：SpringBoot自带 apache tomcat。微信端账号功能包括：系统首页，服务产品，活动，视频，我的。JDK版本：Java JDK1.8。数据库可视化工具： navicat。数据库版本： mysql5.7。开发工具：IDEA(推荐)开发系统：Windows。
深入理解Java注解
最新发布
weixin_55745942的博客
08-01 420
Java注解是用来描述程序元素（如类、方法、变量等）的一种机制。它们可以提供关于程序的补充信息，帮助编译器、框架或其他工具更好地理解和处理代码。注解通常以符号开头，后跟注解名称和可能的参数。要创建自定义注解，需要使用@interface关键字定义一个接口，并在接口中声明注解的属性。这个注解名为，可以被用来标记方法。它有一个名为value的属性，具有默认值"default"。
java判断邮箱地址是否正确，使用hutool工具判断邮箱地址是否正确
qq_43700885的博客
07-29 333
1.导入hutool的maven依赖。2.直接复制一下代码运行。
AOP+mybatis出入参
12-26
AOP（面向切面编程）和MyBatis可以结合使用来实现对数据库操作的切面处理，包括对入参和出参的处理。下面是一个示例： ```java @Aspect @Component public class MyBatisParamAspect { @Pointcut("execution(* com.example.dao.*.*(..))") public void mybatisMethods() {} @Before("mybatisMethods()") public void beforeMethod(JoinPoint joinPoint) { Object[] args = joinPoint.getArgs(); // 对入参进行处理 for (Object arg : args) { // 处理入参的逻辑 } } @AfterReturning(pointcut = "mybatisMethods()", returning = "result") public void afterReturningMethod(JoinPoint joinPoint, Object result) { // 对出参进行处理 // 处理出参的逻辑 } } ``` 上述代码中，通过使用`@Aspect`和`@Component`注解，定义了一个切面类`MyBatisParamAspect`。在该类中，使用`@Pointcut`注解定义了切点，指定了需要拦截的MyBatis方法。然后，使用`@Before`注解定义了一个前置通知，在MyBatis方法执行前对入参进行处理。使用`@AfterReturning`注解定义了一个后置通知，在MyBatis方法执行后对出参进行处理。 请注意，上述代码只是一个示例，具体的入参和出参处理逻辑需要根据实际需求进行编写。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值