JSR303校验(表单参数校验)

一、统一校验

1、maven坐标

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

2、校验规则

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

如下

@PostMapping
@ResponseBody
public CourseBaseInfoDto createCourse(@RequestBody @Validated AddCourseDto addCourseDto){
    Long companyId = 22L;
    CourseBaseInfoDto course = courseBaseService.createCourse(companyId,addCourseDto);
    return course;
}

4、添加规则在实体类上面

package com.xuechengpluscontent.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 = "课程名称不能为空666")
 @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 Float price;
 @ApiModelProperty(value = "原价")
 private Float originalPrice;


 @ApiModelProperty(value = "qq")
 private String qq;

 @ApiModelProperty(value = "微信")
 private String wechat;
 @ApiModelProperty(value = "电话")
 private String phone;

 @ApiModelProperty(value = "有效期")
 private Integer validDays;
}

5、编写统一异常处理类

@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public RestErrorResponse ValidException(MethodArgumentNotValidException e){
    BindingResult bindingResult = e.getBindingResult();
    StringBuffer errMsg=new StringBuffer();
    List<FieldError> fieldErrors = bindingResult.getFieldErrors();
    for (FieldError fieldError : fieldErrors) {
        errMsg.append(fieldError.getDefaultMessage());
    }
    log.info(errMsg.toString());
    System.out.println(errMsg.toString());
    return new RestErrorResponse(errMsg.toString());
}

• 使用JSR303校验必须引用MethodArgumentNotValidException异常

• 使用步骤详解如下

• getBindingResult()方法是用来获取存起来的异常信息

• 使用StringBuffer来存储异常信息用来返回

• bindingResult.getFieldErrors()获取字段错误的集合然后全部存储到StringBuffer中

• 最后返回

二、分组校验

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

1、我们用class类型来表示不同的分组，所以我们定义不同的接口类型（空接口）表示不同的分组

package com.xuechengpluscommon.domain;

/**
 * 校验分组
 */
public class ValidationGroups {
    public interface Inster{};
    public interface Update{};
    public interface Delete{};
}

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

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

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

@PostMapping
@ResponseBody
public CourseBaseInfoDto createCourse1(@RequestBody @Validated(ValidationGroups.Inster.class) AddCourseDto addCourseDto){
    Long companyId = 22L;
    CourseBaseInfoDto course = courseBaseService.createCourse(companyId,addCourseDto);
    return course;
}
@PostMapping
@ResponseBody
public CourseBaseInfoDto createCourse2(@RequestBody @Validated(ValidationGroups.Update.class) AddCourseDto addCourseDto){
    Long companyId = 22L;
    CourseBaseInfoDto course = courseBaseService.createCourse(companyId,addCourseDto);
    return course;
}

再次测试，由于这里指定了Insert分组，所以抛出 异常信息：课程名称不能为空(插入组)。如果修改分组为ValidationGroups.Update.class，异常信息为：课程名称不能为空(修改组)。

• insert

• update