SpringBoot参数校验的最佳实战教程

< dependency >

     < groupId >org.hibernate</ groupId >

     < artifactId >hibernate-validator</ artifactId >

     < version >6.0.17.Final</ version >

</ dependency >

< dependency >

     < groupId >javax.validation</ groupId >

     < artifactId >validation-api</ artifactId >

</ dependency >

@Data

public class Person {

     @NotBlank (message = "username must not be null" )

     private String username;

     @Min (value = 1 , message = "age must be >= 1" )

     @Max (value = 150 , message = "age must be < 150" )

     private Integer age;

}

/**

  * 对象验证器

  */

public Validator validator() {

     ValidatorFactory validatorFactory =

             Validation

                     .byProvider(HibernateValidator. class )

                     .configure()

                     // 验证属性时，如果有一个验证不通过就返回，不需要验证所有属性

                     .addProperty( "hibernate.validator.fail_fast" , "true" )

                     .buildValidatorFactory();

     return validatorFactory.getValidator();

}

@Test

public void test() throws Exception {

     Person person = new Person();

     Set<ConstraintViolation<Person>> validate = validator().validate(person);

     validate.forEach(errorParam -> {

         System.out.println(errorParam.getMessage());

     });

}

username must not be null

public interface ValidatorPattern {

     /**

      * 正则表达式：验证用户名

      * 1.长度在5-17

      * 2.由大写小写字母构成

      */

     String REGEX_USERNAME = "^[a-zA-Z]\w{5,17}$" ;

     /**

      * 正则表达式：验证密码

      * 密码只能为 6 - 12位数字，字母及常用符号组成。

      */

     String REGEX_PASSWORD = "^(?=.*[a-zA-Z])(?=.*[0-9])[A-Za-z0-9._~!@#$^&*]{6,12}$" ;

     /**

      * 正则表达式：验证手机号

      */

     String REGEX_MOBILE = "^[1][34578]\d{9}$" ;

     /**

      * 正则表达式：验证邮箱

      */

     String REGEX_EMAIL = "^.+@([a-z0-9A-Z]+(-[a-z0-9A-Z]+)?\.)+[a-zA-Z]{2,}$" ;

     /**

      * 正则表达式：验证汉字

      */

     String REGEX_CHINESE = "^[\u4e00-\u9fa5],*$" ;

     /**

      * 正则表达式：验证身份证

      */

     String REGEX_ID_CARD = "(^\d{18}$)|(^\d{15}$)" ;

     /**

      * 正则表达式：验证URL

      */

     String REGEX_URL = "http(s)?://([\w-]+\.)+[\w-]+(/[\w- ./?%&=]*)?" ;

     /**

      * 正则表达式：验证IP地址

      */

     String REGEX_IP_ADDR = "(25[0-5]|2[0-4]\d|[0-1]\d{2}|[1-9]?\d)" ;

     /**

      * 车牌号正则

      */

     String LICENSE_NO = "^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领A-Z][A-Z][A-Z0-9]{4,5}[A-Z0-9挂学警港澳]$" ;

     /**

      * 姓名校验

      * 1~15位

      * 姓名支持空格和中文的点

      */

     String NAME = "[\u4e00-\u9fa5\u00b7\sA-Za-z]{1,15}$" ;

     /**

      * 表情正则

      */

     String EMOJI = "[\ud83c\udc00-\ud83c\udfff]|[\ud83d\udc00-\ud83d\udfff]|[\u2600-\u27ff]" ;

     /**

      * 数字正则

      */

     String NUMBER = "^[0-9]*$" ;

     /**

      * n位的数字

      */

     String N_NUMS = "^\d{n}$" ;

}

@Bean

@Primary

public Validator validator() {

     ValidatorFactory validatorFactory =

             Validation

                     .byProvider(HibernateValidator. class )

                     .configure()

                     .addProperty( "hibernate.validator.fail_fast" , "true" )

                     .buildValidatorFactory();

     return validatorFactory.getValidator();

}

@Slf4j

@RestControllerAdvice

public class BaseExceptionHandler {

     /**

      * spring validation 自动校验的参数异常

      *

      * @param e BindException

      * @return R<Void>

      */

     @ResponseStatus (org.springframework.http.HttpStatus.PAYMENT_REQUIRED)

     @ExceptionHandler (BindException. class )

     public R<Void> handler(BindException e) {

         String defaultMsg = e.getBindingResult().getAllErrors()

                 .stream()

                 .map(ObjectError::getDefaultMessage)

                 .collect(Collectors.joining( ":" ));

         log.warn(defaultMsg);

         return R.of(IRespCode.PARAMETERS_ANOMALIES.getCode(), e.getMessage());

     }

}

@PostMapping ( "register" )

public R<Void> register( @Valid @RequestBody Person person) {

     // todo

     return R.ok();

}

public @interface Valid {

}

public @interface Validated {

     Class<?>[] value() default {};

}

public interface RegisterGroup {

}

@Data

public class Person {

     @NotBlank (message = "username must not be null" )

     private String username;

     @Min (value = 1 , message = "age must be >= 1" )

     @Max (value = 150 , message = "age must be < 150" )

     @NotNull (message = "age must not be null" , groups = RegisterGroup. class )

     private Integer age;

     @Email (message = "email format error" )

     @NotBlank (message = "email must not be null" ,groups = RegisterGroup. class )

     private String email;

}

@PostMapping ( "register" )

public R<Void> register( @Validated (value = RegisterGroup. class ) @RequestBody Person person) {

     // todo

     return R.ok();

}