當前位置：首頁 > 前端技术 > javascript >内容正文

javascript

Spring Boot参数校验

發布時間：2025/3/17 javascript 26 豆豆

生活随笔收集整理的這篇文章主要介紹了 Spring Boot参数校验小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

1. 概述

作為接口服務提供方，非常有必要在項目中加入參數校驗,比如字段非空，字段長度限制，郵箱格式驗證等等，數據校驗常用到概念：
JSR303/JSR-349: JSR303是一項標準,只提供規范不提供實現，規定一些校驗規范即校驗注解，如@Null，@NotNull，@Pattern，位于javax.validation.constraints包下。JSR-349是其的升級版本，添加了一些新特性。
hibernate validation：hibernate validation是對這個規范的實現，并增加了一些其他校驗注解，如@Email，@Length，@Range等等
spring validation：spring validation對hibernate validation進行了二次封裝，在springmvc模塊中添加了自動校驗，并將校驗信息封裝進了特定的類中，能夠通過BindingResult類在Controller層的處理方法中取得錯誤信息

如何校驗

引入Maven依賴

在pom.xml中加入maven依賴，?validation-api，?hibernate-validator

<dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>1.1.0.Final</version> </dependency><dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId><version>5.4.0.Final</version> </dependency>

spring-boot-starter-web已經依賴了validation-api和hibernate-validator，所以引入spring-boot-starter-web之后就不需要引入這兩個依賴了。

Model上加JSR-303注解類型

JSR-303定義的校驗類型：

空檢查：?
@Null 驗證對象是否為null?
@NotNull 驗證對象是否不為null, 無法查檢長度為0的字符串?
@NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大于0,只對字符串,且會去掉前后空格.?
@NotEmpty 檢查約束元素是否為NULL或者是EMPTY.

Booelan檢查：?
@AssertTrue 驗證 Boolean 對象是否為 true?
@AssertFalse 驗證 Boolean 對象是否為 false

長度檢查：?
@Size(min=, max=) 驗證對象（Array,Collection,Map,String）長度是否在給定的范圍之內?
@Length(min=, max=) Validates that the annotated string is between min and max included.

日期檢查：?
@Past 驗證 Date 和 Calendar 對象是否在當前時間之前?
@Future 驗證 Date 和 Calendar 對象是否在當前時間之后?

數值檢查：?
建議使用在Stirng,Integer類型，不建議使用在int類型上，因為表單值為“”時無法轉換為int，但可以轉換為Stirng為”“,Integer為null?
@Min 驗證 Number 和 String 對象是否大等于指定的值?
@Max 驗證 Number 和 String 對象是否小等于指定的值?
@DecimalMax 被標注的值必須不大于約束中指定的最大值. 這個約束的參數是一個通過BigDecimal定義的最大值的字符串表示.小數存在精度?
@DecimalMin 被標注的值必須不小于約束中指定的最小值. 這個約束的參數是一個通過BigDecimal定義的最小值的字符串表示.小數存在精度?
@Digits 驗證 Number 和 String 的構成是否合法?
@Digits(integer=,fraction=) 驗證字符串是否是符合指定格式的數字，interger指定整數精度，fraction指定小數精度。

@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.?
@Range(min=10000,max=50000,message=”range.bean.wage”)?
private BigDecimal wage;

@Valid 遞歸的對關聯對象進行校驗, 如果關聯對象是個集合或者數組,那么對其中的元素進行遞歸校驗,如果是一個map,則對其中的值部分進行校驗.(是否進行遞歸驗證)?
@CreditCardNumber信用卡驗證?
@Email 驗證是否是郵件地址，如果為null,不進行驗證，算通過驗證。?
@ScriptAssert(lang= ,script=, alias=)?
@URL(protocol=,host=, port=,regexp=, flags=)

@Pattern 驗證 String 對象是否符合正則表達式的規則

hibernate validator校驗demo

先來看一個簡單的demo，添加了Validator的注解：

package com.winner.model;import org.hibernate.validator.constraints.Length;import javax.validation.Valid; import javax.validation.constraints.AssertFalse; import javax.validation.constraints.DecimalMin; import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotNull; import javax.validation.constraints.Pattern; import java.math.BigDecimal; import java.util.List;/*** @author winner_0715* @description:* @date 2018/12/5*/ public class ParamRo {@NotBlank(message = "userName不允許為空")@Length(min = 2, max = 5, message = "userName長度必須在{min}-{max}之間")private String userName;@NotBlank(message="年齡不能為空")@Pattern(regexp="^[0-9]{1,2}$",message="年齡不正確")private String userAge;@NotNull(message = "price不允許為空")@DecimalMin(value = "15.5", message = "價格不能低于 {value}")private BigDecimal price;@AssertFalse(message = "必須為false")private Boolean isFalse;/*** 如果是空，則不校驗，如果不為空，則校驗*/@Pattern(regexp="^[0-9]{4}-[0-9]{2}-[0-9]{2}$",message="出生日期格式不正確")private String birthday;/*** 注意這里必須加@Valid注解*/@Validprivate List<ParamItem> list;public String getUserName() {return userName;}public void setUserName(String userName) {this.userName = userName;}public BigDecimal getPrice() {return price;}public void setPrice(BigDecimal price) {this.price = price;}public String getUserAge() {return userAge;}public void setUserAge(String userAge) {this.userAge = userAge;}public Boolean getFalse() {return isFalse;}public void setFalse(Boolean aFalse) {isFalse = aFalse;}public String getBirthday() {return birthday;}public void setBirthday(String birthday) {this.birthday = birthday;}public List<ParamItem> getList() {return list;}public void setList(List<ParamItem> list) {this.list = list;} }

