@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返回了）

而後咱們運行一下測試一下

能夠看到能夠對參數進行校驗了，但還還有一個問題，那就是這個不是咱們想要的返回格式，它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());
}

} 通過統一異常處理，咱們這邊的返回結果就是咱們想要的格式了

方法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就能夠了，還不須要多統一異常處理。

參考：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