淺談自定義校驗注解ConstraintValidator
一、前言
系統(tǒng)執(zhí)行業(yè)務邏輯之前，會對輸入數據進行校驗，檢測數據是否有效合法的。所以我們可能會寫大量的if else等判斷邏輯，特別是在不同方法出現相同的數據時，校驗的邏輯代碼會反復出現，導致代碼冗余，閱讀性和可維護性極差。
JSR-303是Java為Bean數據合法性校驗提供的標準框架，它定義了一整套校驗注解，可以標注在成員變量，屬性方法等之上。
hibernate-validator就提供了這套標準的實現，我們在用Springboot開發(fā)web應用時，會引入spring-boot-starter-web依賴，它默認會引入spring-boot-starter-validation依賴，而spring-boot-starter-validation中就引用了hibernate-validator依賴。
但是，在比較高版本的spring-boot-starter-web中，默認不再引用spring-boot-starter-validation，自然也就不會默認引入到hibernate-validator依賴，需要我們手動添加依賴。
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.1.7.Final</version>
</dependency>
hibernate-validator中有很多非常簡單好用的校驗注解，例如NotNull，@NotEmpty，@Min，@Max，@Email，@PositiveOrZero等等。這些注解能解決我們大部分的數據校驗問題。如下所示：
package com.nobody.dto;
import lombok.Data;
import javax.validation.constraints.*;
@Data
public class UserDTO {
@NotBlank(message = "姓名不能為空")
private String name;
@Min(value = 18, message = "年齡不能小于18")
private int age;
@NotEmpty(message = "郵箱不能為空")
@Email(message = "郵箱格式不正確")
private String email;
}
二、自定義參數校驗器
但是，hibernate-validator中的這些注解不一定能滿足我們全部的需求，我們想校驗的邏輯比這復雜。所以，我們可以自定義自己的參數校驗器。
首先引入依賴是必不可少的。
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.1.7.Final</version>
</dependency>
最近不是基金很火嗎，一大批的韭菜瘋狂地涌入買基金的浪潮中。我就以用戶開戶為例，首先要校驗此用戶是不是成年人（即不能小于18歲），以及名字是不是以"新韭菜"開頭的，符合條件的才允許開戶。
定義一個注解，用于校驗用戶的姓名是不是以“新韭菜”開頭的。
package com.nobody.annotation;
import com.nobody.validator.IsLeekValidator;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Constraint(validatedBy = IsLeekValidator.class) // 指定我們自定義的校驗類
public @interface IsLeek {
/**
* 是否強制校驗
*
* @return 是否強制校驗的boolean值
*/
boolean required() default true;
/**
* 校驗不通過時的報錯信息
*
* @return 校驗不通過時的報錯信息
*/
String message() default "此用戶不是韭零后，無法開戶！";
/**
* 將validator進行分類，不同的類group中會執(zhí)行不同的validator操作
*
* @return validator的分類類型
*/
Class<?>[] groups() default {};
/**
* 主要是針對bean，很少使用
*
* @return 負載
*/
Class<? extends Payload>[] payload() default {};
}
定義校驗類，實現ConstraintValidator接口，接口使用了泛型，需要指定兩個參數，第一個是自定義注解，第二個是需要校驗的數據類型。重寫2個方法，initialize方法主要做一些初始化操作，它的參數是我們使用到的注解，可以獲取到運行時的注解信息。isValid方法就是要實現的校驗邏輯，被注解的對象會傳入此方法中。
package com.nobody.validator;
import com.nobody.annotation.IsLeek;
import org.springframework.util.StringUtils;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class IsLeekValidator implements ConstraintValidator<IsLeek, String> {
// 是否強制校驗
private boolean required;
@Override
public void initialize(IsLeek constraintAnnotation) {
this.required = constraintAnnotation.required();
}
@Override
public boolean isValid(String name, ConstraintValidatorContext constraintValidatorContext) {
if (required) {
// 名字以"新韭菜"開頭的則校驗通過
return !StringUtils.isEmpty(name) && name.startsWith("新韭菜");
}
return false;
}
}
三、使用自定義注解
通過以上幾個步驟，我們自定義的校驗注解就完成了，我們使用測試下效果。
package com.nobody.dto;
import com.nobody.annotation.IsLeek;
import lombok.Data;
import javax.validation.constraints.*;
@Data
public class UserDTO {
@NotBlank(message = "姓名不能為空")
@IsLeek // 我們自定義的注解
private String name;
@Min(value = 18, message = "年齡不能小于18")
private int age;
@NotEmpty(message = "郵箱不能為空")
@Email(message = "郵箱格式不正確")
private String email;
}
寫個接口，模擬用戶開戶業(yè)務，調用測試。注意，記得加上@Valid注解開啟校驗，不然不生效。
package com.nobody.controller;
import com.nobody.dto.UserDTO;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
@RestController
@RequestMapping("user")
public class UserController {
@PostMapping("add")
public UserDTO add(@RequestBody @Valid UserDTO userDTO) {
System.out.println(">>> 用戶開戶成功...");
return userDTO;
}
}
如果參數校驗不通過，會拋出MethodArgumentNotValidException異常，我們全局處理下然后返回給接口。
package com.nobody.exception;
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import lombok.extern.slf4j.Slf4j;
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
// 處理接口參數數據格式錯誤異常
@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseBody
public Object errorHandler(HttpServletRequest request, MethodArgumentNotValidException e) {
return e.getBindingResult().getAllErrors();
}
}
我們先測試用戶姓名不帶"新韭菜"前綴的進行測試，發(fā)現校驗不通過，證明注解生效了。
POST http://localhost:8080/user/add
Content-Type: application/json
{"name": "小綠", "age": 19, "email": "845136542@qq.com"}
[
{
"codes": [
"IsLeek.userDTO.name",
"IsLeek.name",
"IsLeek.java.lang.String",
"IsLeek"
],
"arguments": [
{
"codes": [
"userDTO.name",
"name"
],
"arguments": null,
"defaultMessage": "name",
"code": "name"
},
true
],
"defaultMessage": "此用戶不是韭零后，無法開戶！",
"objectName": "userDTO",
"field": "name",
"rejectedValue": "小綠",
"bindingFailure": false,
"code": "IsLeek"
}
如果多個參數校驗失敗，報錯信息也都能獲得。如下所示，姓名和郵箱都校驗失敗。
POST http://localhost:8080/user/add
Content-Type: application/json
{"name": "小綠", "age": 19, "email": "84513654"}
[
{
"codes": [
"Email.userDTO.email",
"Email.email",
"Email.java.lang.String",
"Email"
],
"arguments": [
{
"codes": [
"userDTO.email",
"email"
],
"arguments": null,
"defaultMessage": "email",
"code": "email"
},
[],
{
"defaultMessage": ".*",
"codes": [
".*"
],
"arguments": null
}
],
"defaultMessage": "郵箱格式不正確",
"objectName": "userDTO",
"field": "email",
"rejectedValue": "84513654",
"bindingFailure": false,
"code": "Email"
},
{
"codes": [
"IsLeek.userDTO.name",
"IsLeek.name",
"IsLeek.java.lang.String",
"IsLeek"
],
"arguments": [
{
"codes": [
"userDTO.name",
"name"
],
"arguments": null,
"defaultMessage": "name",
"code": "name"
},
true
],
"defaultMessage": "此用戶不是韭零后，無法開戶！",
"objectName": "userDTO",
"field": "name",
"rejectedValue": "小綠",
"bindingFailure": false,
"code": "IsLeek"
}
]
以下是所有參數校驗通過的情況：
POST http://localhost:8080/user/add
Content-Type: application/json
{"name": "新韭菜小綠", "age": 19, "email": "84513654@qq.com"}
{
"name": "新韭菜小綠",
"age": 19,
"email": "84513654@qq.com"
}
我們可能會將UserDTO對象用在不同的接口中接收參數，比如在新增和修改接口中。在新增接口中，不需要校驗userId；在修改接口中需要校驗userId。那注解中的groups字段就派上用場了。groups和@Validated配合能控制哪些注解需不需要開啟校驗。
我們首先定義2個groups分組接口Update和Create，并且繼承Default接口。當然也可以不繼承Default接口，因為使用注解時不顯示指定groups的值，則默認為groups = {Default.class}。所以繼承了Default接口，在用@Validated(Create.class)時，也會校驗groups = {Default.class}的注解。
package com.nobody.annotation;
import javax.validation.groups.Default;
public interface Create extends Default {
}
package com.nobody.annotation;
import javax.validation.groups.Default;
public interface Update extends Default {
}
在用到注解的地方，填寫groups的值。
package com.nobody.dto;
import com.nobody.annotation.Create;
import com.nobody.annotation.IsLeek;
import com.nobody.annotation.Update;
import lombok.Data;
import javax.validation.constraints.*;
@Data
public class UserDTO {
@NotBlank(message = "用戶ID不能為空", groups = Update.class)
private String userId;
@NotBlank(message = "姓名不能為空", groups = {Update.class, Create.class})
@IsLeek
private String name;
@Min(value = 18, message = "年齡不能小于18")
private int age;
@NotEmpty(message = "郵箱不能為空")
@Email(message = "郵箱格式不正確")
private String email;
}
最后，在需要聲明校驗的地方，通過@Validated的指定即可。
package com.nobody.controller;
import com.nobody.annotation.Create;
import com.nobody.annotation.Update;
import com.nobody.dto.UserDTO;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("user")
public class UserController {
@PostMapping("add")
public Object add(@RequestBody @Validated(Create.class) UserDTO userDTO) {
System.out.println(">>> 用戶開戶成功...");
return userDTO;
}
@PostMapping("update")
public Object update(@RequestBody @Validated(Update.class) UserDTO userDTO) {
System.out.println(">>> 用戶信息修改成功...");
return userDTO;
}
}
調用add接口時，即使不傳userId也能通過，即不對userId進行校驗。
POST http://localhost:8080/user/add
Content-Type: application/json
{"name": "新韭菜小綠", "age": 18, "email": "84513654@qq.com"}
調用update接口時，不傳userId，會校驗不通過。
POST http://localhost:8080/user/update
Content-Type: application/json
{"name": "新韭菜小綠", "age": 18, "email": "84513654@qq.com"}
[
{
"codes": [
"NotBlank.userDTO.userId",
"NotBlank.userId",
"NotBlank.java.lang.String",
"NotBlank"
],
"arguments": [
{
"codes": [
"userDTO.userId",
"userId"
],
"arguments": null,
"defaultMessage": "userId",
"code": "userId"
}
],
"defaultMessage": "用戶ID不能為空",
"objectName": "userDTO",
"field": "userId",
"rejectedValue": null,
"bindingFailure": false,
"code": "NotBlank"
}
]
此演示項目已上傳到Github，如有需要可自行下載，歡迎 Star 。 https://github.com/LucioChn/spring
以上就是淺談自定義校驗注解ConstraintValidator的詳細內容，更多關于自定義校驗注解ConstraintValidator的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了Java基本數據類型與類型轉換,結合實例形式分析了Java基本數據類型分類、用法,類型轉換及相關操作注意事項,需要的朋友可以參考下2020-04-04
這篇文章主要介紹了對Jpa中Entity關系映射中mappedBy的全面理解，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-12-12
有時候我們有多個項目需要使用多個版本JDK，本文主要介紹了Mac安裝多個JDK并實現動態(tài)切換，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-07-07
這篇文章主要介紹了Java 方法引用與ambda表達式的聯系，方法引用通過方法的名字來指向一個方法， 方法引用同樣是Java 8 引入的新特性，而且和Lambda表達式有著不小的聯系，它同樣可以根據上下文進行推導，進而可以簡化代碼2022-06-06
mybatis-plus(insertBatchSomeColumn批量添加方式)
這篇文章主要介紹了mybatis-plus(insertBatchSomeColumn批量添加方式)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-03-03
這篇文章主要介紹了Java從JDK源碼角度對Object進行實例分析，具有一定借鑒價值，需要的朋友可以參考下。2017-12-12
這篇文章主要是分別對Java數組、ArrayList、LinkedList和Vector進行隨機訪問和迭代等操作，并比較這種集合的性能。有需要的可以參考借鑒。2016-08-08
下面小編就為大家?guī)硪黄狫ava全面解析XML格式串（JDOM解析）。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-06-06
這篇文章主要介紹了SpringBoot打印POST請求原始入參body體方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要給大家介紹了關于利用Redis實現延時處理的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者使用Redis具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-03-03