springboot参数校验

柔光的暖阳◎ 2023-01-17 08:44 85阅读 0赞

# springboot 2.\* 参数校验 spring-boot-starter-validation/Hibernate Validator #

## 常用注解 ##

@AssertFalse 所注解的元素必须是Boolean类型，且值为false
    @AssertTrue 所注解的元素必须是Boolean类型，且值为true
    @DecimalMax 所注解的元素必须是数字，且值小于等于给定的值
    @DecimalMin 所注解的元素必须是数字，且值大于等于给定的值
    @Digits 所注解的元素必须是数字，且值必须是指定的位数
    @Future 所注解的元素必须是将来某个日期
    @Max 所注解的元素必须是数字，且值小于等于给定的值
    @Min 所注解的元素必须是数字，且值小于等于给定的值
    @Range 所注解的元素需在指定范围区间内
    @NotNull 所注解的元素值不能为null
    @NotBlank 所注解的元素值有内容
    @Null 所注解的元素值为null
    @Past 所注解的元素必须是某个过去的日期
    @PastOrPresent 所注解的元素必须是过去某个或现在日期
    @Pattern 所注解的元素必须满足给定的正则表达式
    @Size 所注解的元素必须是String、集合或数组，且长度大小需保证在给定范围之内
    @Email 所注解的元素需满足Email格式

## 一、添加依赖 ##

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

`这个starter依赖的是Hibernate Validator`。

## 二、实体类参数校验 ##

### （一）实体类上加上注解 ###

import lombok.Data;
    
    import javax.validation.constraints.*;
    import java.io.Serializable;
    
    @Data
    public class User implements Serializable { 
    
        private String id;
    
        @NotNull(message = "姓名不能为空")
        @Size(min = 1, max = 20, message = "姓名长度必须在1-20之间")
        private String name;
    
        @Min(value = 10, message = "年龄必须大于10")
        @Max(value = 150, message = "年龄必须小于150")
        private Integer age;
    
        @Email(message = "邮箱格式不正确")
        private String email;
    }

### （二）Controller中加上注解 ###

在controller中使用`@Valid`或者`@Validated` 注解校验

import com.chushiyan.validation_tutorial.entity.Result;
    import com.chushiyan.validation_tutorial.pojo.User;
    import org.springframework.web.bind.annotation.*;
    
    import javax.validation.Valid;
    
    @RestController
    @RequestMapping("/user")
    public class UserController  { 
    
        @PostMapping("test1")
        public Result test(@Valid  @RequestBody User user){ 
            System.out.println(user);
            return new Result(true,200,"");
        }
    }

### （三）测试 ###

使用postman发送POST请求：http://localhost:8080/user/test1

{
        "age":120,
        "email":"test"
    }

相应数据很多，这里就不贴了。

对相应数据统一处理

### （四）全局处理异常 ###

@RestControllerAdvice
    public class GlobalExceptionHandler { 
    
        @ExceptionHandler(MethodArgumentNotValidException.class)
        @ResponseStatus(HttpStatus.BAD_REQUEST)
        public Result handleBindGetException(MethodArgumentNotValidException e){ 
            Map<String, Object> body = new LinkedHashMap<>();
            body.put("timestamp", new Date());
    
            // 获取所有异常
            List<String> errors = e.getBindingResult()
                    .getFieldErrors()
                    .stream()
                    .map(x -> x.getDefaultMessage())
                    .collect(Collectors.toList());
            body.put("errors", errors);
            return new Result(false, 20001,  body);
        }
    }

**Result类**：

@Setter
    @Getter
    @NoArgsConstructor
    @AllArgsConstructor
    public class Result implements Serializable { 
        private static final long serialVersionUID = -8697997353211853641L;
    
        private Boolean isSuccess;
    
        private Integer MsgCode;
    
        private Object  data;
    }

**再次测试，得到结果如下**：

{
        "isSuccess": false,
        "data": {
            "timestamp": "2021-04-27T07:17:14.182+00:00",
            "errors": [
                "邮箱格式不正确",
                "姓名不能为空"
            ]
        },
        "msgCode": 20001
    }

## 三、单个参数校验 ##

@RestController
    @RequestMapping("/user")
    @Validated
    public class UserController  { 
        
        @GetMapping
        public Result test2(@NotNull(message = "name不能为空")  String name){ 
            System.out.println(name);
            return new Result(true,200,"");
        }
    }

### 添加全局处理函数 ###

@ExceptionHandler(ValidationException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Result handleBindException(ValidationException e){ 
        Map<String, Object> body = new LinkedHashMap<String, Object>();
        body.put("timestamp", new Date());
    
        // 获取所有异常
        List<String> errors = new LinkedList<>();
        if(e instanceof ConstraintViolationException){ 
            ConstraintViolationException exs = (ConstraintViolationException) e;
            Set<ConstraintViolation<?>> violations = exs.getConstraintViolations();
            for (ConstraintViolation<?> item : violations) { 
                errors.add(item.getMessage());
            }
        }
        body.put("errors", errors);
        return new Result(true, 20001, body);
    }

测试：

GET http://localhost:8080/user

结果：

{
        "isSuccess": true,
        "data": {
            "timestamp": "2021-04-27T07:32:51.965+00:00",
            "errors": [
                "name不能为空"
            ]
        },
        "msgCode": 20001
    }

## 四、参数校验分组 ##

在实际开发中经常会遇到这种情况：添加用户时，id是由后端生成的，不需要校验id是否为空，但是修改用户时就需要校验id是否为空。如果在接收参数的User实体类的id属性上添加NotNull，显然无法实现。这时候就可以定义分组，在需要校验id的时候校验，不需要的时候不校验。

### （一）定义表示组别的接口类 ###

public interface GroupA { 
    }

### （二）在实体类的注解中标记id使用上面定义的组 ###

给id属性添加分组(可以是多个组)：

@NotNull(groups = GroupA.class , message = "id 不能为空")
    private String id;

### （三）在controller中使用@Validated指定使用哪个组 ###

@PostMapping("/add")
    public Result add(@Validated @RequestBody User user) { 
        return new Result(true, 200, "增加用户成功");
    }
    
    @PutMapping
    // 指定GroupA，这样就会校验id属性是否为空
    // 注意：还得必须添加Default.class，否则不会执行其他的校验（如我们案例中的@Email）
    public Result update(@Validated({ GroupA.class, Default.class}) @RequestBody User user) { 
        return new Result(true, 200, "修改用户成功");
    }

## 重点 ##

区分开实体类校验，单个参数校验和组别校验，在定义全局异常处理时，针对不同异常进行捕获并处理。

[参考文章][Link 1]

[Link 1]: https://www.jianshu.com/p/24444f1d784e/