Java校驗(yàn)validate介紹和使用實(shí)例

更新時(shí)間：2025年01月04日 10:15:49 作者：Roc?Lau

這篇文章主要介紹了Java校驗(yàn)validate介紹和使用的相關(guān)資料,還介紹了如何使用@Valid和@Validated注解進(jìn)行聲明式校驗(yàn),以及如何處理復(fù)雜校驗(yàn)需求,通過(guò)自定義校驗(yàn)注解來(lái)實(shí)現(xiàn),需要的朋友可以參考下

Java校驗(yàn)validate

日常開(kāi)發(fā)中，我們時(shí)常需要提供可靠的 API 接口，此時(shí)對(duì)于請(qǐng)求的入?yún)⒕托枰ｒ?yàn)，以保證最終數(shù)據(jù)入庫(kù)的正確性，這就成了必不可少的活。例如說(shuō)，用戶注冊(cè)時(shí)，會(huì)校驗(yàn)手機(jī)格式的正確性、郵箱格式的正確性、密碼非弱密碼等。

但是如果使用 if-else 這種代碼去校驗(yàn)，那么需要校驗(yàn)的地方有很多情況下，代碼量就會(huì)變的十分臃腫，若是一個(gè)類(lèi)請(qǐng)求參數(shù)校驗(yàn)字段又多的化，相信各位小伙伴對(duì)不會(huì)開(kāi)心，這么干肯定不合適，代碼也不優(yōu)雅，那么如何解決這個(gè)問(wèn)題呢？

答案就是下面要介紹的 validation

validation介紹

validation 技術(shù)在Java中運(yùn)用最早在2009 年，Java 官方提出了 Bean Validation 規(guī)范，而后經(jīng)歷了JSR303、JSR349、JSR380 三次標(biāo)準(zhǔn)的更迭，發(fā)展到了 2.0 。

Bean Validation 和我們以前學(xué)習(xí)過(guò)的 JPA 一樣，只提供規(guī)范，不提供具體的實(shí)現(xiàn)。因此實(shí)際使用過(guò)程，常用的是 hibernate 的校驗(yàn)組件：org.hibernate.hibernate-validator

常見(jiàn)的注解

通常情況下，在javax.validation.constraints 包下，定義了一系列的約束（constraint）注解，一共 22 個(gè)注解，快速略過(guò)即可。如下：

空和非空檢查

@NotBlank：只能用于字符串不為 null ，并且字符串 .trim() 以后 length 要大于 0 。
@NotEmpty：集合對(duì)象的元素不為 0 ，即集合不為空。
@NotNull：不能為 null 。
@Null：必須為 null 。

數(shù)值檢查

@DecimalMax(value)：被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值。
@DecimalMin(value)：被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值。
@Digits(integer, fraction)：被注釋的元素必須是一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi)。
@Positive：判斷正數(shù)。
@PositiveOrZero：判斷正數(shù)或 0 。
@Max(value)：該字段的值只能小于或等于該值。
@Min(value)：該字段的值只能大于或等于該值。
@Negative：判斷負(fù)數(shù)。
@NegativeOrZero：判斷負(fù)數(shù)或 0 。

Boolean 值檢查

@AssertFalse：被注釋的元素必須為 true 。
@AssertTrue：被注釋的元素必須為 false 。

長(zhǎng)度檢查

@Size(max, min)：檢查字段的 size 是否在 min 和 max 之間，可以是字符串、數(shù)組、集合、Map 等。

日期檢查

@Future：被注釋的元素必須是一個(gè)將來(lái)的日期。
@FutureOrPresent：判斷日期是否是將來(lái)或現(xiàn)在日期。
@Past：檢查該字段的日期是在過(guò)去。
@PastOrPresent：判斷日期是否是過(guò)去或現(xiàn)在日期。

其它檢查

@Email：被注釋的元素必須是電子郵箱地址。
@Pattern(value)：被注釋的元素必須符合指定的正則表達(dá)式。

Hibernate Validator 附加的約束注解，在org.hibernate.validator.constraints 包下，定義了一系列的約束（constraint）注解。常見(jiàn)的如示。

@Range(min=, max=)：被注釋的元素必須在合適的范圍內(nèi)。
@Length(min=, max=)：被注釋的字符串的大小必須在指定的范圍內(nèi)。
@URL(protocol=,host=,port=,regexp=,flags=)：被注釋的字符串必須是一個(gè)有效的 URL 。
@SafeHtml：判斷提交的 HTML 是否安全。例如說(shuō)，不能包含 javascript 腳本等等。

其他的就不一一列舉了，有感興趣的小伙伴可以去源碼包看看。

@Valid和 @Validated

