参数校验和异常处理也是后台代码中很重要的一部分，如果每次都自己写代码做校验就会很繁琐，所以spring框架中也提供了validation组件来直接做参数校验，本文就是讲述validation组件的一些常见的用法，以及顺便讲一下如何全局的处理异常。
- 首先依然是先要在build.gradle的dependencies中添加依赖包
implementation "org.springframework.boot:spring-boot-starter-validation"
- 接着只要直接在java bean中配置参数条件就可以了，例如我们给teacher的几个属性加一些条件
@Size(max=4, min=2, message="老师姓名应为2-4字")
private String name;
@NotNull(message="老师性别不能为空")
@Min(value = 0, message = "性别值只能为0或1，0:女，1:男")
@Max(value = 1, message = "性别值只能为0或1，0:女，1:男")
private Integer gender;
@NotNull(message="老师年龄不能为空")
@Min(value = 20, message = "老师年龄不能小于20")
@Max(value = 70, message = "老师年龄不能大于70")
这里的注解约束还有很多其他的，具体可以参考SpringBoot使用Validation校验参数中的说明。也可以查看Hibernate Validator的官方文档，里面有更详细的说明，还有一些不是很常见的特殊的注解约束。
- 然后就可以在controller接口的参数前加上需要校验的注解，注解有两种，一个是@Valid，一个是@Validated，这两个大部分情况使用是一样的。例如，这样加上：
@PostMapping(value = "/addTeacher", consumes = { "application/x-www-form-urlencoded" })
@ResponseBody
public ResponseData addTeacher(@Validated Teacher teacher)
{
if(teacher.getFile() != null){
String fileName = FileUtil.upload(teacher.getFile(), path, teacher.getFile().getOriginalFilename());
if ( fileName!= null){
teacher.setImageUrl(fileName);
}
}
teacherMapper.insertTeacher(teacher);
ResponseData responseData = ResponseData.ok();
return responseData;
}
然后我们来运行试试
可以看到返回了默认格式的错误信息的json字符串。
但是由于这个信息格式是默认的，和我们自己定义的不一样，前端可能就无法辨认，这时就有两个方法可以处理：
第一个方法是使用BindingResult，我们可以用BindingResult接收验证的结果，如果错误，再按我们自己定义的格式返回错误信息。
@PostMapping(value = "/addTeacher", consumes = { "application/x-www-form-urlencoded" })
@ResponseBody
public ResponseData addTeacher(@Validated Teacher teacher, BindingResult bindingResult)
{
if (bindingResult.hasErrors()) {
ResponseData responseData = new ResponseData(400, bindingResult.getFieldError().getDefaultMessage());
return responseData;
}
if(teacher.getFile() != null){
String fileName = FileUtil.upload(teacher.getFile(), path, teacher.getFile().getOriginalFilename());
if ( fileName!= null){
teacher.setImageUrl(fileName);
}
}
teacherMapper.insertTeacher(teacher);
ResponseData responseData = ResponseData.ok();
return responseData;
}
结果就会变成这样
第二个方法则就要引入本文的第二个课题了，就是全局的处理异常。因为如果每个校验的异常都要这样写的话，那也是非常麻烦了。所以Spring也提供了非常方便的全局异常的注解，就是@RestControllerAdvice和@ExceptionHandler。我们就可以构建如下的全局异常处理的类：
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
* 处理Validated校验异常
* <p>
* 注: 常见的ConstraintViolationException异常， 也属于ValidationException异常
*
* @param e
* 捕获到的异常
* @return 返回给前端的data
*/
@ResponseStatus(code = HttpStatus.BAD_REQUEST)
@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ResponseData handleParameterVerificationException(Exception e) {
String msg = null;
/// BindException
if (e instanceof BindException) {
// getFieldError获取的是第一个不合法的参数(P.S.如果有多个参数不合法的话)
FieldError fieldError = ((BindException) e).getFieldError();
if (fieldError != null) {
msg = fieldError.getDefaultMessage();
}
/// MethodArgumentNotValidException
} else if (e instanceof MethodArgumentNotValidException) {
BindingResult bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
// getFieldError获取的是第一个不合法的参数(P.S.如果有多个参数不合法的话)
FieldError fieldError = bindingResult.getFieldError();
if (fieldError != null) {
msg = fieldError.getDefaultMessage();
}
/// ValidationException 的子类异常ConstraintViolationException
} else if (e instanceof ConstraintViolationException) {
/*
* ConstraintViolationException的e.getMessage()形如
* {方法名}.{参数名}: {message}
* 这里只需要取后面的message即可
*/
msg = e.getMessage();
if (msg != null) {
int lastIndex = msg.lastIndexOf(':');
if (lastIndex >= 0) {
msg = msg.substring(lastIndex + 1).trim();
}
}
/// ValidationException 的其它子类异常
} else {
msg = "处理参数时异常";
}
ResponseData responseData = new ResponseData(400, msg);
return responseData;
}
@ExceptionHandler
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ResponseData handleException(Exception ex){
if (ex instanceof DataIntegrityViolationException) { // 数据库操作异常
if(ex.toString().contains("a foreign key constraint fails")){ //外键关联问题，具体前端可以根据发送的请求判断
return new ResponseData(5001, "a foreign key constraint fails");
}
}
return new ResponseData(500, "Internal Server Error");
}
}
这里我写了两个方法，一个是专门处理参数校验异常的，我把它定义为BadRequest一类的返回，我主要考虑了三种参数异常的捕获，例如前面的结果，就是BindException，在未加BindResult的处理之前，我们可以从控制台打印的日志看出。
其实这个就是当参数为Java bean且传参方式为RequestParam就是直接在url地址上传参的方式时校验会返回的异常。
而第二种MethodArgumentNotValidException则是同样参数为Java bean但是传参方式为@RequestBody且applicationType为application/json的时候校验会返回的异常，我们可以试一下
而第三种ConstraintViolationException呢，则是参数为普通类型的直接在参数前加校验条件的异常返回类型。例如在findSubjects的参数上加上校验
@GetMapping(value = "/subjects")
public ResponseDataNew<ListWithPageData<Subject>> findSubjects(final String name, @Min(value = 0, message = "页码不能小于0")final Integer index, final Integer size){
Page<Subject> page = PageHelper.startPage(index + 1, size);
List<Subject> subjectList = subjectMapper.findSubjects(name);
ResponseDataNew<ListWithPageData<Subject>> response = new ResponseDataNew<>();
response.ok();
ListWithPageData<Subject> data = new ListWithPageData<>();
data.setPageCount(page.getPages());
data.setTotal(page.getTotal());
data.setList(subjectList);
response.setData(data);
return response;
}
这里还涉及到@Validated的另一个用法，就是加在类上的注解，只有这样
@RestController
@RequestMapping(value = "/subject")
@Validated
public class SubjectController {
...
}
直接加在参数前的校验注解才会有用。传入index为-1时就会抛出这个异常
另外我还写了一个方法用来捕获其他类型的异常，比如这个外键关联的异常。@ExceptionHandler这个注解就是可以指定捕获的Exception的类型，如果没有指定，那么就会捕获任意类型。
此外，@Validated还支持分组，比如当我们新建一条数据时，id是必然为空的，而更新数据时，id又必须不为空，这时就可以用到这个。
（1）首先，我们在entity包中分别建两个接口Insert和Update
public interface Insert extends Default {
}
public interface Update extends Default {
}
（2）接着，以Subject为例，需要在id上加两组注解
@Schema(example = "1")
@Null(groups = {Insert.class})
@NotNull(groups = {Update.class}, message="id不能为空")
private Long id;
（3）分别在新增和更新的接口上加上对应的注解，如下
@PostMapping(value = "/addSubject", consumes = { "application/x-www-form-urlencoded" })
public ResponseData addSubject(@Validated(value = Insert.class) Subject subject){
subjectMapper.insertSubject(subject.getName());
ResponseData responseData = ResponseData.ok();
return responseData;
}
@PostMapping(value = "/editSubject", consumes = { "application/x-www-form-urlencoded" })
public ResponseData editSubject(@Validated(value = Update.class) Subject subject)
{
subjectMapper.updateSubject(subject.getId(), subject.getName());
ResponseData responseData = ResponseData.ok();
return responseData;
}
但是这样加完会有个问题，就是在swagger上，我们会发现addSubject的接口id的参数仍然是required的，这似乎是一个bug。而用Postman测试，结果则是正常的
不过，我也试了一下，如果把传参方式改为@RequestBody就是application/json的话也可以解决这个问题。
需要注意的是@Valid是不支持这样分组的，这是这两个注解其中一个差异。
@Validated和@Valid还有一个差异在于@Valid支持嵌套校验、而@Validated不支持。这是什么意思呢？比如我需要做一个批量新增的功能，所以我传参的时候会传一个list，就像这样
@PostMapping(value = "/addSubjects")
public ResponseData addSubjects(@Validated(value = Insert.class) @RequestBody List<Subject> subjects){
subjectMapper.insertSubjects(subjects);
ResponseData responseData = ResponseData.ok();
return responseData;
}
但是这时候我们加的这个@Validated的注解会发现是不起作用的，就是因为它不支持嵌套，而要验证的对象包在List中。这时我们只能把它改为@Valid，分组也就没办法使用了。还要注意的是同样要在SubjectController类上加了@Validated注解才有用。
不过也还有一种方法可以同时解决这两个问题，就是自定义实现一个List ValidatedList，这个方法的话可以参考使用@Validated校验List接口参数的两种方式这篇博客。
最后再说一下的是，validation还支持自定义的校验，这个也可以参考SpringBoot使用Validation校验参数这篇博客，我这里也就不再详细说明了。
代码依旧可以参考我在github上面的代码https://github.com/ahuadoreen/studentmanager。
参考文档
SpringBoot使用Validation校验参数
Spring 参数校验的异常处理
使用@Validated校验List接口参数的两种方式
