Spring之数据校验-Validation校验

超、凢脫俗 2022-04-05 20:56 1006阅读 0赞

> ### 前言 ###

SpringMVC提供了强大的数据校验功能，其中有两种方式可以验证输入：

一种是利用Spring自带的Validation校验框架；

另一种是利用JSR303(Java验证规范)实现校验功能

在[Myeclipse+Maven新建SpringMVC项目][Myeclipse_Maven_SpringMVC]基础上继续编写代码。

> ### 步骤 ###

![20181208165825369.png][]

编写校验对象

package com.alin.Validation;
    
    import java.io.Serializable;
    
    public class User implements Serializable {
    	
    	private static final long serialVersionUID = 122196329767341452L;
    
    	private String loginName;
    	
    	private String password;
    	
    	public String getLoginName() {
    		return loginName;
    	}
    	public void setLoginName(String loginName) {
    		this.loginName = loginName;
    	}
    	public String getPassword() {
    		return password;
    	}
    	public void setPassword(String password) {
    		this.password = password;
    	}
    	@Override
    	public String toString() {
    		return "User [loginName=" + loginName + ", password=" + password + "]";
    	}
    }

编写校验类：

package com.alin.Validation;
    
    import org.springframework.stereotype.Repository;
    import org.springframework.validation.Errors;
    import org.springframework.validation.ValidationUtils;
    import org.springframework.validation.Validator;
    
    @Repository("userValidator")
    public class UserValidator implements Validator {
    
    	public boolean supports(Class<?> arg0) {
    		// User指定的Class参数所代表的类或接口是否相同，或是否是其超类或超接口
    		return User.class.isAssignableFrom(arg0);
    	}
    
    	// 对目标类target进行校验，并将校验错误记录在errors当中
    	public void validate(Object target, Errors errors) {
    		// 使用ValidationUtils中的一个静态方法rejectIfEmpty()来对loginname属性进行校验
    		// 若loginname属性是null或者空字符串，就拒绝验证通过
    		ValidationUtils.rejectIfEmpty(errors, "loginName", null, "登陆名不能为空");
    		ValidationUtils.rejectIfEmpty(errors, "password", null, "密码不能为空");
    		User user = (User) target;
    		if (user.getLoginName().length() > 10) {
    			errors.rejectValue("loginName", null, "用户名不能超过10个字符");
    		}
    		if (user.getPassword() != null && !user.getPassword().equals("") && user.getPassword().length() < 6) {
    			errors.rejectValue("password", null, "密码不能小于6位");
    		}
    
    	}
    
    }

编写控制器

package com.alin.Validation;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Qualifier;
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.validation.Errors;
    import org.springframework.web.bind.annotation.ModelAttribute;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    @Controller
    public class UserController {
    	
    	@Autowired
    	@Qualifier("userValidator")
    	private UserValidator userValidator;
    	
    	@RequestMapping(value="/loginForm")
    	public String loginForm(Model model){
    		User user=new User();
    		model.addAttribute("user",user);
    		return "Validation/loginForm";
    	}
    	
    	@RequestMapping(value="/login")
    	public String login(@ModelAttribute User user,
    			Model model,
    			Errors errors){
    		System.out.print(user);
    		model.addAttribute("user",user);
    		userValidator.validate(user, errors);
    		if (errors.hasErrors()) {
    			return "Validation/loginForm";
    		}
    		return "Validation/success";
    		
    	}
    
    }

编写jsp页面

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
    <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
    <%
    String path = request.getContextPath();
    String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
    %>
    
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <html>
      <head>
        <base href="<%=basePath%>">
        
        <title>测试Validator接口验证</title>
      </head>
      
      <body>
        <h3>登陆页面</h3>
        <form:form modelAttribute="user" method="post" action="login">
        	<span>登陆名：</span>
        	<form:input path="loginName"/>
        	<form:errors path="loginName" cssStyle="color:red"/>
        	<span>密码：</span>
        	<form:input path="password"/>
        	<form:errors path="password" cssStyle="color:red"/>
        	<input type="submit" value="提交">
        </form:form>
      </body>
    </html>

![20181208172330773.png][]

![20181208172349327.png][]

> ### 总结 ###

Spring的校验框架在org.springframework.validation包中，其中重要的接口和类如下：

**Validator**。最重要的接口，有两个方法：

boolean support(Class<?> clazz)，该校验器能够对clazz类型的对象进行校验

void validate(Object target,Errors errors)。对目标类target进行校验，并将校验错误记录在errors当中。

**Errors**。Spring用来存放错误信息的接口，SpringMVC框架在将请求数据绑定到入参对象后，就会调用校验框架实施校验，而校验结果保存在处理方法的入参对象之后的参数对象当中，这个保存校验结果的参数对象必须是Errors或者BindingResult类型。一个Errors对象中包含以系列的FieldError和Object对象。FieldError表示与被校验的对象中的某一属性相关的一个错误。BindingResult扩展了Errors接口，同时可以获取数据绑定结果对象的信息。

**ValidationUtils**。Spring提供的一个关于检验的工具类，它提供了多个为Errors对象保存错误的方法。

[Myeclipse_Maven_SpringMVC]: https://blog.csdn.net/Doctor_LY/article/details/84929932
[20181208165825369.png]: /images/20220406/230dc39e98d54b45a6d119b8fcf1c7b0.png
[20181208172330773.png]: /images/20220406/61fae5f25e644d689a81b64c350aa735.png
[20181208172349327.png]: /images/20220406/b6fbdd88156b497381b966f7746db905.png