【无标题】

前提

平时日常开发时,需要对参数进行各种校验，会使用各种 if 条件进行判断，代码不够简洁，为了使代码简洁 且开发方便 ，引入 validation
传统校验方式

package com.example.validate.contorller;

import com.example.validate.vo.UserVO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

/**
 * @author lql
 */
@RestController
@Slf4j
public class TestController {

    @PostMapping("/test")
    public void test(@RequestBody  UserVO vo){
        if (vo.getAge()<0){
            log.error("xxxxx");
        }
        if (vo.getAge()>Integer.MAX_VALUE){
            log.error("xxxxx");
        }
        System.out.println("test");
    }
}

引入 validation 后， 就可以省略各种 if 了

package com.example.validate.contorller;

import com.example.validate.vo.UserVO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

/**
 * @author lql
 */
@RestController
@Slf4j
public class TestController {

    @PostMapping("/test")
    public void test(@RequestBody @Validated UserVO vo){
        System.out.println("test");
    }
}

引入依赖

当springboot版本 为2.1.x 及其以前的版本时 spring-boot-starter依赖中包含validation依赖， 无需引入下方依赖。
当版本为 2.2.x 及其以后版本时 需要引入下方的依赖。
注:版本号为大致版本号 ，具体springboot版本是否包含validation 可通过pom依赖树搜索 查看。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

有时 引入该依赖可能会下载失败，此时 引入下方依赖即可解决

   <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${vsersion}</version>
        </dependency>

了解 validation 相关注解

随便写个注解 ，点进去查看注解包下有哪些注解即可

JSR提供的校验注解：

注解名称 说明
@Null(message) 被注释的元素必须为 null
@NotNull(message) 被注释的元素必须不为 null
@AssertTrue(message) 被注释的元素必须为 true
@AssertFalse(message) 被注释的元素必须为 false
@Min(value,message) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value,message) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value,message) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value,message) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max, min,message) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction,message) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past(message) 被注释的元素必须是一个过去的日期
@Future(message) 被注释的元素必须是一个将来的日期
@Pattern(regex,flag,message) 被注释的元素必须符合指定的正则表达式

Hibernate Validator提供的校验注解：

@NotBlank(message ) 验证字符串非null，且trim后长度必须大于0
@Email(regexp,message) 被注释的元素必须是电子邮箱地址
@Length(min,max,message) 被注释的字符串的大小必须在指定的范围内
@NotEmpty(message) 被注释的字符串的必须非空
@Range(min,max,message) 被注释的元素必须在合适的范围内

后续变更

1、当参数为对象实体时

对象实体的字段需要增加 validation 相关注解 如： @Range 和 @NotBlank

package com.example.validate.vo;

import lombok.Data;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.NotBlank;

/**
 * @author lql
 * @version UserVO.java, v 0.1 2023年05月22日 17:12 lql
 */
@Data
public class UserVO {
    
    @Range(min = 10,max = 120,message = "年龄不符合")
    private int age;

    @NotBlank(message = "name不能为null 去除首部空格后也不能为空")
    private String name;
}

控制层处理

只需要在控制层 方法形参上 添加 @Validated 或@Valid 注解即可，
不加这两个注解，则不启动校验功能

package com.example.validate.contorller;

import com.example.validate.vo.UserVO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

/**
 * @author lql
 */
@RestController
@Slf4j
public class TestController {

    @PostMapping("/test")
    public void test(@RequestBody @Validated UserVO vo){
       log.info("test");
    }

    @PostMapping("/test2")
    public void test2(@RequestBody @Valid UserVO vo){
      log.info("test2");
    }
}

校验不通过时报的异常

后台报错信息， 报的是 MethodArgumentNotValidException 异常，后续做个全局异常处理即可

2023-05-23 15:04:25.935  WARN 11748 --- [nio-8001-exec-3] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved 
[org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public void 
com.example.validate.contorller.TestController.test2(com.example.validate.vo.UserVO): [Field error in object 'userVO' on 
field 'age': rejected value [0]; codes [Range.userVO.age,Range.age,Range.int,Range]; arguments 
[org.springframework.context.support.DefaultMessageSourceResolvable: codes [userVO.age,age]; arguments []; default 
message [age],120,10]; default message [年龄不符合]] ]

postman 报错提示

当参数为 @PathVariable 和 @RequestParam 形式时

@RestController
@Slf4j
public class Test2Controller {
    @GetMapping("/test")
    public void test(@RequestParam int id ){
        log.info("test 参数:{}",id);
    }

    @GetMapping("/test2/{id}")
    public void test2(@PathVariable int id ){
        log.info("test2 参数:{}",id);
    }
}

需要修改的地方

1、 在类上加 @Validated 注解 （不是加 @valid注解）
2、 在方法的形参上加 validation 相关的限制注解

import lombok.extern.slf4j.Slf4j;
import org.hibernate.validator.constraints.Range;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author lql
 */
@RestController
@Slf4j
@Validated
public class Test2Controller {
    @GetMapping("/test")
    public void test( @Range(min = 10,max = 120,message = "id不符合") @RequestParam    int id ){
        log.info("test 参数:{}",id);
    }

    @GetMapping("/test2/{id}")
    public void test2(@PathVariable @Range(min = 10,max = 120,message = "id不符合") int id ){
        log.info("test2 参数:{}",id);
    }
}

控制台报错信息

报的是 ConstraintViolationException 异常 ，要与MethodArgumentNotValidException 异常进行区分

2023-05-23 15:20:33.008 ERROR 2968 --- [nio-8001-exec-7] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is javax.validation.ConstraintViolationException: test2.id: id不符合] with root cause

javax.validation.ConstraintViolationException: test2.id: id不符合
	at org.springframework.validation.beanvalidation.MethodValidationInterceptor.invoke(MethodValidationInterceptor.java:120) ~[spring-context-5.3.23.jar:5.3.23]
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186) ~[spring-aop-5.3.23.jar:5.3.23]
	at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763) ~[spring-aop-5.3.23.jar:5.3.23]
	at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:708) ~[spring-aop-5.3.23.jar:5.3.23]
	at com.example.validate.contorller.Test2Controller$$EnhancerBySpringCGLIB$$9378e7e.test2(<generated>) ~[classes/:na]
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_261]
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_261]
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_261]
	at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_261]
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205) ~[spring-web-5.3.23.jar:5.3.23]

全局异常处理

可进一步优化

import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolationException;

/**
 * @author lql
 * @version GloabException.java, v 0.1 2023年05月23日 15:23 lql
 */
@RestControllerAdvice
public class GloabException  {

    @ExceptionHandler(value = ConstraintViolationException.class)
    @ResponseBody
    public String ExceptionErrorHandler(ConstraintViolationException e){
        return e.getMessage();
    }
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseBody
    public String ExceptionErrorHandler(MethodArgumentNotValidException  e){
        return e.getMessage();
    }

}

嵌套验证

@valid 与 @validated 区别