使用Spring怎么實現請求參數校驗功能

今天就跟大家聊聊有關使用Spring怎么實現請求參數校驗功能，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結了以下內容，希望大家根據這篇文章可以有所收獲。

SpringMVC支持的數據校驗是JSR303的標準，通過在bean的屬性上打上@NotNull、@Max等進行驗證。JSR303提供有很多annotation接口，而SpringMVC對于這些驗證是使用hibernate的實現，所以我們需要添加hibernate的一個validator包：

依賴引用

compile 'javax.validation:validation-api:2.0.0.Final'
compile 'org.hibernate:hibernate-validator:6.0.0.Final'

框架已經提供校驗如下：

JSR提供的校驗注解：     

@Null   被注釋的元素必須為 null   
@NotNull    被注釋的元素必須不為 null,不能為 null , 可以為 ""   
@AssertTrue     被注釋的元素必須為 true   
@AssertFalse    被注釋的元素必須為 false   
@Min(value)     被注釋的元素必須是一個數字，其值必須大于等于指定的最小值   
@Max(value)     被注釋的元素必須是一個數字，其值必須小于等于指定的最大值   
@DecimalMin(value)  被注釋的元素必須是一個數字，其值必須大于等于指定的最小值   
@DecimalMax(value)  被注釋的元素必須是一個數字，其值必須小于等于指定的最大值   
@Size(max=, min=)   驗證對象（Array,Collection,Map,String）長度是否在給定的范圍之內   
@Digits (integer, fraction)     被注釋的元素必須是一個數字，其值必須在可接受的范圍內   
@Past   被注釋的元素必須是一個過去的日期   
@Future     被注釋的元素必須是一個將來的日期   
@Pattern(regex=,flag=)  被注釋的元素必須符合指定的正則表達式   

Hibernate Validator提供的校驗注解： 

@NotBlank(message =)   只能作用在String上，不能為null，而且調用trim()后，長度必須大于0   
@Email  被注釋的元素必須是電子郵箱地址   
@Length(min=,max=)  被注釋的字符串的大小必須在指定的范圍內   
@NotEmpty   被注釋的字符串的必須非空，不能為 null、"",可以為 " "   
@Range(min=,max=,message=)  被注釋的元素必須在合適的范圍內

實例演示

創建需要被校驗的實體類：

package com.yiba.wifi.news.bean.model;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.*;
public class User {
  @NotBlank(message = "用戶名不能為null,長度必須大于0")
  String name;  //用戶名
  @Min(value = 1, message = "最小年齡為1歲")
  @Max(value = 120, message = "最大年齡為120歲")
  Integer age; //年齡
  @Email(message = "郵箱格式錯誤")
  @NotBlank(message = "郵箱格式錯誤")  
  String email; //郵箱
  @Length(min = 6, max = 12, message = "密碼長度必須在6位到12位之間")
  String pwd;//密碼
  //get、set.........
}

注意在校驗郵箱的時候，當 email 為 "", 或者 null 的時候，會通過 @Email驗證,所以郵箱校驗需要 @Email和 @NotBlank 共同起作用。

controller 接口設計，在參數接受的地方添加 @Validated 關鍵字

 /**
   * 登錄接口
   * @return
   */
  @PostMapping("login")
  public String login(@Validated @RequestBody User user) {
    return "ok";
  }

訪問測試：

當訪問數據是如下格式的時候

{
 "name": "",
 "age": 0,
 "email": "",
 "pwd": ""
}

響應為：

{
 "timestamp": 1524640724522,
 "status": 400,
 "error": "Bad Request",
 "exception": "org.springframework.web.bind.MethodArgumentNotValidException",
 "errors": [
  {
   "codes": [
    "NotBlank.user.email",
    "NotBlank.email",
    "NotBlank.java.lang.String",
    "NotBlank"
   ],
   "arguments": [
    {
     "codes": [
      "user.email",
      "email"
     ],
     "arguments": null,
     "defaultMessage": "email",
     "code": "email"
    }
   ],
   "defaultMessage": "郵箱格式錯誤",
   "objectName": "user",
   "field": "email",
   "rejectedValue": "",
   "bindingFailure": false,
   "code": "NotBlank"
  },
  {
   "codes": [
    "NotBlank.user.name",
    "NotBlank.name",
    "NotBlank.java.lang.String",
    "NotBlank"
   ],
   "arguments": [
    {
     "codes": [
      "user.name",
      "name"
     ],
     "arguments": null,
     "defaultMessage": "name",
     "code": "name"
    }
   ],
   "defaultMessage": "用戶名不能為null,長度必須大于0",
   "objectName": "user",
   "field": "name",
   "rejectedValue": "",
   "bindingFailure": false,
   "code": "NotBlank"
  },
  {
   "codes": [
    "Length.user.pwd",
    "Length.pwd",
    "Length.java.lang.String",
    "Length"
   ],
   "arguments": [
    {
     "codes": [
      "user.pwd",
      "pwd"
     ],
     "arguments": null,
     "defaultMessage": "pwd",
     "code": "pwd"
    },
    12,
    6
   ],
   "defaultMessage": "密碼長度必須在6位到12位之間",
   "objectName": "user",
   "field": "pwd",
   "rejectedValue": "",
   "bindingFailure": false,
   "code": "Length"
  },
  {
   "codes": [
    "Min.user.age",
    "Min.age",
    "Min.java.lang.Integer",
    "Min"
   ],
   "arguments": [
    {
     "codes": [
      "user.age",
      "age"
     ],
     "arguments": null,
     "defaultMessage": "age",
     "code": "age"
    },
    1
   ],
   "defaultMessage": "最小年齡為1歲",
   "objectName": "user",
   "field": "age",
   "rejectedValue": 0,
   "bindingFailure": false,
   "code": "Min"
  }
 ],
 "message": "Validation failed for object='user'. Error count: 4",
 "path": "/yiba/sms/login"
}

可以看到本地請求，4個字段校驗都沒通過，那么我有沒有辦法獲取異常信息呢，答案是有的，需要我們修改 controller 接口。

 /**
   * 登錄接口
   *
   * @return
   */
  @PostMapping("login")
  public String login(@Validated @RequestBody User user, BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
      //有校驗沒通過
      List<ObjectError> errorList = bindingResult.getAllErrors();
      for (ObjectError error : errorList) {
        System.out.println(error.getDefaultMessage()); //輸出具體的錯誤信息
      }
      return "參數異常";
    }
    return "ok";
  }

再次請求，請求格式如下

{
 "name": "",
 "age": 0,
 "email": "",
 "pwd": ""
}

響應如下

參數異常

在控制臺打印的信息如下：

用戶名不能為null,長度必須大于0
密碼長度必須在6位到12位之間
最小年齡為1歲
郵箱格式錯誤

可以看到我們已經正常的獲取到了校驗信息了。

下面我們來做一次參照正確的訪問：

請求參數如下：

{
 "name": "zhaoyanjun",
 "age": 1,
 "email": "362299465@qq.com",
 "pwd": "123456"
}

看完上述內容，你們對使用Spring怎么實現請求參數校驗功能有進一步的了解嗎？如果還想了解更多知識或者相關內容，請關注億速云行業資訊頻道，感謝大家的支持。