参数校验的目录结构:
一、如果我们想要对传入的参数进行校验,只需要在接收前端传入的实体类上使用注解即可
/**
* 品牌
*
* @date 2019-10-01 21:08:49
*/
@Data
@TableName("pms_brand")
public class BrandEntity 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(vals={
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;
}
二、分组校验:
新增AddGroup 分组接口,里面什么都不需要写。
public interface AddGroup {
}
新增UpdateGroup 分组接口,里面什么都不需要写。
public interface UpdateGroup {
}
brandId字段在新增数据的时候不需要传递这个参数,在修改的时候需要传递这个参数。
然后在对应的Controller的新增方法上添加一个注解
@Validated({AddGroup.class}
/**
* 保存
*/
@RequestMapping("/save")
public R save(@Validated({
AddGroup.class}) @RequestBody BrandEntity brand) {
brandService.save(brand);
return R.ok();
}
在对应的Controller的修改方法上添加一个注解
@Validated({UpdateGroup.class}
/**
* 修改
*/
@RequestMapping("/update")
public R update(@Validated({
UpdateGroup.class}) @RequestBody BrandEntity brand) {
brandService.updateById(brand);
return R.ok();
}
三、自定义校验:
拿字段showStatus上面的的 @ListValue(vals={0,1}
private Integer showStatus 来举例。
1、编写一个自定义的校验注解
2、编写一个自定义的校验器ConstraintValidator
3、关联自定义的校验器和自定义的校验注解
添加maven依赖
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
编写一个自定义的校验注解
@Documented
@Constraint(validatedBy = {
ListValueConstraintValidator.class })//关联自定义的校验器
@Target({
METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
String message() default "{ListValue.message}";
Class<?>[] groups() default {
};
Class<? extends Payload>[] payload() default {
};
int[] vals() default {
};
}
编写一个自定义的校验器ConstraintValidator
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
private Set<Integer> set = new HashSet<>();
//初始化方法
@Override
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
for (int val : vals) {
set.add(val);
}
}
//判断是否校验成功
/**
*
* @param value 需要校验的值
* @param context
* @return
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
return set.contains(value);
}
}