溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章運用簡單易懂的例子給大家介紹Java使用JSR303如何實現自定義校驗注解和校驗數據，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。
一、自帶校驗注解實現數據校驗
1、web項目導入依賴
<!-- 該依賴默認導入了 hibernate-validator 所以不需要再單獨導入 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
下圖可以看到spring-boot-starter-web依賴自動引入了hibernate-validator；
如果感興趣的話還可以進入hibernate-validator查看引入了什么相關依賴
2、默認注解的使用
在需要校驗的字段添加不同校驗類型的注解
/** * 品牌id */ @NotNull(message = "必須提交品牌id") @TableId private Long brandId; /** * 品牌名 */ @NotBlank(message = "品牌名不可為空") private String name; /** * 品牌logo地址 */ @NotBlank(message = "logo必須提交") @URL(message = "logo地址格式錯誤") private String logo; /** * 介紹 */ private String descript; /** * 顯示狀態[0-不顯示；1-顯示] */private Integer showStatus; /** * 檢索首字母 - 正則校驗實現 */ @NotNull(message = "首字母必須提交") @Pattern(message = "首字母必須是一個字母，且a-z或A-Z", regexp = "/^[a-zA-Z]$/") private String firstLetter;
下圖是自帶的所有校驗注解，可以進入查看源碼的注釋查看如何使用
3、設置誰需要進行數據校驗！！！
在接口參數需要校驗的對象前標注注解**@Valid** - 標明前臺提交數據時該對象的字段需要進行數據校驗
/**
* 修改
*/
@RequestMapping("/update")
public R update(@Valid @RequestBody AttrGroupEntity attrGroup){
attrGroupService.updateById(attrGroup);
return R.ok();
}二、如何使用分組校驗？
由于不同功能的接口接收的對象數據可能需要校驗的字段不同，并不是每一個接口接收的對象的所有字段都需要校驗的，所以則需要使用"分組校驗"來區分不同的業務需要校驗不同的字段，在這里我使用新增業務和修改業務為例。
根據上圖可以看到，默認的注解源碼不僅可以設置message（消息）還有一個可以設置group（分組）
1、創建分組接口
/**
* 新增業務分組校驗 - 不需要實現任何業務，只是用來標識身份
*/
public interface AddGroup {
}/**
* 修改業務分組校驗 - 不需要實現任何業務，只是用來標識身份
*/
public interface UpdateGroup {
}2、如何使用分組校驗？
2.1、修改Bean每個字段上校驗注解，設置group值
/**
* 品牌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(message = "logo必須提交", groups = {AddGroup.class})
@URL(message = "logo地址格式錯誤", groups = {AddGroup.class, UpdateGroup.class})
private String logo;
/**
* 介紹
*/
private String descript;
/**
* 顯示狀態[0-不顯示；1-顯示]
*/
private Integer showStatus;
/**
* 檢索首字母
*/
@NotNull(message = "首字母必須提交", groups = {AddGroup.class})
@Pattern(message = "首字母必須是一個字母，且a-z或A-Z", regexp = "/^[a-zA-Z]$/", groups = {AddGroup.class, UpdateGroup.class})
private String firstLetter;
/**
* 排序
*/
@Min(value = 0, groups = {AddGroup.class, UpdateGroup.class})
private Integer sort;2.2、設置什么業務需要使用什么分組進行校驗
/**
* 保存 - 使用添加分組校驗接口參數對象的字段
*/
@RequestMapping("/save")
public R save(@Validated(value = {AddGroup.class}) @RequestBody BrandEntity brand){
brandService.save(brand);
return R.ok();
}/**
* 修改 - 使用修改分組校驗接口參數對象的字段
*/
@RequestMapping("/update")
public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand){
brandService.updateById(brand);
return R.ok();
}此時，不同業務就會校驗不同的字段！！！
三、自定義校驗注解
1、導入依賴的jar包
<dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency>
2、編寫自定義校驗注解
/**
* 自定義校驗注解
* @author mashanghaoyun
* @date 2020/8/3115:01
*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {})
public @interface ListValue {
String message() default "{com.mashanghaoyun.common.valid.ListValue.message}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
int[] vals() default { };
}3、編寫自定義校驗器
/**
* 自定義校驗器
* @author mashanghaoyun
* @date 2020/8/3115:15
*/
public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {
private Set<Integer> set = new HashSet<>();
/**
* @Description 初始化方法
* @Author mashanghaoyun
* @Date 15:17 2020/8/31
* @Param [constraintAnnotation]
* @return void
**/
@Override
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
if (vals.length > 0) {
for (int val : vals) {
set.add(val);
}
}
}
/**
* @Description 判斷是否校驗成功
* @Author mashanghaoyun
* @Date 15:18 2020/8/31
* @Param [value（當前提交校驗的值）, context]
* @return boolean
**/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
if (set.size() > 0) {
if (set.contains(value)) {
return true;
}
}
return false;
}
}3、關聯自定義注解與校驗器
4、使用自定義注解
關于Java使用JSR303如何實現自定義校驗注解和校驗數據就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
