学习SpringBootValidation

  使用 spring boot validation 很简单😁, 如下几步就OK.

1 依赖

  在 pom.xml 中引入如下依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2 给请求参数所在的类加注解

  比如下面的 @NotNull 就是 javax.validation 下的一系列注解之一, 表示字段不能为空. 我们可以通过 message 来设置错误提示信息.

import lombok.Data;
import javax.validation.constraints.NotNull;
import java.util.Map;

@Data
public class StartProcessInstanceReq {
    @NotNull(message = "流程定义key不能为空")
    private String processDefinitionKey;
    @NotNull
    private String businessKey;
    @NotNull
    private String name;
    private Map<String, Object> variables;
}

3 请求参数有多层的话, 如何加注解?

  如下代码, DynamicFormDataSaveReq 里面有个 List, 如果我们既想要校验DynamicFormDataSaveReq 本身的字段, 也想要校验 FieldReq 里面的字段, 那么需要‼️注意‼️的是 DynamicFormDataSaveReq 的 fieldDataList 字段加上 @Valid 注解. 否则, 到时候请求 Controller 的时候, 你会发现, 只校验了 DynamicFormDataSaveReq 的字段, 而没有校验 FieldReq 的字段

@Data
public class DynamicFormDataSaveReq {
    @NotNull(message = "activiti流程定义ID processDefinitionId 不能为空")
    private String processDefinitionId;
    @NotNull(message = "activiti流程实例ID processInstanceId 不能为空")
    private String processInstanceId;
    @NotNull(message = "activiti任务ID taskId 不能为空")
    private String taskId;
    // 多层校验, 下面这个 @Valid 是必须的
    @Valid
    @NotEmpty(message = "动态表单 字段数据 的集合 fieldDataList 不能为空")
    private List<FieldReq> fieldDataList;
}

@Data
public class FieldReq {
    @NotNull(message = "字段中文名 fieldNameZh 不能为空")
    private String fieldNameZh;
    @NotNull(message = "字段英文名 fieldNameEn 不能为空")
    private String fieldNameEn;
    @NotNull(message = "字段类型 fieldType 不能为空")
    private FieldTypeEnum fieldType;
    private String defaultValue;
    @NotNull(message = "字段的值 value 不能为空")
    private String value;
}

4 Controller 加 @Valid 注解

  如下代码所示, 重点是给请求参数前面加了 @Valid 注解.

import lombok.RequiredArgsConstructor;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

@RestController
@RequiredArgsConstructor
@RequestMapping(path = "/process-instance", produces = MediaType.APPLICATION_JSON_VALUE)
public class ProcessInstanceController {
    private final ProcessInstanceService processInstanceService;

    @PostMapping("/start")
    public JsonResult<ProcessInstanceResp> startProcessInstance(@Valid @RequestBody StartProcessInstanceReq req) {
        return processInstanceService.startProcessInstance(req);
    }
}

5 处理异常

  如下代码所示, spring boot validation 校验出来的异常, 其类型是 BindException , 错误信息从这个异常里面获取就行. 需要‼️注意‼️的是, 从 BindException 里面获取异常信息, 不能简单地通过 e.getMessage() 获得, 而是需要 强制类型转换 一下, 然后再获取.

import lombok.extern.slf4j.Slf4j;
import lombok.val;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@Slf4j
@RestControllerAdvice
public class MyControllerAdvice {

    /**
     * 处理任何异常
     *
     * @param e 任何异常, 包括受检异常和运行时异常
     * @return json 结构的错误信息
     */
    @ExceptionHandler(value = Exception.class)
    public JsonResult<?> dealAnyException(Exception e) {
        if (e instanceof BindException) {
            // 处理校验失败
            val bindException = (BindException) e;
            val msg = bindException.getBindingResult().getAllErrors().get(0).getDefaultMessage();
            log.warn("参数校验失败: {}", msg);
            return JsonResult.fail(CommonCodeEnum.VALIDATION_FAIL, msg);
        } else {
            // 其他异常
            log.warn("其他异常: {}", e.getMessage());
            e.printStackTrace();
            return JsonResult.fail(e.getMessage());
        }
    }
}