Spring Boot ：使用 validation 验证参数
一、简介
开发 web 项目有时候我们需要对 controller 层传过来的参数进行一些基本的校验，比如非空，非 null，整数值的范围，字符串的个数，日期，邮箱等等。最常见的就是我们直接写代码校验，这样以后比较繁琐，而且不够灵活。
Bean Validation 1.0（JSR-303）是一个校验规范，在 Spring Boot 项目由于自带了 Hibernate validator 5(http://hibernate.org/validator/) 实现，所以我们可以非常方便的使用这个特性
二、关键使用
1、添加包
hibernate-validator
<!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator --> <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0.2.Final</version> </dependency>
或者添加 spring-boot-starter-validation
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> <version>1.4.0.RELEASE</version> </dependency>
或者添加 spring-boot-starter-web
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
2、注解说明JSR 提供的校验注解：
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
Hibernate Validator 提供的校验注解：
@NotBlank(message =) 验证字符串非 null，且 trim 后长度必须大于 0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内
@AssertFalse 校验 false
@AssertTrue 校验 true
@DecimalMax(value=,inclusive=) 小于等于 value，
inclusive=true, 是小于等于
@DecimalMin(value=,inclusive=) 与上类似
@Max(value=) 小于等于 value
@Min(value=) 大于等于 value
@NotNull 检查 Null
@Past 检查日期
@Pattern(regex=,flag=) 正则
@Size(min=, max=) 字符串，集合，map 限制大小
@Valid 对 po 实体类进行校验
三、代码示例
1、Controller 添加 @Valid 或者 @Validated 都可以
@RestController @RequestMapping("/") public class UserController {@RequestMapping(</span>"testValidation"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">public</span><span style="color: rgba(0, 0, 0, 1)"> String testValidation(@<span style="background-color: rgba(255, 0, 0, 1)">Valid</span> @RequestBody UserRequest userRequest) { </span><span style="color: rgba(0, 0, 255, 1)">return</span> "success"<span style="color: rgba(0, 0, 0, 1)">; }}
2、实体类添加校验注解
import java.io.Serializable; import javax.validation.constraints.Max; import javax.validation.constraints.Pattern; import org.hibernate.validator.constraints.Email; import org.hibernate.validator.constraints.Length; import org.hibernate.validator.constraints.NotEmpty; import org.hibernate.validator.constraints.Range; import lombok.Data;@Data
public class UserRequest implements Serializable{</span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">static</span> <span style="color: rgba(0, 0, 255, 1)">final</span> <span style="color: rgba(0, 0, 255, 1)">long</span> serialVersionUID = 1L<span style="color: rgba(0, 0, 0, 1)">; @NotEmpty(message</span>="用户id不能为空"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String userId; @Email(message</span>="非法邮件地址"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String email; @Pattern(regexp</span>="^(\\d{6})(\\d{4})(\\d{2})(\\d{2})(\\d{3})([0-9]|X)$",message="身份证号不合规"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String cardNo; @Length(min</span>=1,max=10,message="昵称长度必须在1~10"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String nickName; @Range(min</span>=0,max=2,message="非法性别"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">private</span><span style="color: rgba(0, 0, 0, 1)"> String sex; @Max(value</span>=100,message="非法年龄"<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">int</span><span style="color: rgba(0, 0, 0, 1)"> age;}
3、添加全局异常拦截
@Slf4j @RestControllerAdvice public class GlobalExceptionHandler {</span><span style="color: rgba(0, 128, 0, 1)">/**</span><span style="color: rgba(0, 128, 0, 1)"> * 参数合法性校验异常 * </span><span style="color: rgba(128, 128, 128, 1)">@param</span><span style="color: rgba(0, 128, 0, 1)"> exception * </span><span style="color: rgba(128, 128, 128, 1)">@return</span> <span style="color: rgba(0, 128, 0, 1)">*/</span><span style="color: rgba(0, 0, 0, 1)"> @ResponseBody @ExceptionHandler(MethodArgumentNotValidException.</span><span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">public</span><span style="color: rgba(0, 0, 0, 1)"> String validationBodyException(MethodArgumentNotValidException exception){ StringBuffer buffer </span>= <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> StringBuffer(); BindingResult result </span>=<span style="color: rgba(0, 0, 0, 1)"> exception.getBindingResult(); </span><span style="color: rgba(0, 0, 255, 1)">if</span><span style="color: rgba(0, 0, 0, 1)"> (result.hasErrors()) { List</span><ObjectError> errors =<span style="color: rgba(0, 0, 0, 1)"> result.getAllErrors(); errors.forEach(p </span>-><span style="color: rgba(0, 0, 0, 1)">{ FieldError fieldError </span>=<span style="color: rgba(0, 0, 0, 1)"> (FieldError) p; log.error(</span>"Data check failure : object{"+fieldError.getObjectName()+"},field{"+fieldError.getField()+ "},errorMessage{"+fieldError.getDefaultMessage()+"}"<span style="color: rgba(0, 0, 0, 1)">); buffer.append(fieldError.getDefaultMessage()).append(</span>","<span style="color: rgba(0, 0, 0, 1)">); }); } BaseResponse response </span>= <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> BaseResponse(BusinessCodeEnum.INVALID_PARAM); response.setRespMsg(buffer.toString().substring(</span>0, buffer.toString().length()-1<span style="color: rgba(0, 0, 0, 1)">)); </span><span style="color: rgba(0, 0, 255, 1)">return</span><span style="color: rgba(0, 0, 0, 1)"> JSONObject.toJSONString(response); }}
四、备注