@Valid 无法校验List

原因：

@Valid只能校验JavaBean，而List不是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 {
    @Valid
    private List list;

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

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

}

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

    // 使用包装类对list进行验证
    @PostMapping("/insert/all")
    public ServerResponse insertList(@Valid @RequestBody ListWrapper 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自己返回的格式，所以我们需要做一个统一异常处理，代码如下：

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 handle(ConstraintViolationException exception) {
        log.error(String.valueOf(exception));
        Set> violations = exception.getConstraintViolations();
        StringBuilder builder = new StringBuilder();
        for (ConstraintViolation violation : violations) {
            builder.append(violation.getMessage());
            break;
        }
        return ServerResponse.createByErrorMessage(builder.toString());
    }

}

经过统一异常处理，我们这边的返回结果就是我们想要的格式了

 

方法3：自定义一个List

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

package com.wyq.firstdemo.util;


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

public class ValidList implements List {

    @Valid
    private List list;

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

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

    public List getList() {
        return list;
    }

    public void setList(List 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://stackoverflow.com/questions/28150405/validation-of-a-list-of-objects-in-spring/36313615#36313615