@Valid 無法校驗List<E>的問題
更新時間：2021年10月20日 11:03:02 作者：MiracleWei777
這篇文章主要介紹了@Valid 無法校驗List<E>的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
@Valid 無法校驗List<E>
原因
@Valid只能校驗JavaBean，而List<E>不是JavaBean所以校驗會失敗，嘗試了三種解決辦法，比較推薦方法3，其他兩種大家也可以學習一下。
方法
方法1：對List進行Wrapper
既然List不是JavaBean，那我們就把它封裝成JavaBean，我們定義一個ListWrapper類如下：
package com.wyq.firstdemo.util;
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進行了包裝，如果我們傳參的時候
[{},{}..]要改為{“l(fā)ist”: [{},{}..]}
方法2：使用@Validated+@Valid
在controller類上面增加@Validated注解，并且刪除方法參數中的BindingResult bindingResult（因為這個參數已經沒有用了，異常統(tǒng)一有controller返回了）
然后我們運行一下測試一下
可以看到可以對參數進行校驗了，但還還有一個問題，那就是這個不是我們想要的返回格式，它controller自己返回的格式，所以我們需要做一個統(tǒng)一異常處理，代碼如下：
package com.wyq.firstdemo.handler;
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());
}
}
經過統(tǒng)一異常處理，我們這邊的返回結果就是我們想要的格式了
方法3：自定義一個List
先上代碼后說明，先定義一個ValidList
package com.wyq.firstdemo.util;
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簡單優(yōu)雅很多。
只需要把List換成ValidList就可以了，還不需要多統(tǒng)一異常處理。
@validated 驗證List
經常遇到一些參數需要驗證，用@validated 的分組驗證方式很棒，可以解決大量的冗余代碼，提升美觀性。
但是我們平時會遇到入參為list的校驗，@validated 的分組驗證就無法使用了，非常麻煩，各大搜索引擎一查，總結一下比較推薦的方法：
反面例子
@***Mapping("/**")
public *** apiName(@RequestBody @Validated(Add.class) List<AClass> aObject)
正常情況下這個例子是無法使用的，不是接口無法使用，是@Validated無效。這是因為你的入參實體是List，其內并沒有調用AClass的@Valid，導致你的校驗規(guī)則只校驗的List本身，并不校驗其內部實體。
解決方法
在項目里添加一個ValidList類即可，此類通用，可以在全部由此需求的項目（jdk1.8）中添加，無需改動，有ValidList類之后只要將接口方法參數中的List改成ValidList即可：
@***Mapping("/**")
public *** apiName(@RequestBody @Validated(Add.class) ValidList<Bean> aObject)
上代碼：
注意這個構造方法，網上的例子就少一點東西，會讓你很難用，我優(yōu)化了一下。
package com.analog.greatbolderserver.config.valid;
import lombok.Data;
import lombok.NoArgsConstructor;
import javax.validation.Valid;
import java.util.*;
/**
* @ClassName ValidList
* @Description ValidList
* @Author TY
* @Date 2020/8/26 16:05
* @Version 1.0
**/
@Data
@NoArgsConstructor
public class ValidList<E> implements List<E> {
@Valid
private List<E> list = new LinkedList<>();
public ValidList(List<E> paramList) {
this.list = paramList;
}
@Override
public int size() {
return list.size();
}
@Override
public boolean isEmpty() {
return list.isEmpty();
}
@Override
public boolean contains(Object o) {
return list.contains(0);
}
@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);
}
}
這樣前端的代碼是不需要任何改動的！
這個時候有小伙伴說，需要捕獲異常，是的，@Validated是通過拋出異常來進行返回的。
上代碼，全局異常處理：
/**
* @ClassName GlobalException
* @Description 異常處理攔截器
* @Author TY
* @Date 13:59$ 2019-01-30$
* @Version 1.0
**/
@RestControllerAdvice
public class GlobalException {
private Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* 參數為空異常處理
*
* @param ex ex
* @return ReturnResult
*/
@ExceptionHandler({
ParamNullException.class, MethodArgumentNotValidException.class,
ConstraintViolationException.class, HttpMessageNotReadableException.class,
MissingServletRequestParameterException.class
})
public ReturnResult<?> requestMissingServletRequest(Exception ex) {
ReturnResult<?> returnResult = new ReturnResult<>();
returnResult.setRetCode(2);
if (ex instanceof MissingServletRequestParameterException) {
returnResult.setRetMsg("參數非法:" + ((MissingServletRequestParameterException) ex).getParameterName());
} else if (ex instanceof HttpMessageNotReadableException) {
//排除入參問題
returnResult.setRetMsg("參數非法:" + ex.getMessage());
} else if (ex instanceof MethodArgumentNotValidException) {
//排除入參問題
FieldError error = (FieldError) ((MethodArgumentNotValidException) ex).getBindingResult().getAllErrors().get(0);
returnResult.setRetMsg("參數非法:" + error.getField() + " " + error.getDefaultMessage());
} else if (ex instanceof ConstraintViolationException) {
//排除入參問題
ConstraintViolation<?> violation = ((ConstraintViolationException) ex).getConstraintViolations().iterator().next();
returnResult.setRetMsg("參數非法:" + violation.getPropertyPath().toString().split("[.]")[1]
+ violation.getMessage());
}
return returnResult;
}
/**
* 其他異常
*
* @param request request
* @param ex ex
* @return ReturnResult
*/
@ExceptionHandler(Exception.class)
public ReturnResult<?> resolveException(HttpServletRequest request, Exception ex) {
ReturnResult<?> returnResult = new ReturnResult<>();
logger.error("==============異常開始=============");
logger.error("url: " + request.getRequestURL() + " msg: " + ex.getMessage());
ex.printStackTrace();
logger.info("==============異常結束=============");
returnResult.setRetCode(1);
returnResult.setRetMsg("GlobalException!!!");
returnResult.setRetData(ex.toString());
return returnResult;
}
}
ReturnResult是自己定一的方法返回封裝類，根據自己的項目自己封裝就行。
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了Java局部內部類原理與用法,結合實例形式分析了Java局部內部類功能、用法及相關操作注意事項,需要的朋友可以參考下2019-09-09
在本篇文章里小編給大家整理的是關于SpringBoot配置https實操方法以及相關知識點，需要的朋友們參考下。2019-11-11
這篇文章主要介紹了mybatis中sql語句CDATA標簽的用法說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-06-06
這篇文章主要介紹了java對double數組排序示例，代碼簡單，下面我們直接上代碼,需要的朋友可以參考下2014-03-03
這篇文章主要介紹了spring boot自定義配置源操作步驟,需要的朋友可以參考下2017-10-10
Springboot JPA 枚舉Enum類型存入到數據庫的操作
這篇文章主要介紹了Springboot JPA 枚舉Enum類型存入到數據庫的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-01-01
這篇文章主要介紹了java:提示程序包org.junit不存在時的解決方案,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11
本文主要介紹了Maven倉庫分類的優(yōu)先級，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-04-04
這篇文章主要介紹了java中的插入排序，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-08-08
這篇文章介紹了Java連接數據庫的步驟，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-04-04