SpringMVC + Hibernate-Validator 参数校验

最新推荐文章于 2024-07-27 13:31:57 发布

weixin_34049032

最新推荐文章于 2024-07-27 13:31:57 发布

阅读量107

点赞数

文章标签： java json 前端 ViewUI

原文链接：https://my.oschina.net/marvelcode/blog/1526294

版权

2019独角兽企业重金招聘Python工程师标准>>>

前言：

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": "参数正确"
}