no-image

SpringMVC Hibernate-Validator 引數校驗

                                    

做APP,小程式就上開源眾包。世界盃期間免費領2600元啟動金。
>>>
  

前言:

    Web開發中,最為常見的場景就是前端表單資料、Json資料與後端實體類的繫結,即使JS能校驗並阻止大部分的必填漏填的風險,但並不能防止惡意破壞者修改指令碼。因此後端引數校驗必不可少,但如果針對每一個請求都寫硬程式碼校驗,必然會增加許多重複、冗長的程式碼。

 

解決:

    使用SpringMVC Hibernate-Validator 進行引數校驗,並反饋校驗資訊給前端。

 

實現:

maven依賴:

    <properties>
        <hibernate-version>4.3.1.Final</hibernate-version>
        <spring-version>4.3.7.RELEASE</spring-version>
        <jackson-version>2.7.4</jackson-version>
    </properties>

    <dependencies>
        <!--Hibernate註解-->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>${hibernate-version}</version>
        </dependency>

        <!--Spring-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring-version}</version>
        </dependency>

        <!--支援@ResponseBody註解返回Json-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>${jackson-version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>${jackson-version}</version>
        </dependency>
    </dependencies>

實體類:

/**
 * 功能描述:使用者實體類
 *
 * @author menghao
 * @date 2017/8/30
 */
public class User {

    @NotBlank(message = "使用者名稱必填")
    private String name;

    @NotNull(message = "年齡必填")
    private Integer age;

    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;
    }
}

spring-mvc.xml:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
   	http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
   	http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="com.menghao.validator.controller"/>
    
    <mvc:annotation-driven validator="validator" />

    <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
    </bean>
</beans>

 

場景——Js物件請求:

controller:

/**
 * 功能描述:UserController
 *
 * @author menghao
 * @date 2017/8/30
 */
@Controller
@RequestMapping("user")
public class UserController {

    @PostMapping
    @ResponseBody
    public Result user(@Validated User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            List<String> errMsg = new ArrayList<String>(bindingResult.getFieldErrorCount());
            for (FieldError error : bindingResult.getFieldErrors()) {
                errMsg.add(error.getDefaultMessage());
            }
            return new Result(false, errMsg);
        }
        return new Result(true, "引數正確");
    }
}

測試結果:

//請求
var param = {
    name : "11",
    age : 11
};
$.ajax({
    url : '/user',
    data : param,
    type : 'POST'
});

//響應
{
    "success": true, 
    "data": "引數正確"
}

//請求
$.ajax({
    url : '/user',
    type : 'POST'
});

//響應
{
    "success": false, 
    "data": [
        "使用者名稱必填", 
        "年齡必填"
    ]
}

 

場景——Json格式請求:

controller:

/**
 * 功能描述:UserController
 *
 * @author menghao
 * @date 2017/8/30
 */
@Controller
@RequestMapping("user")
public class UserController {

    @PostMapping
    @ResponseBody
    public Result user(@RequestBody @Validated User user) {
        return new Result(true, "引數正確");
    }

    /**
     * 當Controller中方法丟擲異常時會進入該方法
     *
     * @param e 捕獲異常
     * @return Result 校驗資訊
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Result catchException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<String> errMsg = new ArrayList<String>(bindingResult.getFieldErrorCount());
        for (FieldError error : bindingResult.getFieldErrors()) {
            errMsg.add(error.getDefaultMessage());
        }
        return new Result(false, errMsg);
    }
    
}

測試結果:

//請求
{
	"name" : "menghao"
}

//響應
{
    "success": false,
    "data": [
        "年齡必填"
    ]
}

//請求
{
	"name" : "menghao",
	"age" : 22
}

//響應
{
    "success": true,
    "data": "引數正確"
}

 

總結:

    如果請求引數為Json格式,需要對引數新增@RequestBody,否則無法將資料繫結到物件(值為null)。因此如果繼續使用  @Validated User user, BindingResult bindingResult  ,會造成請求失敗,無法進入對應方法。

    但是仍然需要返回校驗資訊的話,就需要採用異常處理的方式了。在引數校驗失敗時會丟擲MethodArgumentNotValidException異常,這裡採用了@ExceptionHandler來處理。其他常用的處理方式還有:

    <1>實現HandlerExceptionResolver類,在resolveException方法中處理邏輯,不過侷限在於返回的型別為ModelAndView。

    <2>自定義類,使用@controlleradvice註解標記類,並自定義方法來處理捕獲異常邏輯,仍然使用@ExceptionHandler註解來標記方法,並在註解value屬性中指明捕獲的異常型別。


(adsbygoogle = window.adsbygoogle || []).push({});

function googleAdJSAtOnload() {
var element = document.createElement(“script”);
element.src = “//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js”;
element.async = true;
document.body.appendChild(element);
}
if (window.addEventListener) {
window.addEventListener(“load”, googleAdJSAtOnload, false);
} else if (window.attachEvent) {
window.attachEvent(“onload”, googleAdJSAtOnload);
} else {
window.onload = googleAdJSAtOnload;
}