優(yōu)雅的進(jìn)行全局參數(shù)驗證攔截
參數(shù)驗證如果沒有做全局驗證，就會導(dǎo)致代碼非常臃腫。存在大量的 if 判斷非空語句。今天介紹一種優(yōu)雅的方案。先介紹一個待會用到的注解@InitBinder，它的作用：
從字面上可以看出 @InitBinder 的作用是給 Binder 做初始化的，被此注解的方法可以對 WebDataBinder 初始化。WebDataBinder 是用于表單到方法的數(shù)據(jù)綁定的。
@InitBinder 只在 @Controller 中注解方法來為這個控制器注冊一個綁定器初始化方法，方法只對本控制器有效。
@InitBinder
public void initBinder(WebDataBinder webDataBinder){
//TODO
}
0x01：pom.xml 引入依賴庫
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.olive</groupId>
<artifactId>valid-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.8.RELEASE</version>
<relativePath />
</parent>
<name>valid-demo</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</dependency>
</dependencies>
</project>
雖然是引用 @InitBinder 注解，但是底層框架還是使用 SpringBoot 的驗證框架
0x02：定義 Vo 對象
先定義一個 BaseVo 類，方便進(jìn)行全局參數(shù)判斷。這個類很簡單，代碼如下
package com.olive.vo;
import java.io.Serializable;
public class BaseVo implements Serializable{
}
定義查詢參數(shù)類 UserQueryVo，繼承 BaseVo
package com.olive.vo;
import javax.validation.constraints.NotEmpty;
public class UserQueryVo extends BaseVo {
@NotEmpty(message="不能為空")
private String query;
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
}
關(guān)鍵就是在字段里使用注解，標(biāo)識參數(shù)不能為空
0x03：定義控制器
package com.olive.controller;
import java.util.HashMap;
import java.util.Map;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.olive.vo.UserQueryVo;
@RestController
public class UserController {
@RequestMapping("/user/queryUser")
public Map queryUser(@RequestBody @Validated UserQueryVo queryVo){
Map result = new HashMap();
result.put("code", 200);
result.put("msg", "success");
return result;
}
}
在參數(shù)里使用 @Validated 注解，對 Vo 類進(jìn)行校驗標(biāo)識。其實，正常做到這一步就可以完全進(jìn)行參數(shù)校驗了，但是沒有一個統(tǒng)一攔截的入口。
0x04：添加參數(shù)校驗統(tǒng)一攔截入口
package com.olive;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BeanPropertyBindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.validation.Validator;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import com.olive.vo.BaseVo;
@RestControllerAdvice
public class UserControllerAdvice {
@Autowired
private Validator validator;
@InitBinder
public void initValid(WebDataBinder webDataBinder){
Object target= webDataBinder.getTarget();
if(target==null){
return;
}
if(target instanceof BaseVo){
BeanPropertyBindingResult result = new BeanPropertyBindingResult(target, target.getClass().getSimpleName());
validator.validate(target, result);
List<ObjectError> errors = result.getAllErrors();
if(errors==null || errors.isEmpty()){
return;
}
throw new RuntimeException("參數(shù)錯誤");
}
}
@ExceptionHandler(value = Exception.class)
@ResponseBody
public Map defaultErrorHandler(HttpServletRequest req, Exception e) {
Map result = new HashMap();
result.put("code", 500);
result.put("msg", e.getMessage());
return result;
}
}
該段代碼分析如下
使用 @RestControllerAdvice 進(jìn)行標(biāo)識，該注解可以對標(biāo)注了 @RestController 的控制器進(jìn)行攔截
在 initValid 方法中，使用 @InitBinder標(biāo)識；同時該方法傳入 WebDataBinder 對象，在方法里編寫參數(shù)校驗代碼。如果驗證不過直接拋出異常。這里拋出運行時異常 RuntimeException；實際項目中可以自定義繼承 RuntimeException 的參數(shù)異常類ParamValidExecpiton
在方法 defaultErrorHandler 中， 使用 @ExceptionHandler 標(biāo)識；進(jìn)行全局異常處理，這里直接攔截Exception；實際項目中可以直接攔截自己定義的參數(shù)異常類ParamValidExecpiton。
0x05：編寫引導(dǎo)類
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application
{
public static void main( String[] args )
{
SpringApplication.run(Application.class, args);
}
}
啟動并進(jìn)行驗證
調(diào)試模式可以看到
這樣就達(dá)到了統(tǒng)一控制參數(shù)校驗，不需要分散到不同的代碼塊中了。
喜歡，在看