springboot整合JSR303校验

4.7 JSR303校验

4.7.1 统一校验的需求

前端请求后端接口传输参数是在controller中校验还是在Service中校验

答案是都需要校验只是分工不同。

Contoller中校验请求参数的合法性包括必填项校验数据格式校验比如是否是符合一定的日期格式等。

Service中要校验的是业务规则相关的内容比如课程已经审核通过所以提交失败。

Service中根据业务规则去校验不方便写成通用代码Controller中则可以将校验的代码写成通用代码。

早在JavaEE6规范中就定义了参数校验的规范它就是JSR-303它定义了Bean Validation即对bean属性进行校验。

SpringBoot提供了JSR-303的支持它就是spring-boot-starter-validation它的底层使用Hibernate ValidatorHibernate Validator是Bean Validation 的参考实现。

所以我们准备在Controller层使用spring-boot-starter-validation完成对请求参数的基本合法性进行校验。

4.7.2 统一校验实现

首先在Base工程添加spring-boot-starter-validation的依赖

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

现在准备对内容管理模块添加课程接口进行参数校验如下接口

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody AddCourseDto addCourseDto){
    //机构id由于认证系统没有上线暂时硬编码
    Long companyId = 1L;
  return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

此接口使用AddCourseDto模型对象接收参数所以进入AddCourseDto类在属性上添加校验规则。

package com.xuecheng.content.model.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Size;
import java.math.BigDecimal;

/**
 * @description 添加课程dto
 * @author Mr.M
 * @date 2022/9/7 17:40
 * @version 1.0
 */
@Data
@ApiModel(value="AddCourseDto", description="新增课程基本信息")
public class AddCourseDto {

 @NotEmpty(message = "课程名称不能为空")
 @ApiModelProperty(value = "课程名称", required = true)
 private String name;

 @NotEmpty(message = "适用人群不能为空")
 @Size(message = "适用人群内容过少",min = 10)
 @ApiModelProperty(value = "适用人群", required = true)
 private String users;

 @ApiModelProperty(value = "课程标签")
 private String tags;

 @NotEmpty(message = "课程分类不能为空")
 @ApiModelProperty(value = "大分类", required = true)
 private String mt;

 @NotEmpty(message = "课程分类不能为空")
 @ApiModelProperty(value = "小分类", required = true)
 private String st;

 @NotEmpty(message = "课程等级不能为空")
 @ApiModelProperty(value = "课程等级", required = true)
 private String grade;

 @ApiModelProperty(value = "教学模式普通录播直播等", required = true)
 private String teachmode;

 @ApiModelProperty(value = "课程介绍")
 private String description;

 @ApiModelProperty(value = "课程图片", required = true)
 private String pic;

 @NotEmpty(message = "收费规则不能为空")
 @ApiModelProperty(value = "收费规则对应数据字典", required = true)
 private String charge;

 @ApiModelProperty(value = "价格")
 private BigDecimal price;

}

上边用到了@NotEmpty和@Size两个注解@NotEmpty表示属性不能为空@Size表示限制属性内容的长短。

在javax.validation.constraints包下有很多这样的校验注解

规则如下

定义好校验规则还需要开启校验在controller方法中添加@Validated注解如下

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated AddCourseDto addCourseDto){
    //机构id由于认证系统没有上线暂时硬编码
    Long companyId = 1L;
  return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

如果校验出错Spring会抛出MethodArgumentNotValidException异常我们需要在统一异常处理器中捕获异常解析出异常信息。

代码 如下

@ResponseBody
@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public RestErrorResponse doValidException(MethodArgumentNotValidException argumentNotValidException) {

   BindingResult bindingResult = argumentNotValidException.getBindingResult();
   StringBuffer errMsg = new StringBuffer();

   List<FieldError> fieldErrors = bindingResult.getFieldErrors();
   fieldErrors.forEach(error -> {
      errMsg.append(error.getDefaultMessage()).append(",");
   });
   log.error(errMsg.toString());
   return new RestErrorResponse(errMsg.toString());
}

重启内容管理服务。

使用httpclient进行测试将必填项设置为空“适用人群” 属性的内容设置1个字。

执行测试接口响应结果如下

{
  "errMessage": "课程名称不能为空 课程分类不能为空 课程分类不能为空 适用人群内容过少 "
}

可以看到校验器生效。

4.7.3 分组校验

有时候在同一个属性上设置一个校验规则不能满足要求比如订单编号由系统生成在添加订单时要求订单编号为空在更新 订单时要求订单编写不能为空。此时就用到了分组校验同一个属性定义多个校验规则属于不同的分组比如添加订单定义@NULL规则属于insert分组更新订单定义@NotEmpty规则属于update分组insert和update是分组的名称是可以修改的。

下边举例说明

我们用class类型来表示不同的分组所以我们定义不同的接口类型空接口表示不同的分组由于校验分组是公用的所以定义在 base工程中。如下

package com.xuecheng.base.execption;
 /**
 * @description 校验分组
 * @author Mr.M
 * @date 2022/9/8 15:05
 * @version 1.0
 */
public class ValidationGroups {

 public interface Inster{};
 public interface Update{};
 public interface Delete{};

}

下边在定义校验规则时指定分组

@NotEmpty(groups = {ValidationGroups.Inster.class},message = "添加课程名称不能为空")
 @NotEmpty(groups = {ValidationGroups.Update.class},message = "修改课程名称不能为空")
// @NotEmpty(message = "课程名称不能为空")
 @ApiModelProperty(value = "课程名称", required = true)
 private String name;

在Controller方法中启动校验规则指定要使用的分组名

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated({ValidationGroups.Inster.class}) AddCourseDto addCourseDto){
    //机构id由于认证系统没有上线暂时硬编码
    Long companyId = 1L;
  return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

再次测试由于这里指定了Insert分组所以抛出 异常信息添加课程名称不能为空。

如果修改分组为ValidationGroups.Update.class异常信息为修改课程名称不能为空。

4.7.4 校验规则不满足

如果javax.validation.constraints包下的校验规则满足不了需求怎么办

1、手写校验代码 。

2、自定义校验规则注解。

如何自定义校验规则注解请自行查阅资料实现。