Spring Boot Validating 校驗請求參數

目錄

javax.validation.constraints 介紹 開發環境 基礎示例 總結

javax.validation.constraints 介紹

javax.validation.constraints 包含全部 Bean Validation 提供的約束，又稱爲內置約束。參考最新的 Java(TM) EE 7

一、Specification APIs，共提供 13 個註解類：

二、AssertFalse：被註解的元素必須爲 false 或 null

三、AssertTrue：被註解的元素必須爲 true 或 null

四、DecimalMax(value)：被註解的元素必須是一個數字，支持類型包括BigDecimal、BigInteger、CharSequence、byte、short、int、long 以及對應的包裝器類型，可是因爲精度問題並不支持 double 和 float，且值必須小於等於指定的最小值，也接受 null

五、DecimalMin(value)：被註解的元素必須是一個數字，支持類型和 DecimalMax 一致，且值必須大於等於指定的最小值，也接受 nullDigits(fraction, integer)：被註解的元素必須是一個數字，包括BigDecimal、BigInteger、CharSequence、byte、short、int、long 以及對應的包裝器類型，且值必須在可接受的範圍內

六、Future：被註解的元素必須是一個未來的日期或 null，支持類型包括 java.util.Date 和 java.util.Calendar

七、Max(value)：被註解的元素必須是一個數字，支持類型和 DecimalMax 一致，且值必須小於等於指定的最大值

八、Min(value)：被註解的元素必須是一個數字，支持類型和 DecimalMax 一致，且值必須大於等於指定的最小值

九、NotNull：被註解的元素不能爲 null

十、Null：被註解的元素必須爲 null

十一、Past：被註解的元素必須是一個過去的日期，支持類型包括 java.util.Date 和 java.util.Calendar

十二、Pattern(value)：被註解的元素必須符合指定的正則表達式，支持類型 CharSequence，也接受 CharSequence. null

1三、Size(max, min)：被註解的元素大小必須在指定的範圍內，支持類型包括：CharSequence、Collection、Map、Array

開發環境

Oracle JDK 1.8.0_201

Apache Maven 3.6.0

IntelliJ IDEA (Version 2018.3.3)

基礎示例

1/建立 Spring Boot 工程，參考：IntelliJ IDEA 建立 Spring Boot 工程。

2/生成的 pom 文件以下，注意須要添加 spring-boot-starter-web 和 org.hibernate.validator:hibernate-validator 依賴。

< ?xml version="1.0" encoding="UTF-8"?>

< project xmlns="maven.apache.org/POM/4.0.0" xmlns:xsi="www.w3.org/2001/XMLSch…"

xsi:schemaLocation="maven.apache.org/POM/4.0.0 maven.apache.org/xsd/maven-4…">

< modelVersion>4.0.0< /modelVersion>

< parent>

< groupId>org.springframework.boot< /groupId>

< artifactId>spring-boot-starter-parent< /artifactId>

< version>2.1.4.RELEASE< /version>

< relativePath/>

< /parent>

< groupId>tutorial.spring.boot< /groupId>

< artifactId>spring-boot-validating</ artifactId>

< version>0.0.1-SNAPSHOT</ version>

< na me>spring-boot-validating< /name>

< description >Spring Boot Validating< /description>

< properties>

< java.version>1.8< /java.version>

< /properties>

< dependencies>

< dependency>

< groupId>org.springframework.boot</ groupId>

< artifactId>spring-boot-starter-web</ artifactId>

< /dependency>

< dependency>

< groupId>org.hibernate.validator</ groupId>

< artifactId>hibernate-validator</ artifactId>

< version>6.0.16.Final</ version>

< /dependency>

< dependency>

< g roupId>org.springframework.boot< /groupId>

< artifactId>spring-boot-starter-test< /artifactId>

< scope>test< /scope>

< /dependency>

< /dependencies>

< build>

< plugins>

< plugin>

< groupId>org.springframework.boot< /groupId>

< artifactId>spring-boot-maven-plugin< /artifactId>

< /plugin>

< /plugins>

< /build>

