@Validated和@Valid校驗引數、級聯屬性、List
技術標籤：springboot
@Validated和@Valid的區別
在Controller中校驗方法引數時，使用@Valid和@Validated並無特殊差異（若不需要分組校驗的話）: @Valid：標準JSR-303規範的標記型註解，用來標記驗證屬性和方法返回值，進行級聯和遞迴校驗 @Validated：Spring的註解，是標準JSR-303的一個變種（補充），提供了一個分組功能，可以在入參驗證時，根據不同的分組採用不同的驗證機制
方法級別： @Validated註解可以用於類級別，用於支援Spring進行方法級別的引數校驗。@Valid可以用在屬性級別約束，用來表示級聯校驗。 @Validated只能用在類、方法和引數上，而@Valid可用於方法、欄位、構造器和引數上
校驗引數、級聯屬性
1、校驗引數 當入參為實體物件時，需要在方法上加@Valid或@Validated或者在引數前加@Valid或@Validated，或者在類上加@Validated
@Valid @GetMapping("/exam-info") public Boolean getInfo(User user){......}
@GetMapping("/exam-info") public Boolean getInfo(@Valid User user){......}
@Validated @GetMapping("/exam-info") public Boolean getInfo(User user){......}
@GetMapping("/exam-info") public Boolean getInfo(@Validated User user){......}
public Class User{ @NotNull（"id不能為空"） private Integer id; }
2、巢狀驗證 @valid作用於屬性上有巢狀驗證作用，@validated不能作用於屬性上,如下程式碼在User類的屬性car上新增@valid註解，當傳參id為空時會報錯。
@GetMapping("/exam-info") public Boolean getInfo(@Valid User user){.....}
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類如下：
public class ListWrapper<E> {
@Valid
@NotEmpty(message="列表不能為空！", groups = {Creation.class, Modification.class})
private List<E> list;
public ListWrapper() {
list = new ArrayList<>();
}
public ListWrapper(List<E> list) {
this.list = list;
}
public setList(List<E> list){
this.list = list;
}
public getList(){
return 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：使用@[email protected]
在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 ValidationList<E> implements List<E> {
@Valid
@NotEmpty(message="列表不能為空！", groups = {Creation.class, Modification.class})
private List<E> list;
public ValidationList() {
this.list = new ArrayList<>();
}
@Override
public int size() {
return list.size();
}
@Override
public boolean isEmpty() {
return list.isEmpty();
}
@Override
public boolean contains(Object o) {
return list.contains(o);
}
@Override
public Iterator<E> iterator() {
return list.iterator();
}
@Override
public Object[] toArray() {
return list.toArray();
}
@Override
public <T> T[] toArray(T[] a) {
return list.toArray(a);
}
@Override
public boolean add(E e) {
return list.add(e);
}
@Override
public boolean remove(Object o) {
return list.remove(o);
}
@Override
public boolean containsAll(Collection<?> c) {
return list.containsAll(c);
}
@Override
public boolean addAll(Collection<? extends E> c) {
return list.addAll(c);
}
@Override
public boolean addAll(int index, Collection<? extends E> c) {
return list.addAll(index, c);
}
@Override
public boolean removeAll(Collection<?> c) {
return list.removeAll(c);
}
@Override
public boolean retainAll(Collection<?> c) {
return list.retainAll(c);
}
@Override
public void clear() {
list.clear();
}
@Override
public E get(int index) {
return list.get(index);
}
@Override
public E set(int index, E element) {
return list.set(index, element);
}
@Override
public void add(int index, E element) {
list.add(index, element);
}
@Override
public E remove(int index) {
return list.remove(index);
}
@Override
public int indexOf(Object o) {
return list.indexOf(o);
}
@Override
public int lastIndexOf(Object o) {
return list.lastIndexOf(o);
}
@Override
public ListIterator<E> listIterator() {
return list.listIterator();
}
@Override
public ListIterator<E> listIterator(int index) {
return list.listIterator(index);
}
@Override
public List<E> subList(int fromIndex, int toIndex) {
return list.subList(fromIndex, toIndex);
}
public List<E> getList() {
return list;
}
public void setList(List<E> list) {
this.list = list;
}
}
對比方法3和方法1，有沒有覺得程式碼有點相似，新建一個類，並且讓他實現List介面，使這個類即具有了JavaBean的特性，又具有了List的特性，比方法1簡單優雅很多。
只需要把List換成ValidList就可以了，還不需要多統一異常處理。
參考：https://my.oschina.net/fangshixiang/blog/3081366