ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Spring MVC - 数据校验(验证器)

2021-01-19 23:01:56  阅读:170  来源: 互联网

标签:验证 Spring 校验 springframework MVC User import org 注解


Spring MVC 数据校验

Spring MVC 提供了两种数据校验的方式:

  • Spring 自带的验证框架 (基于 Validator 接口)。
  • 使用 JSR 303 标准 (基于 Java 验证规范)。

现在,实际项目中用得更多是第二种方式,它更为简洁,方便。它不需要我们自己去编写验证器,通过注解的方式就可以轻松的定义数据的验证规则。但是 Spring 自带的验证框架也是比较普遍的,它设计的数据校验甚至早于JSR 303(Java 验证规范),所以还是有必要简单了解一下的。

方式一: Spring 自带的验证框架

使用 Spring 自带的验证框架需要实现 org.springframework.validation.Validator 接口。

public interface Validator {
    // 判断验证器是否可以处理指定的Class
    // 如果为true则执行validate方法,如果为false则不执行。
    boolean supports(Class<?> clazz);
    // 对目标对象进行验证,并将验证错误填入Error对象。
    void validate(Object target, Errors errors);
}

示例代码:

  • 实体类 User
package com.wind.domain;
import java.util.Date;

public class User{

    private String username;
    private String password;
    private String gender;
    private String email;
    private Date birthDate;
    //  setters and getters not shown.
}
  • Jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<form:form modelAttribute="user" action="/user/regist" method="post">
    <fieldset>
        <legend>创建用户</legend>
        <p>
            <label for="username">用户名:</label>
            <form:input path="username" id="username" tabindex="1" />
            <form:errors path="username" />
        </p>
        <p>
            <label for="password">密码:</label>
            <form:input path="password" id="password" tabindex="2" />
            <form:errors path="password" />
        </p>
        <p>
            <label for="gender">性别:</label>
            <form:input path="gender" id="gender" tabindex="3" />
        </p>
        <p>
            <label for="email">邮箱:</label>
            <form:input path="email" id="email" tabindex="4" />
            <form:errors path="email" />
        </p>
        <p>
            <label for="birthDate">出生日期:</label>
            <form:input path="birthDate" id="birthDate" tabindex="5" />
            <form:errors path="birthDate" />
        </p>
        <p>
            <input type="submit" value="注册" />
            <input type="reset" value="重置" />
        </p>
    </fieldset>
</form:form>
</body>
</html>
  • 验证器 UserValidator
package com.wind.validator;

import com.wind.domain.User;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

public class UserValidator implements Validator {
    @Override 
    public boolean supports(Class<?> clazz) {
        return clazz.equals(User.class);
    }

    @Override 
    public void validate(Object target, Errors errors) {
        // 用户名验证
        ValidationUtils.rejectIfEmpty(errors,"username",null,"用户名不能为空!");

        // 密码验证
        ValidationUtils.rejectIfEmpty(errors,"password",null,"密码不能为空!");

        // 验证邮箱
        User user = (User) target;
        if(!user.getEmail().matches("^\\w+@[a-z0-9]+\\.[a-z]{2,4}$")){
            errors.rejectValue("email",null,"请检查你的电子邮件地址!");
        }
    }
}
  • spring XML文件 配置验证器
<bean id="userValidator" class="com.wind.validator.UserValidator" />
<!-- 启动注解驱动,配置验证器 -->
<mvc:annotation-driven validator="userValidator"/>
  • 控制器 在 UserHandler 给 User 对象添加注解开启验证 @Validated
@PostMapping(value = "/regist")
package com.wind.controller;

import com.wind.domain.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping(value = "/user")
public class UserHandler {

    // The method called create not shown.

    @PostMapping(value = "/regist")
    public String regist(@Validated User user, BindingResult result, Model model){
        if(result.hasErrors()){
            FieldError fieldError = result.getFieldError();
            return "regist";
        }
        model.addAttribute("user",user);
        return "userInfo";
    }
}

方式二:利用 JSR 303 标准

JSR 303 “Bean Validator” 是一个规范文档,指定了一整套API,通过注解给对象属性添加约束。Hibernate Validator 和 Apache BVal 编写了它的实现。所以在使用时,必须要导入相应的依赖。

  • pom.xml 导入相关依赖:hibernate-validator
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.2.1.Final</version>
</dependency>
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
  • 实体类 User 直接使用注解添加验证规则,不需要自己编写验证器
package com.wind.domain;

import org.hibernate.validator.constraints.NotEmpty;
import org.hibernate.validator.constraints.Email;
import javax.validation.constraints.Size;
import java.util.Date;

public class User{

    @NotEmpty(message="用户名不能为空!")
    private String username;

    @NotEmpty(message = "密码不能为空!")
    private String password;

    @Email(regexp = "^\\w+@[a-z0-9]+\\.[a-z]{2,4}$",message = "请检查你的电子邮件地址!")
    private String email;

    private String gender;
    private Date birthDate;
    //  setters and getters not shown.
}
  • Spring XML 文件开启注解驱动
<mvc:annotation-driven />
  • 控制器 在 UserHandler 给 User 对象添加注解开启验证 @Valid
@PostMapping(value = "/regist")
public String regist(@Valid User user, BindingResult result, Model model){
    if(result.hasErrors()){
        FieldError fieldError = result.getFieldError();
        return "regist";
    }
    model.addAttribute("user",user);
    return "userInfo";
}

比较常用的注解

属性描述范例
@Null被注解的属性值必须为Null@Null
@NotNull被注解的属性值必须不为Null@NotNull
@Min被注解的属性值必须是一个大于或等于指定值的整数@Min(150)
@Max被注解的属性值必须是一个小于或等于指定值的证数@Max(150)
@Pattern被注解的属性值必须与指定的常规表达式相匹配@Pattern(regext="\d{3}"
@Size被注解的属性值必须在指定范围内@Size(min=2,max=10
@Email被注解的属性值必须是电子邮箱地址@Email(regext=“expression”)
@NotEmpty被注解的属性值必须不为空@NotEmpty

总结:

  • Converter 和 Formatter 作用于字段,主要实现数据类型的转换。

  • Validator(验证器)作用于对象,主要实现对对象中的字段进行规则校验。

  • 如果一个应用程序包含了转换器和验证器,先会执行转换器对对象的字段进行类型转换,然后验证器才会介入,进行规则校验。

演示案例的下载地址:待上传!

标签:验证,Spring,校验,springframework,MVC,User,import,org,注解
来源: https://blog.csdn.net/qq_42961300/article/details/112854401

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有