@Validated和@Valid校验参数、级联属性、List

@Validated和@Valid的区别

在Controller中校验方法参数时,使用@Valid和@Validated并没有特殊差别(若不须要分组校验的话): @Valid:标准JSR-303规范的标记型注解,用来标记验证属性和方法返回值,进行级联和递归校验 @Validated:Spring的注解,是标准JSR-303的一个变种(补充),提供了一个分组功能,能够在入参验证时,根据不一样的分组采用不一样的验证机制java

方法级别: @Validated注解能够用于类级别,用于支持Spring进行方法级别的参数校验。@Valid能够用在属性级别约束,用来表示级联校验。 @Validated只能用在类、方法和参数上,而@Valid可用于方法、字段、构造器和参数上web

校验参数、级联属性

一、校验参数 当入参为实体对象时,须要在方法上加@Valid或@Validated或者在参数前加@Valid或@Validated,或者在类上加@Validatedspring

@Valid @GetMapping("/exam-info") public Boolean getInfo(User user){......}app

@GetMapping("/exam-info") public Boolean getInfo(@Valid User user){......}ide

@Validated @GetMapping("/exam-info") public Boolean getInfo(User user){......}测试

@GetMapping("/exam-info") public Boolean getInfo(@Validated User user){......}ui

public Class User{ @NotNull("id不能为空") private Integer id; }this

二、嵌套验证      @valid做用于属性上有嵌套验证做用,@validated不能做用于属性上,以下代码在User类的属性car上添加@valid注解,当传参id为空时会报错。.net

@GetMapping("/exam-info") public Boolean getInfo(@Valid User user){.....}3d

public class User{ @Valid @NotNull("car不能为空") private Car car; } public class Car{ @NotNull("id不能为空") private Integer id; }

校验List

@Valid只能校验JavaBean,而List<E>不是JavaBean因此校验会失败,介绍三种解决办法

方法1:对List进行Wrapper

既然List不是JavaBean,那咱们就把它封装成JavaBean,咱们定义一个ListWrapper类以下:

import lombok.Getter; import lombok.Setter; import javax.validation.Valid; import java.util.ArrayList; import java.util.List;

@Setter @Getter public class ListWrapper<E> { @Valid private List<E> list;

public ListWrapper() {
    list = new ArrayList<>();
}

public  ListWrapper(List<E> list) {
    this.list = list;
}

} 同时修改一下controller对应的方法:

// 使用包装类对list进行验证
@PostMapping("/insert/all")
public ServerResponse<String> insertList(@Valid @RequestBody ListWrapper<UserEntity> listWrapper, BindingResult bindingResult) {
    if(bindingResult.hasErrors()) {
        log.error(bindingResult.getFieldError().toString());
        return ServerResponse.createByErrorMessage(bindingResult.getFieldError().getDefaultMessage());
    }

    userService.insertList(listWrapper.getList());
    return ServerResponse.createBySuccess();
}

这样就能够对list进行校验了

注意:

因为对list进行了包装,若是咱们传参的时候

[{},{}..]要改成{“list”: [{},{}..]}

方法2:使用@Validated+@Valid

在controller类上面增长@Validated注解,而且删除方法参数中的BindingResult bindingResult(由于这个参数已经没有用了,异常统一有controller返回了) file file

而后咱们运行一下测试一下 file

能够看到能够对参数进行校验了,但还还有一个问题,那就是这个不是咱们想要的返回格式,它controller本身返回的格式,因此咱们须要作一个统一异常处理,代码以下:

import com.wyq.firstdemo.common.ServerResponse; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation; import javax.validation.ConstraintViolationException; import java.util.Set;

@Slf4j @RestControllerAdvice public class ControllerExceptionHandler {

@ExceptionHandler
@ResponseBody
public ServerResponse<String> handle(ConstraintViolationException exception) {
    log.error(String.valueOf(exception));
    Set<ConstraintViolation<?>> violations = exception.getConstraintViolations();
    StringBuilder builder = new StringBuilder();
    for (ConstraintViolation violation : violations) {
        builder.append(violation.getMessage());
        break;
    }
    return ServerResponse.createByErrorMessage(builder.toString());
}

} 通过统一异常处理,咱们这边的返回结果就是咱们想要的格式了 file

方法3:自定义一个List

先上代码后说明,先定义一个ValidList

import javax.validation.Valid; import java.util.*;

public class ValidList<E> implements List<E> {

@Valid
private List<E> list;

public ValidList() {
    this.list = new ArrayList<>();
}

public ValidList(List<E> list) {
    this.list = list;
}

public List<E> getList() {
    return list;
}

public void setList(List<E> list) {
    this.list = list;
}

@Override
public int size() {
    return list.size();
}

@Override
public boolean isEmpty() {
    return list.isEmpty();
}

...

} 对比方法3和方法1,有没有以为代码有点类似,新建一个类,而且让他实现List接口,使这个类即具备了JavaBean的特性,又具备了List的特性,比方法1简单优雅不少。

只须要把List换成ValidList就能够了,还不须要多统一异常处理。 file

参考:https://my.oschina.net/fangshixiang/blog/3081366 https://stackoverflow.com/questions/28150405/validation-of-a-list-of-objects-in-spring/36313615#36313615 https://my.oschina.net/fangshixiang/blog/3081366

本文由博客一文多发平台 OpenWrite 发布!

相关文章
相关标签/搜索