@Valid 注解，是 Bean Validation 所定義，可以添加在普通方法、構(gòu)造方法、方法參數(shù)、方法返回、成員變量上，表示它們需要進(jìn)行約束校驗(yàn)。
@Validated 注解，是 Spring Validation 鎖定義，可以添加在類(lèi)、方法參數(shù)、普通方法上，表示它們需要進(jìn)行約束校驗(yàn)。同時(shí)，@Validated 有 value 屬性，支持分組校驗(yàn)。

對(duì)于初學(xué)者來(lái)說(shuō)，很容易搞混 @Valid 和 @Validated 注解。

① 聲明式校驗(yàn)：Spring Validation 僅對(duì) @Validated 注解，實(shí)現(xiàn)聲明式校驗(yàn)。
② 分組校驗(yàn)：Bean Validation 提供的 @Valid注解，因?yàn)闆](méi)有分組校驗(yàn)的屬性，所以無(wú)法提供分組校驗(yàn)。此時(shí)，我們只能使用 @Validated 注解。
③ 嵌套校驗(yàn)：相比來(lái)說(shuō)，@Valid注解的地方，多了【成員變量】。這就導(dǎo)致，如果有嵌套對(duì)象的時(shí)候，只能使用@Valid注解。

spring-boot-starter-web 依賴?yán)?，已?jīng)默認(rèn)引入 hibernate-validator 依賴，所以本示例使用的是 Hibernate Validator 作為 Bean Validation 的實(shí)現(xiàn)框架。

1、簡(jiǎn)單校驗(yàn)

編寫(xiě)實(shí)體類(lèi)（這里以常用的用戶注冊(cè)為場(chǎng)景）

@Data
public class SysUser {
    private Long userId;
    /**
     * 賬號(hào)
     */
    @NotBlank(message = "用戶名不能為空")
    @Size(min = 6, message = "用戶名長(zhǎng)度不能小于6個(gè)字符")
    private String username;
    /**
     * 密碼
     */
    @NotEmpty(message = "密碼不能為空")
    @Size(min = 8, message = "密碼長(zhǎng)度不能小于8個(gè)字符")
    private String password;
    /**
     * 手機(jī)號(hào)
     */
    @NotBlank(message = "手機(jī)號(hào)不能為空")
    @Size(min = 11, max = 11, message = "手機(jī)號(hào)長(zhǎng)度不對(duì)")
    private String mobile;
}

編寫(xiě)前端控制器

@RestController
@RequestMapping("/user")
public class SysUserController {
    @PostMapping("/add")
    public R addUser(@RequestBody @Valid SysUser sysUser) {
        System.out.println("走到這里說(shuō)明校驗(yàn)成功");
        System.out.println(sysUser);
        return R.ok(R.SUCCESS_MSG);
    }
}

編寫(xiě)前端響應(yīng)封裝實(shí)體

public class R extends HashMap<String, Object> {
    private static final long serialVersionUID = 1L;
    public static final String SUCCESS_MSG = "操作成功！";
    public static final String FAIL_MSG = "操作失??！";
    public R() {
        this.put((String) "code", 0);
    }
    public static R error() {
        return error(500, "未知異常，請(qǐng)聯(lián)系管理員");
    }

public static R error(String msg) { return error(500, msg); } public static R error(int code, String msg) { R r = new R(); r.put((String) "code", code); r.put((String) "msg", msg); return r; } public static R ok(String msg) { R r = new R(); r.put((String) "msg", msg); return r; } public static R ok(Object object) { R r = new R(); r.put("result", object); return r; } public static R ok(int code, String msg) { R r = new R(); r.put((String) "code", code); r.put((String) "msg", msg); return r; } public static R ok(Map&lt;String, Object&gt; map) { R r = new R(); r.putAll(map); return r; } public static R ok() { return new R(); } public R put(String key, Object value) { super.put(key, value); return this; }

編寫(xiě)自定義異常（用于后續(xù)業(yè)務(wù)拋出異常錯(cuò)誤）

public class RRException extends RuntimeException {

private static final long serialVersionUID = 1L;

private String msg;

private int code = 500;

public RRException(String msg) {

super(msg);

this.msg = msg;

}

public RRException(String msg, Throwable e) {

super(msg, e);

this.msg = msg;

}

public RRException(String msg, int code) {

super(msg);

this.msg = msg;

this.code = code;

}

public RRException(String msg, int code, Throwable e) {

super(msg, e);

this.msg = msg;

this.code = code;

}

public String getMsg() {

return msg;

}

public void setMsg(String msg) {

this.msg = msg;

}

public int getCode() {

return code;

}

public void setCode(int code) {

this.code = code;

}

}

當(dāng)訪問(wèn)/user/add這個(gè)post接口時(shí)，如果參數(shù)不符合Model中定義的話，程序中就回拋出400異常狀態(tài)碼，并提示錯(cuò)誤信息，如下所示。

{
“timestamp”: “2021-05-20T01:08:28.831+0000”,
“status”: 400,
“error”: “Bad Request”,
“errors”: [
{
“codes”: [ “Size.sysUser.mobile”, “Size.mobile”, “Size.java.lang.String”, “Size” ],
“arguments”: [ { “codes”: [ “sysUser.mobile”, “mobile” ], “arguments”: null, “defaultMessage”: “mobile”, “code”: “mobile” },
11,
11
],
“defaultMessage”: “手機(jī)號(hào)長(zhǎng)度不對(duì)”,
“objectName”: “sysUser”,
“field”: “mobile”,
“rejectedValue”: “155833013”,
“bindingFailure”: false,
“code”: “Size”
}
],
“message”: “Validation failed for object=‘sysUser'. Error count: 1”,
“path”: “/user/add”
}

自定義校驗(yàn)注解

雖然 JSR303 和 Hibernate Validtor 已經(jīng)提供了很多校驗(yàn)注解，但是當(dāng)面對(duì)復(fù)雜參數(shù)校驗(yàn)時(shí)，還是不能滿足我們的要求，這時(shí)候我們就需要自定義校驗(yàn)注解。

下面以“List數(shù)組中不能含有null元素”為實(shí)例自定義校驗(yàn)注解

1、注解定義如示。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})

