参数校验和分组
对于参数校验的一个总结
意义：前端校验了，后端也进行数据校验，保存数据安全性
/**
*
* @Description
*
* JSR提供的校验注解:
*
* @Null 被注释的元素必须为 null
* @NotNull 被注释的元素必须不为 null
* @AssertTrue 被注释的元素必须为 true
* @AssertFalse 被注释的元素必须为 false
* @Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
* @Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
* @DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
* @DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
* @Size(max=, min=) 被注释的元素的大小必须在指定的范围内
* @Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
* @Past 被注释的元素必须是一个过去的日期
* @Future 被注释的元素必须是一个将来的日期
* @Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
* Hibernate Validator提供的校验注解：
*
* @NotBlank(message =) 验证字符串非null，且长度必须大于0
* @Email 被注释的元素必须是电子邮箱地址
* @Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
* @NotEmpty 被注释的字符串的必须非空
* @Range(min=,max=,message=) 被注释的元素必须在合适的范围内
**/
11-1 普通校验
第1步：引入如依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
第2步: eg:对BrandEntity1标注数据校验注解
package com.xurong.parmcheck.domain.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.xurong.parmcheck.common.valid.ListValue;
import lombok.Data;
import javax.validation.constraints.*;
import java.io.Serializable;
@Data
@TableName("pms_brand")
public class BrandEntity1 implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotBlank(message = "品牌名必须提交")
private String name;
/**
* 品牌logo地址
*/
@NotBlank
// @URL(message = "logo必须是一个合法的url地址")
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示；1-显示]
*/
// @Pattern()
@NotNull
// 这是自定义注解，表明该字段只能是0或1
@ListValue(valus={0,1})
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty()
@Pattern(regexp="^[a-zA-Z]$")
private String firstLetter;
/**
* 排序
*/
@NotNull()
@Min(value = 0,message = "排序必须大于等于0")
private Integer sort;
}
第3步：给接口发送数据，验证发送的数据是否被验证
验证1：品牌名不存在，没法通过验证
结果：数据被验证，由于没有name导致数据校验失败
验证2：测试通过案例
结果：成功通过数据校验
11-2 分组校验
意义：只对标注了分组标志字段进行校验
同样引入上述依赖
第一步：对每一个字段添加分组校验字段
package com.xurong.parmcheck.domain.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.xurong.parmcheck.common.valid.AddGroup;
import com.xurong.parmcheck.common.valid.ListValue;
import com.xurong.parmcheck.common.valid.UpdateGroup;
import com.xurong.parmcheck.common.valid.UpdateStatusGroup;
import lombok.Data;
import org.hibernate.validator.constraints.URL;
import javax.validation.constraints.*;
import java.io.Serializable;
@Data
@TableName("pms_brand")
public class BrandEntity2 implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@NotNull(message = "修改必须指定品牌id",groups = {UpdateGroup.class})
@Null(message = "新增不能指定id",groups = {AddGroup.class})
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
private String name;
/**
* 品牌logo地址
*/
@NotBlank(groups = {AddGroup.class})
// @URL(message = "logo必须是一个合法的url地址",groups={AddGroup.class,UpdateGroup.class})
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示；1-显示]
*/
// @Pattern()
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(valus={0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty(groups={AddGroup.class})
@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups={AddGroup.class,UpdateGroup.class})
private String firstLetter;
/**
* 排序
*/
@NotNull(groups={AddGroup.class})
@Min(value = 0,message = "排序必须大于等于0",groups={AddGroup.class,UpdateGroup.class})
private Integer sort;
}
第2步：使用接口作为分组标志
eg: AddGroup该接口作为保存数据时，进行分组校验的一个分组标志
public interface AddGroup {
}
eg:同理，更新数据时也添加一个分组标志
public interface UpdateGroup {
}
第2步：对接口参数进行分组校验
/**
*
* @Description
* 保存时使用分组校验
* @param
* @Author xu
* @Date 2023/8/24 12:14
*
*/
@PostMapping("/save2")
public R saveBrand2(@Validated({AddGroup.class}) @RequestBody BrandEntity2 brand) {
return R.ok("保存成功").put("brand",brand);
}
/**
* 修改时使用分组校验
*/
@PutMapping("/update")
public R update(@Validated(UpdateGroup.class) @RequestBody BrandEntity2 brand){
return R.ok("更新成功").put("brand",brand);
}
总结：也就是说，通过@Validated({AddGroup.class})对接口的数据进行校验，只校验实体类对象字段上上标有注解，并且该注解在AddGroup分组标志中，没有在AddGroup分组标志中的注解即使标注在该字段上，也不起作用。
注意：
1、要么使用@Valid对数据进行校验，要么使用@Validated({AddGroup.class})进行分组校验
2、开发接口时，可以考虑分组校验，eg:增删改查定义多个接口作为分组标志，进行数据校验时，只需要对标志了该分组标志的注解下的字段属性进行数据校验
补充：
