背景
在实际的项目开发中,当参数是List集合方式时,往往我们需要对List集合属性进行校验。
场景1
···
@PostMapping(“/preOrder”)
public Result doSomething(@RequestBody @Valid List list) throws Exception {
return orderService.doSomething(list);
}
···
如果是直接使用@Valid修饰这样的方式校验的话,经过测试,@Valid是无法发挥作用的。
场景2
···
@PostMapping(“/preOrder”)
public Result doSomething(@RequestBody @Valid OrderDTOList list) throws Exception {
return orderService.doSomething(list);
}
···
···
@Data public class OrderDTOList() {
@Valid private List orderDTOList;
}
···
这种情况是情况1的进阶,这样设计至少@Valid能够发挥作用了。但是太麻烦,需要专门写一个OrderDTOList类,简直不优雅。同时外接的JSON需要需要多套一层,如下:
···
{
“orderDTOList”:[
{
“userId”:“1”,
“productCode”:“A102”,
“num”:1
},
{
“userId”:“1”,
“productCode”:“A103”,
“num”:2
}
]
}
···
结果参数多一层"orderDTOList"对前端调用方来说也是麻烦。
类似场景1那样子设计行不通的原因是,java.util.List(ArrayList)内部通过持有一个数组来保存对象们,而作为Java官方的类,内部肯定不会在数组上声明@Valid,所以内部的对象们没有得到应有的递归校验。
所以,考虑使用一种新的java.util.List实现,来变相的达到列表校验的效果。
解决方案
···
/**
-
可被校验的List
-
@param 元素类型
*/
@Data
public class ValidList implements List {@Valid
private List 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 iterator() {
return list.iterator();
}@Override
public Object[] toArray() {
return list.toArray();
}@Override
public 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©;
}@Override
public boolean addAll(Collection<? extends E> c) {
return list.addAll©;
}@Override
public boolean addAll(int index, Collection<? extends E> c) {
return list.addAll(index, c);
}@Override
public boolean removeAll(Collection<?> c) {
return list.removeAll©;
}@Override
public boolean retainAll(Collection<?> c) {
return list.retainAll©;
}@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 listIterator() {
return list.listIterator();
}@Override
public ListIterator listIterator(int index) {
return list.listIterator(index);
}@Override
public List subList(int fromIndex, int toIndex) {
return list.subList(fromIndex, toIndex);
}
}
···
可以看到具有二象性,ValidList LIKE-A java.util.List,同时也是个holder,对外的方法全部会移交给持有的list处理。
也就是说,ValidList与java.util.List的对外功能完全一致。
对于Spring参数绑定来说,JSON转换后也能够绑定到ValidList对象上(就像能绑定到java.util.ArrayList对象上一样。)
实现了上述的效果后,直接在list上声明一个@Valid就解决所有问题了。
最终的方法定义方案
···
@PostMapping(“/preOrder”)
public Result doSomething(@RequestBody @Valid ValidList list) throws Exception {
return orderService.doSomething(list);
}
···
参数格式:
···
[{“userId”:“1”,“productCode”:“A102”,“num”:1},{“userId”:“1”,“productCode”:“A103”,“num”:2}]
···