要引入maven依賴
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
1.給bean中添加校驗注解javax.validation.constraints,并指定message
package com.yuchen.yuchenmail.mailproduct.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
import com.yuchen.common.valid.AddGroup;
import com.yuchen.common.valid.ListValue;
import com.yuchen.common.valid.UpdateGroup;
import lombok.Data;
import org.hibernate.validator.constraints.URL;
import javax.validation.constraints.*;
/**
* 品牌
*
* @author yuchen
* @email ${email}
* @date 2020-12-20 14:49:50
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID =1L;
/**
? ? * 品牌id
*/
? @NotNull(message ="修改的時候品牌Id不能為空", groups = {UpdateGroup.class})
@TableId
? @Null(message ="新增不能指定品牌的ID", groups = {AddGroup.class})
private Long brandId;
/**
? ? * 品牌名
? ? */
? @NotNull(message ="品牌名不能為空", groups = {AddGroup.class, UpdateGroup.class})
private String name;
/**
? ? * 品牌logo地址
? ? */
? @NotEmpty(groups = {AddGroup.class})
@URL(message ="logo必須是一個合法的url地址", groups = {AddGroup.class, UpdateGroup.class})
private String logo;
/**
? ? * 介紹
? ? */
? private String descript;
/**
? ? * 顯示狀態(tài)[0-不顯示；1-顯示]
*/
? @ListValue(vals = {0,1},groups = {AddGroup.class})
private Integer showStatus;
/**
? ? * 檢索首字母
? ? */
? @NotEmpty(groups = {AddGroup.class})
@Pattern(regexp ="/^[a-zA-Z]$/", message ="檢索首字母必須是一個英文字母", groups = {AddGroup.class, UpdateGroup.class})
private String firstLetter;
/**
? ? * 排序
? ? */
? @Min(value =0, message ="排序字段必須是一個正整數(shù)", groups = {AddGroup.class, UpdateGroup.class})
private Integer sort;
2.開啟校驗，在controller層，參數(shù)的前面加上@Vaild 注解，這就開啟了校驗的功能
/**
? * 保存
? */
? @RequestMapping("/save")
//@RequiresPermissions("mailproduct:brand:save")
? public R save(@Valid @RequestBody BrandEntity brand){
brandService.save(brand);
return R.ok();
}
3.這個校驗，在參數(shù)后面加上BindingResult bindingResult 就能獲取到被校驗住的參數(shù)和message
? public R save(@Valid @RequestBody BrandEntity brand, BindingResult bindingResult)
不過這里一般使用全局異常處理，這個會在全局異常處理中講解
4.分組校驗，特別聲明：如果在參數(shù)中指定了分組校驗，那些沒有指定分組校驗的和不是該分組校驗的參數(shù)都能進(jìn)行校驗
首先定義分組校驗接口，就是空的接口
package com.yuchen.common.valid;
public interface AddGroup {
}
package com.yuchen.common.valid;
public interface UpdateGroup {
}
然后在bean中的校驗注解上添加校驗分組，上面的bean中有詳細(xì)的案例
@URL(message ="logo必須是一個合法的url地址", groups = {AddGroup.class, UpdateGroup.class})
最后在controller層，需要校驗的參數(shù)前面加上@Validated(AddGroup.class)并指定校驗分組
@RequestMapping("/save")
//@RequiresPermissions("mailproduct:brand:save")
? public R save(@Validated(AddGroup.class)@RequestBody BrandEntity brand){
brandService.save(brand);
return R.ok();
}
5.自定義校驗注解
創(chuàng)建校驗注解（這個注解可以參考其他的注解）創(chuàng)建注解的時候要注意的事項，在代碼中有注釋
@Constraint(validatedBy = { ListValueConstraintValidator.class }) 中指定校驗器，這里可以指定多個校驗器
package com.yuchen.common.valid;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 這里的校驗器只能夠校驗參數(shù)類型行是Integer的參數(shù)，如果想要校驗參數(shù)類型是其他的，需要再頂一個校驗器，并在validatedBy = {}中加入另一個校驗器
*/
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class })
@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
String message()default "{com.yuchen.common.valid.ListValue.message}";
Class[] groups()default { };
Class[] payload()default { };
int[] vals()default {};
}
編寫指定默認(rèn)message的properties文件，這里的文件名是固定的ValidationMessages.properties
在校驗注解中的String message()default "{com.yuchen.common.valid.ListValue.message}"; 這的message前面的一般都是注解的引用路徑
com.yuchen.common.valid.ListValue.message=必須提交指定的值
編寫校驗類, 實(shí)現(xiàn)?ConstraintValidator<ListValue, Integer> 這里參數(shù)的說明在代碼注解中
initialize(ListValue constraintAnnotation) 方法進(jìn)行初始化，能夠獲取到在bean中參數(shù)上注解的填寫的值，
?isValid(Integer value, ConstraintValidatorContext context) 這個就是進(jìn)行校驗的方法了
package com.yuchen.common.valid;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
/**
* ConstraintValidator中的兩個泛型，一個是值得是校驗注解ListValue，另一個是指定要校驗的參數(shù)是什么類型的值Integer
*/
public class ListValueConstraintValidator implements ConstraintValidator?<ListValue, Integer> {
Set?set =new HashSet<>();
/**
*
? ? * @param value? 就是要進(jìn)行校驗的值，代碼中是指的private Integer showStatus;
? ? * @param context
? ? * @return
? ? */
? ? @Override
? ? public boolean isValid(Integer value, ConstraintValidatorContext context) {
return? set.contains(value);
}
/**
*constraintAnnotation 可以獲取到bean中的參數(shù)上面填寫的值
**/
@Override
? ? public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
for (int val : vals){
set.add(val);
}
}
}
最后在需要的bean中添加校驗注解就可以了
? @ListValue(vals = {0,1},groups = {AddGroup.class})