@Retention(RUNTIME)

@Documented

@Constraint(validatedBy = ListNotHaveNullValidatorImpl.class)//此處指定了注解的實(shí)現(xiàn)類(lèi)

public @interface ListNotHaveNull {

/**

* 添加value屬性，可以作為校驗(yàn)時(shí)的條件,若不需要，可去掉此處定義

/

int value() default 0;

String message() default “List集合中不能含有null元素”;

Class<?>[] groups() default {};

Class<? extends Payload>[] payload() default {};

/*

* 定義List，為了讓Bean的一個(gè)屬性上可以添加多套規(guī)則

*/

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})

@Retention(RUNTIME)

@Documented

@interface List {

ListNotHaveNull[] value();

}

}

編寫(xiě)自定義校驗(yàn)實(shí)現(xiàn)類(lèi)

@Service
public class ListNotHaveNullValidatorImpl implements ConstraintValidator<ListNotHaveNull, List> {
private int value;
@Override
public void initialize(ListNotHaveNull constraintAnnotation) {
//傳入value 值，可以在校驗(yàn)中使用
this.value = constraintAnnotation.value();
}
public boolean isValid(List list, ConstraintValidatorContext constraintValidatorContext) {
for (Object object : list) {
if (object == null) {
//如果List集合中含有Null元素，校驗(yàn)失敗
return false;
} else if (object instanceof String) {
String value = object.toString();
if (value.trim().length() == 0){
return false;
}
}
}
return true;
}
}

model中添加注解：

@Data
public class SysRole {

private Long roleId; @NotBlank(message = "角色名不能為空") private String name; @NotEmpty(message = "資源列表不能為空") @ListNotHaveNull(message = "List 中不能含有null元素") @Valid private List&lt;String&gt; paths;

編寫(xiě)前端控制器

@PostMapping(“/addRole”)

public R addRole(@RequestBody @Valid SysRole sysRole) {

System.out.println(“走到這里說(shuō)明校驗(yàn)成功”);

System.out.println(sysRole);

return R.ok(R.SUCCESS_MSG);

}

使用方法同 “簡(jiǎn)單校驗(yàn)”，在在需要校驗(yàn)的Model上面加上@Valid即可。

通用的Validtor校驗(yàn)工具類(lèi)

public class ValidatorUtils {
private ValidatorUtils() { }

private static Validator validator; static { validator = Validation.buildDefaultValidatorFactory().getValidator(); } /** * 校驗(yàn)對(duì)象 * * @param object 待校驗(yàn)對(duì)象 * @param groups 待校驗(yàn)的組 * @throws RRException 校驗(yàn)不通過(guò)，則報(bào)RRException異常 */ public static void validateEntity(Object object, Class&lt;?&gt;... groups) throws RRException { Set&lt;ConstraintViolation&lt;Object&gt;&gt; constraintViolations = validator.validate(object, groups); if (!constraintViolations.isEmpty()) { Iterator&lt;ConstraintViolation&lt;Object&gt;&gt; iterator = constraintViolations.iterator(); StringBuilder msg = new StringBuilder(); while (iterator.hasNext()) { ConstraintViolation&lt;Object&gt; constraint = iterator.next(); msg.append(constraint.getMessage()).append(','); } throw new RRException(msg.toString().substring(0,msg.toString().lastIndexOf(','))); } }

使用方式，在接收到前端傳遞的參數(shù)后，使用ValidatorUtils.validateEntity(【參數(shù)名】);即可校驗(yàn)，支持分組校驗(yàn)，分組需要定義分組接口。