< /project>

建立實體類（領域模型）。

package tutorial.spring.boot.validating.domain;

import javax.validation.constraints.*;

import java.util.Date;

public class User {

@NotNull(message = "姓名不能爲空")

@Size(min = 2, max = 20, message = "不知足姓名長度要求：2~20")

private String name;

@NotNull(message = "年齡不能爲空")

@Max(value = 16, message = "不知足最大年齡16歲")

private Integer age;

@Min(value = 150, message = "不知足最小身高1米5")

private Double height;

@Pattern(regexp = "^[1]+@[a-zA-Z0-9-]+(.[a-zA-Z0-9-]+)*.[a-zA-Z0-9]{2,6}$", message =

"不知足郵箱正則表達式")

private String email;

@Past(message = "出生日期非法")

private Date birth;

@AssertTrue(message = "不知足會員要求")

private Boolean member;

public String getName() {

return name;

} public void setName(String name) {

this.name = name;

} public Integer getAge() {

return age;

}

public void setAge(Integer age) {

this.age = age;

} public Double getHeight() {

return height;

} public void setHeight(Double height) {

this.height = height;

} public String getEmail() {

return email; } public void setEmail(String email) {

this.email = email;

} public Date getBirth() {

return birth;

} public void setBirth(Date birth) {

this.birth = birth;

} public Boolean getMember() {

return member;

} public void setMember(Boolean member) {

this.member = member;

} @Override

public String toString() {

return "User{" +

"name='" + name + ''' +

", age=" + age +

", height=" + height +

", email='" + email + ''' +

", birth=" + birth +

", member=" + member +

'}';

}

}

編寫校驗請求的接口。

package tutorial.spring.boot.validating.controller;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.beans.propertyeditors.CustomDateEditor;

import org.springframework.validation.BindingResult;

import org.springframework.web.bind.ServletRequestDataBinder;

import org.springframework.web.bind.annotation.InitBinder;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import tutorial.spring.boot.validating.domain.User;

import javax.servlet.http.HttpServletRequest;

import javax.validation.Valid;

import java.text.SimpleDateFormat;

import java.util.Date;

@RestController

@RequestMapping("/")

public class UserController {

private static final Logger LOGGER = LoggerFactory.getLogger(UserController.class);

@InitBinder

protected void init(HttpServletRequest request, ServletRequestDataBinder binder) {

SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");

format.setLenient(false);

binder.registerCustomEditor(Date.class, new CustomDateEditor(format, false));

}

@PostMapping

public String validateUser(@Valid User user, BindingResult bindingResult) {

if (bindingResult.hasErrors()) {

bindingResult.getAllErrors().forEach(error -> LOGGER.error(error.getDefaultMessage()));

return "User is invalid: " + user;

}

return "User is valid: " + user;

}

} 注意：@InitBinder 註解的 init 方法是用來處理 java.util.Date 類型轉換的（String 轉 Date）。

啓動後使用 Postman 測試。

控制檯打印日誌以下：

2019-04-23 21:09:20.362 ERROR 13380 --- [nio-8080-exec-2] t.s.b.v.controller.UserController : 出生日期非法

2019-04-23 21:09:20.362 ERROR 13380 --- [nio-8080-exec-2] t.s.b.v.controller.UserController : 不知足郵箱正則表達式

2019-04-23 21:09:20.362 ERROR 13380 --- [nio-8080-exec-2] t.s.b.v.controller.UserController : 不知足最大年齡16歲

2019-04-23 21:09:20.362 ERROR 13380 --- [nio-8080-exec-2] t.s.b.v.controller.UserController : 不知足會員要求

2019-04-23 21:09:20.362 ERROR 13380 --- [nio-8080-exec-2] t.s.b.v.controller.UserController : 不知足最小身高1米5

2019-04-23 21:09:20.362 ERROR 13380 --- [nio-8080-exec-2] t.s.b.v.controller.UserController : 不知足姓名長度要求：2~20

總結 源碼：gitee.com/jyl16269386…

---

1. a-zA-Z0-9_.- ↩︎