POST接口驗證，驗證不通過的結果在全局處理器中處理，略

@RequestMapping(value = "/param/validate/post", method = RequestMethod.POST) public ResultBean paramValidationPost(@Valid @RequestBody ParamRo ro) {return ResultBeanUtils.success(ro); }

http://localhost:8080/param/validate/post，請求參數如下

{"userName": "zhangsan","userAge":"1000","price": 25.6,"isFalse":true,"birthday":"1990-09-09","list": [{"address": "beijing"}] }

響應結果

{"success": false,"msg": "年齡不正確;address長度必須在2-5之間;userName長度必須在2-5之間;","data": null,"errorCode": 0 }

參數驗證非常方便，字段上注解+驗證不通過提示信息即可代替手寫一大堆的非空和字段限制驗證代碼。

hibernate的校驗模式

上面例子中一次性返回了所有驗證不通過的集合，通常按順序驗證到第一個字段不符合驗證要求時，就可以直接拒絕請求了。

Hibernate Validator有以下兩種驗證模式：

普通模式

普通模式(會校驗完所有的屬性，然后返回所有的驗證失敗信息)

快速失敗返回　

快速失敗返回模式(只要有一個驗證失敗，則返回)

兩種驗證模式配置方式：

failFast：true? 快速失敗返回模式??? false 普通模式?

ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().failFast( true ).buildValidatorFactory(); Validator validator = validatorFactory.getValidator();

和（hibernate.validator.fail_fast：true? 快速失敗返回模式??? false 普通模式）

ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().addProperty( "hibernate.validator.fail_fast", "true" ).buildValidatorFactory(); Validator validator = validatorFactory.getValidator();

配置hibernate Validator為快速失敗返回模式：

此時相同的輸入，輸出變成

{"success": false,"msg": "年齡不正確;","data": null,"errorCode": 0 }

即快速失敗

GET參數校驗(@RequestParam參數校驗)

?使用校驗bean的方式，沒有辦法校驗RequestParam的內容，一般在處理Get請求(或參數比較少)的時候，會使用下面這樣的代碼：

@RequestMapping(value = "/param/validate/get/2", method = RequestMethod.GET) public ResultBean paramValidationGet2(@RequestParam String name,@RequestParam String address) {return ResultBeanUtils.success(name + address); }

使用@Valid注解，對RequestParam對應的參數進行注解，是無效的，需要使用@Validated注解來使得驗證生效。如下所示：

a.此時需要使用MethodValidationPostProcessor 的Bean：

package com.winner.validate;import org.hibernate.validator.HibernateValidator; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;import javax.validation.Validation; import javax.validation.Validator; import javax.validation.ValidatorFactory;@Configuration public class ValidatorConfiguration {@Beanpublic Validator validator(){ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().addProperty( "hibernate.validator.fail_fast", "true" ).buildValidatorFactory();Validator validator = validatorFactory.getValidator();return validator;}//@Bean//public MethodValidationPostProcessor methodValidationPostProcessor() {// /**默認是普通模式，會返回所有的驗證不通過信息集合*/// return new MethodValidationPostProcessor();//} @Beanpublic MethodValidationPostProcessor methodValidationPostProcessor() {MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();/**設置validator模式為快速失敗返回*/postProcessor.setValidator(validator());return postProcessor;} }

b.方法所在的Controller上加注解@Validated

package com.winner.web;import com.winner.model.ParamRo; import com.winner.model.ResultBean; import com.winner.util.ResultBeanUtils; import org.hibernate.validator.constraints.Length; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.*;import javax.validation.Valid; import javax.validation.constraints.Min; import javax.validation.constraints.NotBlank;/*** @author winner_0715* @description:* @date 2018/12/5*/ @RestController @Validated public class HelloController {@RequestMapping(value = "/param/validate/get/2", method = RequestMethod.GET)public ResultBean paramValidationGet2( @NotBlank(message = "name不允許為空")@Length(min = 2, max = 5, message = "name長度必須在{min}-{max}之間")@RequestParam String name, @Min(value = 18, message = "年齡必須大于18")@RequestParam int age) {return ResultBeanUtils.success(name + age);}}

c.返回驗證信息提示

?驗證不通過時，拋出了ConstraintViolationException異常，使用同一捕獲異常處理：略

d.驗證

?http://localhost:8080/param/validate/get/2?name=zhangsan&age=16

快速失敗模式結果

{"success": false,"msg": "name長度必須在2-5之間;","data": null,"errorCode": 0 }

默認模式結果

{"success": false,"msg": "name長度必須在2-5之間;年齡必須大于18;","data": null,"errorCode": 0 }

對象級聯校驗

對象內部包含另一個對象作為屬性，屬性上加@Valid，可以驗證作為屬性的對象內部的驗證：（驗證Demo2示例時，可以驗證Demo2的字段）

@Data public class Demo2 {@Size(min = 3,max = 5,message = "list的Size在[3,5]")private List<String> list;@NotNull @Validprivate Demo3 demo3; }@Data public class Demo3 {@Length(min = 5, max = 17, message = "length長度在[5,17]之間")private String extField; }

參考：

https://www.cnblogs.com/mr-yang-localhost/p/7812038.html

總結

以上是生活随笔為你收集整理的Spring Boot参数校验的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。