参数校验_参数校验失败什么意思 - CSDN
精华内容
参与话题
  • 参数校验(validator)

    2019-10-18 20:41:17
    .javax.validation的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验 不然我们的代码就像下面这样: /** * 走串行校验 * * @param userVO * @return */ @PostMapping("/save/serial") public Object ...

    为什么要用validator

    • .javax.validation的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验

    不然我们的代码就像下面这样:

      /**
         * 走串行校验
         *
         * @param userVO
         * @return
         */
        @PostMapping("/save/serial")
        public Object save(@RequestBody UserVO userVO) {
            String mobile = userVO.getMobile();
    
            //手动逐个 参数校验~ 写法
            if (StringUtils.isBlank(mobile)) {
                return RspDTO.paramFail("mobile:手机号码不能为空");
            } else if (!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$", mobile)) {
                return RspDTO.paramFail("mobile:手机号码格式不对");
            }
    
            //抛出自定义异常等~写法
            if (StringUtils.isBlank(userVO.getUsername())) {
                throw new BizException(Constant.PARAM_FAIL_CODE, "用户名不能为空");
            }
    
            // 比如写一个map返回
            if (StringUtils.isBlank(userVO.getSex())) {
                Map<String, Object> result = new HashMap<>(5);
                result.put("code", Constant.PARAM_FAIL_CODE);
                result.put("msg", "性别不能为空");
                return result;
            }
            //.........各种写法 ...
            userService.save(userVO);
            return RspDTO.success();
        }
    
    • 什么是javax.validation

    JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:

            <!--jsr 303-->
            <dependency>
                <groupId>javax.validation</groupId>
                <artifactId>validation-api</artifactId>
                <version>1.1.0.Final</version>
            </dependency>
            <!-- hibernate validator-->
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>5.2.0.Final</version>
            </dependency>
    

    在这里插入图片描述

    • 注解说明
      @NotNull:不能为null,但可以为empty(""," “,” “)
      @NotEmpty:不能为null,而且长度必须大于0 (” “,” ")
      @NotBlank:只能作用在String上,不能为null,而且调用trim()后,长度必须大于0(“test”) 即:必须有实际字符
      在这里插入图片描述
      实战演练
    • @Validated 声明要检查的参数
     /**
         * 走参数校验注解
         *
         * @param userDTO
         * @return
         */
        @PostMapping("/save/valid")
        public RspDTO save(@RequestBody @Validated UserDTO userDTO) {
            userService.save(userDTO);
            return RspDTO.success();
        }
    
    • 对参数的字段进行注解标注
    
    
    import lombok.Data;
    import org.hibernate.validator.constraints.Length;
    
    import javax.validation.constraints.*;
    import java.io.Serializable;
    import java.util.Date;
    
    /**
     * @author LiJing
     * @ClassName: UserDTO
     * @Description: 用户传输对象
     * @date 2019/7/30 13:55
     */
    @Data
    public class UserDTO implements Serializable {
    
        private static final long serialVersionUID = 1L;
    
        /*** 用户ID*/
        @NotNull(message = "用户id不能为空")
        private Long userId;
    
        /** 用户名*/
        @NotBlank(message = "用户名不能为空")
        @Length(max = 20, message = "用户名不能超过20个字符")
        @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制:最多20字符,包含文字、字母和数字")
        private String username;
    
        /** 手机号*/
        @NotBlank(message = "手机号不能为空")
        @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
        private String mobile;
    
        /**性别*/
        private String sex;
    
        /** 邮箱*/
        @NotBlank(message = "联系邮箱不能为空")
        @Email(message = "邮箱格式不对")
        private String email;
    
        /** 密码*/
        private String password;
    
        /*** 创建时间 */
        @Future(message = "时间必须是将来时间")
        private Date createTime;
    
    }
    
    • 在全局校验中增加校验异常
      MethodArgumentNotValidException是springBoot中进行绑定参数校验时的异常,需要在springBoot中处理,其他需要处理ConstraintViolationException异常进行处理.
      为了优雅一点,我们将参数异常,业务异常,统一做了一个全局异常,将控制层的异常包装到我们自定义的异常中.
      为了优雅一点,我们还做了一个统一的结构体,将请求的code,和msg,data一起统一封装到结构体中,增加了代码的复用性
    import com.boot.lea.mybot.dto.RspDTO;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.dao.DuplicateKeyException;
    import org.springframework.web.bind.MethodArgumentNotValidException;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestControllerAdvice;
    import org.springframework.web.servlet.NoHandlerFoundException;
    
    import javax.validation.ConstraintViolationException;
    import javax.validation.ValidationException;
    
    
    /**
     * @author LiJing
     * @ClassName: GlobalExceptionHandler
     * @Description: 全局异常处理器
     * @date 2019/7/30 13:57
     */
    @RestControllerAdvice
    public class GlobalExceptionHandler {
    
        private Logger logger = LoggerFactory.getLogger(getClass());
    
        private static int DUPLICATE_KEY_CODE = 1001;
        private static int PARAM_FAIL_CODE = 1002;
        private static int VALIDATION_CODE = 1003;
    
        /**
         * 处理自定义异常
         */
        @ExceptionHandler(BizException.class)
        public RspDTO handleRRException(BizException e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(e.getCode(), e.getMessage());
        }
    
        /**
         * 方法参数校验
         */
        @ExceptionHandler(MethodArgumentNotValidException.class)
        public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(PARAM_FAIL_CODE, e.getBindingResult().getFieldError().getDefaultMessage());
        }
    
        /**
         * ValidationException
         */
        @ExceptionHandler(ValidationException.class)
        public RspDTO handleValidationException(ValidationException e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(VALIDATION_CODE, e.getCause().getMessage());
        }
    
        /**
         * ConstraintViolationException
         */
        @ExceptionHandler(ConstraintViolationException.class)
        public RspDTO handleConstraintViolationException(ConstraintViolationException e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(PARAM_FAIL_CODE, e.getMessage());
        }
    
        @ExceptionHandler(NoHandlerFoundException.class)
        public RspDTO handlerNoFoundException(Exception e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(404, "路径不存在,请检查路径是否正确");
        }
    
        @ExceptionHandler(DuplicateKeyException.class)
        public RspDTO handleDuplicateKeyException(DuplicateKeyException e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(DUPLICATE_KEY_CODE, "数据重复,请检查后提交");
        }
    
    
        @ExceptionHandler(Exception.class)
        public RspDTO handleException(Exception e) {
            logger.error(e.getMessage(), e);
            return new RspDTO(500, "系统繁忙,请稍后再试");
        }
    }
    
    • 测试

    如下文:确实做到了参数校验时返回异常信息和对应的code,方便了我们不再繁琐的处理参数校验
    在ValidationMessages.properties 就是校验的message,有着已经写好的默认的message,且是支持i18n的,大家可以阅读源码赏析。

    在这里插入图片描述

    展开全文
  • 参数校验(validator)详解

    千次阅读 2019-09-07 18:13:38
    很痛苦遇到大量的参数进行校验,在业务中还要抛出异常或者不断的返回异常时的校验信息,在代码中相当冗长, 充满了if-else这种校验代码,今天我们就来学习spring的javax.validation 注解式参数校验. 为什么要用...
    作者: 锦成同学
    juejin.im/post/5d3fbeb46fb9a06b317b3c48

    很痛苦遇到大量的参数进行校验,在业务中还要抛出异常或者不断的返回异常时的校验信息,在代码中相当冗长, 充满了if-else这种校验代码,今天我们就来学习spring的javax.validation 注解式参数校验.

    为什么要用validator

    1.javax.validation的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验

    不然我们的代码就像下面这样:

     /**
         * 走串行校验
         *
         * @param userVO
         * @return
         */
        @PostMapping("/save/serial")
        public Object save(@RequestBody UserVO userVO) {
            String mobile = userVO.getMobile();
    
            //手动逐个 参数校验~ 写法
            if (StringUtils.isBlank(mobile)) {
                return RspDTO.paramFail("mobile:手机号码不能为空");
            } else if (!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$", mobile)) {
                return RspDTO.paramFail("mobile:手机号码格式不对");
            }
    
            //抛出自定义异常等~写法
            if (StringUtils.isBlank(userVO.getUsername())) {
                throw new BizException(Constant.PARAM_FAIL_CODE, "用户名不能为空");
            }
    
            // 比如写一个map返回
            if (StringUtils.isBlank(userVO.getSex())) {
                Map<String, Object> result = new HashMap<>(5);
                result.put("code", Constant.PARAM_FAIL_CODE);
                result.put("msg", "性别不能为空");
                return result;
            }
            //.........各种写法 ...
            userService.save(userVO);
            return RspDTO.success();
        }

    这被大佬看见,一定说,都9102了还这么写,然后被劝退了…..

    2.什么是javax.validation

    JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:

      <!--jsr 303-->
            <dependency>
                <groupId>javax.validation</groupId>
                <artifactId>validation-api</artifactId>
                <version>1.1.0.Final</version>
            </dependency>
            <!-- hibernate validator-->
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>5.2.0.Final</version>
            </dependency>

    3.注解说明

     

    2. 然后自定义Validator

    这个是真正进行验证的逻辑代码:

     

    • @NotNull:不能为null,但可以为empty(""," "," ")

    • @NotEmpty:不能为null,而且长度必须大于0 (" "," ")

    • @NotBlank:只能作用在String上,不能为null,而且调用trim()后,长度必须大于0("test") 即:必须有实际字符

    • 此处只列出Hibernate Validator提供的大部分验证约束注解,请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。

      实战演练

      话不多说,直接走实践路线,同样使用的是SpringBoot的快速框架

      详细代码见:

      https://github.com/leaJone/mybot

      1. @Validated 声明要检查的参数

      这里我们在控制器层进行注解声明

    • /**
           * 走参数校验注解
           *
           * @param userDTO
           * @return
           */
          @PostMapping("/save/valid")
          public RspDTO save(@RequestBody @Validated UserDTO userDTO) {
              userService.save(userDTO);
              return RspDTO.success();
          }

       

    • 2. 对参数的字段进行注解标注

    • import lombok.Data;
      import org.hibernate.validator.constraints.Length;
      
      import javax.validation.constraints.*;
      import java.io.Serializable;
      import java.util.Date;
      
      /**
       * @author LiJing
       * @ClassName: UserDTO
       * @Description: 用户传输对象
       * @date 2019/7/30 13:55
       */
      @Data
      public class UserDTO implements Serializable {
      
          private static final long serialVersionUID = 1L;
      
          /*** 用户ID*/
          @NotNull(message = "用户id不能为空")
          private Long userId;
      
          /** 用户名*/
          @NotBlank(message = "用户名不能为空")
          @Length(max = 20, message = "用户名不能超过20个字符")
          @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制:最多20字符,包含文字、字母和数字")
          private String username;
      
          /** 手机号*/
          @NotBlank(message = "手机号不能为空")
          @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
          private String mobile;
      
          /**性别*/
          private String sex;
      
          /** 邮箱*/
          @NotBlank(message = "联系邮箱不能为空")
          @Email(message = "邮箱格式不对")
          private String email;
      
          /** 密码*/
          private String password;
      
          /*** 创建时间 */
          @Future(message = "时间必须是将来时间")
          private Date createTime;
      
      }

       

    • 3. 在全局校验中增加校验异常

      MethodArgumentNotValidException是springBoot中进行绑定参数校验时的异常,需要在springBoot中处理,其他需要处理ConstraintViolationException异常进行处理.

      为了优雅一点,我们将参数异常,业务异常,统一做了一个全局异常,将控制层的异常包装到我们自定义的异常中.

      为了优雅一点,我们还做了一个统一的结构体,将请求的code,和msg,data一起统一封装到结构体中,增加了代码的复用性.

    • import com.boot.lea.mybot.dto.RspDTO;
      import org.slf4j.Logger;
      import org.slf4j.LoggerFactory;
      import org.springframework.dao.DuplicateKeyException;
      import org.springframework.web.bind.MethodArgumentNotValidException;
      import org.springframework.web.bind.annotation.ExceptionHandler;
      import org.springframework.web.bind.annotation.RestControllerAdvice;
      import org.springframework.web.servlet.NoHandlerFoundException;
      
      import javax.validation.ConstraintViolationException;
      import javax.validation.ValidationException;
      
      
      /**
       * @author LiJing
       * @ClassName: GlobalExceptionHandler
       * @Description: 全局异常处理器
       * @date 2019/7/30 13:57
       */
      @RestControllerAdvice
      public class GlobalExceptionHandler {
      
          private Logger logger = LoggerFactory.getLogger(getClass());
      
          private static int DUPLICATE_KEY_CODE = 1001;
          private static int PARAM_FAIL_CODE = 1002;
          private static int VALIDATION_CODE = 1003;
      
          /**
           * 处理自定义异常
           */
          @ExceptionHandler(BizException.class)
          public RspDTO handleRRException(BizException e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(e.getCode(), e.getMessage());
          }
      
          /**
           * 方法参数校验
           */
          @ExceptionHandler(MethodArgumentNotValidException.class)
          public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(PARAM_FAIL_CODE, e.getBindingResult().getFieldError().getDefaultMessage());
          }
      
          /**
           * ValidationException
           */
          @ExceptionHandler(ValidationException.class)
          public RspDTO handleValidationException(ValidationException e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(VALIDATION_CODE, e.getCause().getMessage());
          }
      
          /**
           * ConstraintViolationException
           */
          @ExceptionHandler(ConstraintViolationException.class)
          public RspDTO handleConstraintViolationException(ConstraintViolationException e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(PARAM_FAIL_CODE, e.getMessage());
          }
      
          @ExceptionHandler(NoHandlerFoundException.class)
          public RspDTO handlerNoFoundException(Exception e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(404, "路径不存在,请检查路径是否正确");
          }
      
          @ExceptionHandler(DuplicateKeyException.class)
          public RspDTO handleDuplicateKeyException(DuplicateKeyException e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(DUPLICATE_KEY_CODE, "数据重复,请检查后提交");
          }
      
      
          @ExceptionHandler(Exception.class)
          public RspDTO handleException(Exception e) {
              logger.error(e.getMessage(), e);
              return new RspDTO(500, "系统繁忙,请稍后再试");
          }
      }

      4. 测试

      如下文:确实做到了参数校验时返回异常信息和对应的code,方便了我们不再繁琐的处理参数校验

    • 在ValidationMessages.properties 就是校验的message,有着已经写好的默认的message,且是支持i18n的,大家可以阅读源码赏析

      自定义参数注解

      1. 比如我们来个 自定义身份证校验 注解

    • @Documented
      @Target({ElementType.PARAMETER, ElementType.FIELD})
      @Retention(RetentionPolicy.RUNTIME)
      @Constraint(validatedBy = IdentityCardNumberValidator.class)
      public @interface IdentityCardNumber {
      
          String message() default "身份证号码不合法";
      
          Class<?>[] groups() default {};
      
          Class<? extends Payload>[] payload() default {};
      }

      这个注解是作用在Field字段上,运行时生效,触发的是IdentityCardNumber这个验证类。

    • message 定制化的提示信息,主要是从ValidationMessages.properties里提取,也可以依据实际情况进行定制

    • groups 这里主要进行将validator进行分类,不同的类group中会执行不同的validator操作

    • payload 主要是针对bean的,使用不多。

    • 2. 然后自定义Validator

      这个是真正进行验证的逻辑代码:

    • public class IdentityCardNumberValidator implements ConstraintValidator<IdentityCardNumber, Object> {
      
          @Override
          public void initialize(IdentityCardNumber identityCardNumber) {
          }
      
          @Override
          public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
              return IdCardValidatorUtils.isValidate18Idcard(o.toString());
          }
      }

      IdCardValidatorUtils在项目源码中,可自行查看

      3. 使用自定义的注解

    •  @NotBlank(message = "身份证号不能为空")
          @IdentityCardNumber(message = "身份证信息有误,请核对后提交")
          private String clientCardNo;

      4.使用groups的校验

      有的宝宝说同一个对象要复用,比如UserDTO在更新时候要校验userId,在保存的时候不需要校验userId,在两种情况下都要校验username,那就用上groups了:

      先定义groups的分组接口Create和Update

    • import javax.validation.groups.Default;
      
      public interface Create extends Default {
      }
      
      import javax.validation.groups.Default;
      
      public interface Update extends Default{
      }

      再在需要校验的地方@Validated声明校验组

    • /**
           * 走参数校验注解的 groups 组合校验
           *
           * @param userDTO
           * @return
           */
          @PostMapping("/update/groups")
          public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) {
              userService.updateById(userDTO);
              return RspDTO.success();
          }

      在DTO中的字段上定义好groups = {}的分组类型

    • @Data
      public class UserDTO implements Serializable {
      
          private static final long serialVersionUID = 1L;
      
          /*** 用户ID*/
          @NotNull(message = "用户id不能为空", groups = Update.class)
          private Long userId;
      
          /**
           * 用户名
           */
          @NotBlank(message = "用户名不能为空")
          @Length(max = 20, message = "用户名不能超过20个字符", groups = {Create.class, Update.class})
          @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限制:最多20字符,包含文字、字母和数字")
          private String username;
      
          /**
           * 手机号
           */
          @NotBlank(message = "手机号不能为空")
          @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误", groups = {Create.class, Update.class})
          private String mobile;
      
          /**
           * 性别
           */
          private String sex;
      
          /**
           * 邮箱
           */
          @NotBlank(message = "联系邮箱不能为空")
          @Email(message = "邮箱格式不对")
          private String email;
      
          /**
           * 密码
           */
          private String password;
      
          /*** 创建时间 */
          @Future(message = "时间必须是将来时间", groups = {Create.class})
          private Date createTime;
      
      }

      注意:在声明分组的时候尽量加上 extend javax.validation.groups.Default 否则,在你声明@Validated(Update.class)的时候,就会出现你在默认没添加groups = {}的时候的校验组@Email(message = "邮箱格式不对"),会不去校验,因为默认的校验组是groups = {Default.class}.

      5.restful风格用法

      在多个参数校验,或者@RequestParam 形式时候,需要在controller上加注@Validated

    • @GetMapping("/get")
          public RspDTO getUser(@RequestParam("userId") @NotNull(message = "用户id不能为空") Long userId) {
              User user = userService.selectById(userId);
              if (user == null) {
                  return new RspDTO<User>().nonAbsent("用户不存在");
              }
              return new RspDTO<User>().success(user);
          }
      @RestController
      @RequestMapping("user/")
      @Validated
      public class UserController extends AbstractController {
      
      ....圣洛代码...

      总结

      用起来很简单,soEasy,重点参与的统一结构体返回,统一参数校验,是减少我们代码大量的try catch 的法宝,我觉得在项目中,将异常处理好,并将异常做好日志管理,才是很好的升华,文章浅显,只是一个菜鸟的进阶笔记….

      这里只是个人见解,技术菜,欢迎大佬不吝赐教…

    •  

    展开全文
  • 在开发接口的时候,参数校验是必不可少的。参数的类型,长度等规则,在开发初期都应该由产品经理或者技术负责人等来约定。如果不对入参做校验,很有可能会因为一些不合法的参数而导致系统出现异常。 上一篇文章讲了...

    前言

    在开发接口的时候,参数校验是必不可少的。参数的类型,长度等规则,在开发初期都应该由产品经理或者技术负责人等来约定。如果不对入参做校验,很有可能会因为一些不合法的参数而导致系统出现异常。

    上一篇文章讲了多种接受参数的方法【快学springboot】3.多种接受参数的方式。因为目前json类型的参数是最常用的,所以这里只讲解json类型的参数校验。其他类型的大同小异。

    新建一个Param.java

    public class Param {
     
     private String username;
     public String getUsername() {
     return username;
     }
     public void setUsername(String username) {
     this.username = username;
     }
    }

    目前这个类只有一个username属性。

    使用Validated注解开启参数校验

    @PostMapping(value = "/validate/notblank")
    public Object validateNotBlank(@RequestBody @Validated Param param) {
     return param;
    }

    NotBlank 非空判断

    修改Param.java,在username属性上添加NotBlank注解

    @NotBlank
    private String username;

    测试

    通过控制台,我们可以看到抛出了一个MethodArgumentNotValidException异常,上面的返回结果其实是springboot默认的异常捕获器返回的。为了统一接口的数据返回格式,我们也需要自定义一个全局异常拦截器。

    我们还可以通过NotBlank注解的message属性设置异常信息:

    @NotBlank(message = "username不可为空")
    private String username;

    Length字符串长度判断

    还是那个Param.java,我们给username加上Length注解,如下:

    @NotBlank(message = "username不可为空")
    private String username;

    Length字符串长度判断

    还是那个Param.java,我们给username加上Length注解,如下:

    @Length(min = 2,max = 3)
    @NotBlank(message = "username不可为空")
    private String username;

     

    同样,我们也可以使用message属性来设置返回错误信息。这里就不演示了。

    NotNull 限制属性不可谓null

    虽然前面有NotBlank注解了,但是一些Integer,Long等包装类型,还是需要用到NotNull注解来判断。

    范围判断Min和Max

    在Param.java上新增一个age属性,并且使用Min和Max注解限定大小

    @Min(1)
    @Max(100)
    private Integer age;

    这样写的问题是,如果age为空,则不会校验。如下:

    所以我们还需要加上NotNull注解

    @Min(1)
    @Max(100)
    @NotNull
    private Integer age;

    也可使用@Range注解来限定范围

    @Range(min = 1, max = 100)

    Email 注解校验邮件

    @Email
    private String email;

    Pattern 注解校验正则表达式

    @Pattern(regexp = "\d{4}-\d{2}-\d{2}")
    private String birthday;

    总结

    以上总结了部分常用的参数校验的方法,当然还有很详细的一些没有列举处理,有需要的,可以自行搜索使用方式即可。参数校验,往往需要和全局的异常拦截器来配套使用,使得返回的数据结构永远是保持一致的,这样才能方便客户端解释。

     

    转载于:https://www.cnblogs.com/luchangjiang/p/10805893.html

    展开全文
  • 参数校验---validator

    千次阅读 2019-08-01 11:15:18
    开发过程中,后台的参数校验是必不可少的,所以经常会看到类似下面这样的代码 这样写并没有什么错,还挺工整的,只是看起来不是很优雅而已,太过冗余,所以参数校验营运而生 重要性 估计很多朋友都认为参数校验是...

    背景

    开发过程中,后台的参数校验是必不可少的,所以经常会看到类似下面这样的代码
    这样写并没有什么错,还挺工整的,只是看起来不是很优雅而已,太过冗余,所以参数校验营运而生
    在这里插入图片描述

    重要性

    估计很多朋友都认为参数校验是客户端的职责,不关服务端的事。其实这是错误的,学过 Web 安全的都知道,客户端的验证只是第一道关卡。它的参数验证并不是安全的,一旦被有心人抓到可乘之机,他就可以有各种方法来摸拟系统的 Http 请求,访问数据库的关键数据。轻则导致服务器宕机,重则泄露数据。所以,这时就需要设置第二道关卡,服务端验证了。

    最佳实践–springboot

    pom文件

    <!-- web 启动类 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- test 单元测试类 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- lombok 依赖用于简化 bean -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    

    实体类(领域模型)

    这里也很好的体现了领域模型

    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class Student {
    
        private Integer id;
    
        @NotBlank(message = "学生名字不能为空")
        @Length(min = 2, max = 10, message = "name 长度必须在 {min} - {max} 之间")
        private String name;
    
        @NotNull(message = "年龄不允许为空")
        @Min(value = 0, message = "年龄不能低于 {value} 岁")
        private Integer age;
    }
    

    Controller 层

    写了两个方法,一个用于校验普通参数,一个用于校验对象

    @Validated //开启数据校验,添加在类上用于校验方法,添加在方法参数中用于校验参数对象。(添加在方法上无效)
    @RestController
    @RequestMapping("/student")
    public class ValidateOneController {
    
        /**
         * 普通参数校验
         * @param name
         * @return
         */
        @GetMapping("/name")
        public String findStudentByName(@NotBlank(message = "学生名字不能为空")
        @Length(min = 2, max = 10, message = "name 长度必须在 {min} - {max} 之间")String name){
            return "success";
        }
    
        /**
         * 对象校验
         * @param student
         * @return
         */
        @PostMapping("/add")
        public String addStudent(@Validated @RequestBody Student student){
            return "success";
        }
    }
    

    类型对比

    1.使用lombok
    聊聊lombok构造模式的参数校验
    2.使用Bean Validation
    内置约束
    在这里插入图片描述
    3.使用Hibernate Validator
    Hibernate Validator 附加的约束:
    在这里插入图片描述
    4.使用Spring Validator

    参考文章

    SpringBoot 实战 (十五) | 服务端参数校验之一
    SpringMVC 参数校验最佳实践

    展开全文
  • 参数校验(一)——前端校验

    千次阅读 2018-08-10 19:10:13
    3.自定义校验方法 4.常见问题 4.1 更改error信息位置 4.2 级联校验 4.3 对checkbox、radio、select标签的验证 4.4 正则表达式 1.validate简介 ​ jQuery Validate 插件为表单提供了强大的验证功能,让...
  • 总结篇-后台参数验证的几种方式

    万次阅读 2018-08-05 17:16:49
    参数验证是一个常见的问题,无论是前端还是后台,都需对用户输入进行验证,以此来保证系统数据的正确性。对于web来说,有些人可能理所当然的想在前端验证就行了,但这样是非常错误的做法,前端代码对于用户来说是...
  • SpringBoot里参数校验/参数验证

    万次阅读 2019-05-08 13:47:56
    在控制器类的方法里自己写校验逻辑代码当然也可以,只是代码比较丑陋,有点“low”。业界有更好的处理方法,分别阐述如下。 2、PathVariable校验 @GetMapping("/path/{group:[a-zA-Z0-9_]+}/{userid}") @...
  • validation--参数校验(包括自定义注解)

    千次阅读 2019-03-06 17:20:05
    validation--参数校验 JSR提供的校验注解: @Null 被注释的元素必须为 null @NotNull 被注释的元素必须不为 null @AssertTrue 被注释的元素必须为 true @AssertFalse 被注释的元素必须为 false @Min(value) 被...
  • Java参数校验

    千次阅读 2019-01-28 19:30:29
    基本步骤 引入pom依赖 ...-- 参数校验 --&amp;amp;gt; &amp;amp;lt;!-- start --&amp;amp;gt; &amp;amp;lt;dependency&amp;amp;gt; &amp;amp;lt;groupId&amp;amp;gt
  • 在项目开发中,常常需要校验入参参数的合法性,是否为空,String类型字段内容是否大于限定长度等等。 二、解决方案思路: 这里建议使用hibernate的工具包,稍加封装即可实现 三、样例源码: package ...
  • SpringBoot Service层使用Validate注解做接口参数校验

    万次阅读 热门讨论 2020-03-14 11:01:11
    使用注解参数校验,可避免业务代码中无休止的参数校验判断,在分层的方面来说,参数校验都是在Controller层完成的,那么Spring MVC中,可直接添加Validate相关的参数校验注解,即可快速完成而无需其它额外的配置,...
  • 有些时候一个参数会在多个场景使用,不同场景对该参数的校验需求不同,即有些场景不对该参数进行校验。 ... 这里可以用到校验分组groups ... // 添加2个空接口,用例标记参数校验规则 /** * 注册校验规则 */
  • 关于springboot项目中,controller层对传递对象的校验,可以参照该文进行查看,点击打开链接http://www.cnblogs.com/myinspire/articles/7649027.html本文主要针对controller层中,对于单个参数校验:1、引入依赖&...
  • 1.restful风格接口参数校验 在接收参数的实体类的属性上添加默认的注解或者自定义注解 自定义参数校验注解方法 1>定义自定义注解 2>定义参数校验逻辑的处理类 ...
  • 在java程序中,校验传入的参数是否是正确,我现用的有2种方法: 1:是直接自定义抛出参数异常【IllegalArgumentException】 2:不抛出异常,把这个参数异常的计入日志直接return 哪种好些呢? 或者还有其他的...
  • 该示例项目使用SpringBoot,添加web和aop依赖。...而网上对校验单个参数,譬如String,int之类的资料极少,这一篇就是讲这个的。校验JavaBeanpackage com.example.bean;import org.hibernate.validator.con
  • java大量变量的非空校验

    千次阅读 2017-11-29 17:33:38
    开放接口开发,如果多个必传参数一起进行非空校验,如果某一个为空返回一个【参数为空】太笼统,调用接口的人只知道少参数,但是不知道具体哪个参数没传;如果一个一个校验,又多了很多重复代码; 这里写了一个工具...
  • hibernate-validator简介hibernate-validator是Hibernate项目中的一个数据校验框架,是Bean Validation 的参考实现,hibernate-validator除了提供了JSR 303规范中所有内置constraint 的实现,还有一些附加的...
  • springboot2.x使用validator 进行参数校验

    万次阅读 2019-03-20 17:37:44
    经常需要提供接口与用户交互(获取数据、上传数据等),由于这个过程需要用户进行相关的操作,为了避免出现一些错误的数据等,一般需要对数据进行校验,随着接口的增多,校验逻辑的冗余度也越来越大,虽然可以通过...
  • Spring-BeanValidation校验@RequestParam参数

    千次阅读 2017-10-27 18:07:16
    概述我们知道,Spring BeanValidation可以用来校验我们客户的提交的参数对应的Bean对象。但是在很多情况,我们的参数只有一个简单字符串或者是数字型参数(采用@RequestParam注解),要想使用SpringValidation还
1 2 3 4 5 ... 20
收藏数 304,651
精华内容 121,860
关键字:

参数校验