前后端联调统一校验规则

统一校验实现

1.什么是统一校验

前端请求后端接口传递参数，是在controller中校验还是在Service中校验？答案是都需要校验，只是分工不同。

Contoller中校验请求参数的合法性：

例如，必填项校验、数据格式校验、邮箱格式、日期格式等

Service中要校验的是业务规则相关的内容，

例如，课程已经审核通过了，所以提交失败

2.统一校验的实现

（1）在JavaEE6规范中就定义了参数校验规范，就是JSR-303，它定义了BeanValidaton，即对bean属性进行校验

（2）SpringBoot提供了JSR-303的支持，为spring-boot-starter-validation

（1）引入依赖

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

version未指定版本，需自己按需求指定

（2）基于注解

常用规则如下：

（3）使用案例

现在准备对createCourseBase这个Controller的createCourseBase接口进行参数校验

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

【1】定义校验规则

此接口，使用AddCourseDto作为传入参数，首先在AddCourseDto上定义校验规则

@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表示限制属性内容的长短。

【2】开启校验

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

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

【3】统一异常处理器捕获校验产生的异常

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

@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public RestErrorResponse methodArgumentNotValidException(MethodArgumentNotValidException e) {
    BindingResult bindingResult = e.getBindingResult();
    List<String> msgList = new ArrayList<>();
    //将错误信息放在msgList
    bindingResult.getFieldErrors().stream().forEach(item->msgList.add(item.getDefaultMessage()));
    //拼接错误信息
    String msg = StringUtils.join(msgList, ",");
    log.error("【系统异常】{}",msg);
    return new RestErrorResponse(msg);
}

这是在统一异常处理器中添加对MethodArgumentNotValidException校验异常捕获的方法methodArgumentNotValidException

3.分组校验

有时候单一的校验规则不能满足需求，比如订单编号由系统生成，要求添加订单是订单编号为空。但是在更新订单时要求订单编号不能为空，此时就需要用到分组校验

(1)定义公共的校验分组

比如添加订单@NULL规则属于insert，更新订单@NotEmpty规则属于update

我们可以定义一个公共的class来表示不同的校验分组，定义不同的接口类型，咳咳公用

如下：

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

(2)定义校验规则时指定分组

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

(3)在Controller方法中启动校验规则要使用的分组名

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated({ValidationGroups.Inster.class}) AddCourseDto addCourseDto){
    return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}