当前位置：首页 > backend >正文

【系统参数合法性校验】spring-boot-starter-validation

backend 2025/5/1 23:27:29

JSR303校验

统一校验的需求

前端请求后端接口传输参数，是在controller中校验还是在Service中校验？
答案是都需要校验，只是分工不同。
Contoller中校验请求参数的合法性，包括：必填项校验，数据格式校验，比如：是否是符合一定的日期格式，等。
Service中要校验的是业务规则相关的内容，比如：课程已经审核通过所以提交失败。
Service中根据业务规则去校验不方便写成通用代码，Controller中则可以将校验的代码写成通用代码。
早在JavaEE6规范中就定义了参数校验的规范，它就是JSR-303，它定义了BeanValidation，即对bean属性进行校
验。
SpringBoot提供了JSR-303的支持，它就是spring-boot-starter-validation，它的底层使用HibernateValidator，
HibernateValidator是BeanValidation的参考实现。
所以，我们准备在Controller层使用spring-boot-starter-validation完成对请求参数的基本合法性进行校验。

if校验

@Transactional
@Override
public CourseBaseInfoDto createCourseBase(Long companyId, AddCourseDto addCourseDto) {// 参数合法性校验if (StringUtils.isBlank(addCourseDto.getName())) {//            throw new RuntimeException("课程名称为空");XueChengPlusException.cast("课程名称为空");}if (StringUtils.isBlank(addCourseDto.getMt())) {throw new RuntimeException("课程分类为空");}if (StringUtils.isBlank(addCourseDto.getSt())) {throw new RuntimeException("课程分类为空");}if (StringUtils.isBlank(addCourseDto.getGrade())) {throw new RuntimeException("课程等级为空");}if (StringUtils.isBlank(addCourseDto.getTeachmode())) {throw new RuntimeException("教育模式为空");}if (StringUtils.isBlank(addCourseDto.getUsers())) {throw new RuntimeException("适应人群为空");}if (StringUtils.isBlank(addCourseDto.getCharge())) {throw new RuntimeException("收费规则为空");}// 向课程基本信息表course_base插入数据CourseBase courseBase = new CourseBase();BeanUtils.copyProperties(addCourseDto, courseBase);courseBase.setCompanyId(companyId);courseBase.setCreateDate(LocalDateTime.now());// 审核状态默认为未提交courseBase.setAuditStatus("202002");// 发布状态为未发布courseBase.setStatus("203001");int insert = courseBaseMapper.insert(courseBase);if (insert <= 0) {throw new RuntimeException("添加课程失败");}// 向课程营销系course_market写入数据CourseMarket courseMarket = new CourseMarket();BeanUtils.copyProperties(addCourseDto, courseMarket);// 主键的课程idcourseMarket.setId(courseBase.getId());saveCourseMarket(courseMarket);// 从数据库查询课程的详细信息，包括两部分return getCourseBaseInfo(courseBase.getId());
}

@Validated注解校验

依赖

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

定义校验

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;/*** @author Mr.M* @version 1.0* @description 添加课程dto* @date 2022/9/7 17:40*/
@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 = "课程介绍")@Size(message = "课程描述内容过少", min = 10)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;
}

@Validated 激活校验

@ApiOperation("新增课程")
@PostMapping("course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated AddCourseDto addCourseDto) {// 获取到用户所属机构idLong companyId = 1232141425L;int i = 1/0;return courseBaseInfoService.createCourseBase(companyId, addCourseDto);
}

分组校验

当多个接口使用同一个模型类的时候，当多个接口对校验的需求不一样，这个时候采用分组校验

用于分级校验，定义一些常用的组

package com.xuecheng.base.execption;/*** @program: xuecheng-plus-project* @since: jdk1.8* @description: 用于分级校验，定义一些常用的组* @author: Administrator* @create: 2025-04-29 21:55**/
public class ValidationGroups {public interface Insert {}public interface Update {}public interface Delete {}
}