Java如何使用JSR303校驗數(shù)據(jù)與自定義校驗注解
一、自帶校驗注解實現(xiàn)數(shù)據(jù)校驗
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; /** * 顯示狀態(tài)[0-不顯示;1-顯示] */private Integer showStatus; /** * 檢索首字母 - 正則校驗實現(xiàn) */ @NotNull(message = "首字母必須提交") @Pattern(message = "首字母必須是一個字母,且a-z或A-Z", regexp = "/^[a-zA-Z]$/") private String firstLetter;
下圖是自帶的所有校驗注解,可以進入查看源碼的注釋查看如何使用
3、設置誰需要進行數(shù)據(jù)校驗?。?!
在接口參數(shù)需要校驗的對象前標注注解**@Valid** - 標明前臺提交數(shù)據(jù)時該對象的字段需要進行數(shù)據(jù)校驗
/** * 修改 */ @RequestMapping("/update") public R update(@Valid @RequestBody AttrGroupEntity attrGroup){ attrGroupService.updateById(attrGroup); return R.ok(); }
二、如何使用分組校驗?
由于不同功能的接口接收的對象數(shù)據(jù)可能需要校驗的字段不同,并不是每一個接口接收的對象的所有字段都需要校驗的,所以則需要使用"分組校驗"來區(qū)分不同的業(yè)務需要校驗不同的字段,在這里我使用新增業(yè)務和修改業(yè)務為例。
根據(jù)上圖可以看到,默認的注解源碼不僅可以設置message(消息)還有一個可以設置group(分組)
1、創(chuàng)建分組接口
/** * 新增業(yè)務分組校驗 - 不需要實現(xiàn)任何業(yè)務,只是用來標識身份 */ public interface AddGroup { }
/** * 修改業(yè)務分組校驗 - 不需要實現(xiàn)任何業(yè)務,只是用來標識身份 */ 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; /** * 顯示狀態(tài)[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、設置什么業(yè)務需要使用什么分組進行校驗
/** * 保存 - 使用添加分組校驗接口參數(shù)對象的字段 */ @RequestMapping("/save") public R save(@Validated(value = {AddGroup.class}) @RequestBody BrandEntity brand){ brandService.save(brand); return R.ok(); }
/** * 修改 - 使用修改分組校驗接口參數(shù)對象的字段 */ @RequestMapping("/update") public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand){ brandService.updateById(brand); return R.ok(); }
此時,不同業(yè)務就會校驗不同的字段?。?!
三、自定義校驗注解
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、關聯(lián)自定義注解與校驗器
4、使用自定義注解
到此這篇關于Java如何使用JSR303校驗數(shù)據(jù)與自定義校驗注解的文章就介紹到這了,更多相關Java JSR303校驗數(shù)據(jù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
eclipse/intellij idea 查看java源碼和注釋方法
下面小編就為大家?guī)硪黄猠clipse/intellij idea 查看java源碼和注釋方法。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-05-05解決"XML Parser Error on line 1: 前言中不允許有內(nèi)容"錯誤
解決用windows自帶的記事編輯xml文件后出現(xiàn) "XML Parser Error on line 1: 前言中不允許有內(nèi)容。"的錯誤2018-02-02IntelliJ IDEA 好用插件之a(chǎn)nalyze inspect code詳解
這篇文章主要介紹了IntelliJ IDEA 好用插件之a(chǎn)nalyze inspect code的相關知識,本文通過圖文并茂的形式給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧2020-12-12Java數(shù)據(jù)結構之隊列的簡單定義與使用方法
這篇文章主要介紹了Java數(shù)據(jù)結構之隊列的簡單定義與使用方法,簡單描述了隊列的功能、特點,并結合java實例形式分析了隊列的簡單定義與使用方法,需要的朋友可以參考下2017-10-10關于maven打包時的報錯: Return code is: 501 , ReasonPhrase:HTTPS Requ
這篇文章主要介紹了關于maven打包時的報錯: Return code is: 501 , ReasonPhrase:HTTPS Required,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-09-09RocketMQ4.5.2 修改mqnamesrv 和 mqbroker的日志路徑操作
這篇文章主要介紹了RocketMQ 4.5.2 修改mqnamesrv 和 mqbroker的日志路徑操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-07-07