Spring Validator接口校验与全局异常处理器
Spring Validator接口校验
上一篇日志使用Bean Validation校验机制，对基本数据类型进行校验，方法是在实体类属性上使用注解标识校验方式，最后在Controller类中具体方法的形参里添加@Vlidated注解。Bean Validation校验有一个缺点是，我们的数据校验是在Java实体类里进行约束的，如果我们有多个处理器方法需要用到同一个实体类，那么定义在实体类属性上的校验规则就不好划分了，有的处理器只需要校验一个属性，而有的处理器需要校验多个属性，我们不可能为每一个处理器都创建一个实体类。解决的方法在上一篇日志里也说到，使用分组校验方式，除此之外，还可以使用Spring的Validator接口校验，它允许我们在外部指定某一对象的校验规则。
校验器实现类
Spring的Validator是一个接口，我们自己的校验实现类必须实现这个接口，才可以通过重写方法完成自定义的校验规则，需要我们实现的方法有两个：supports（）和validate（）
public class UserValidator implements Validator {
@Override
public boolean supports(Class<?> clazz) {
// 反射机制通过类的class静态变量获得该类的实例
return User.class.equals(clazz);
}
@Override
public void validate(Object obj, Errors errors) {
// 错误信息放入errors对象
ValidationUtils.rejectIfEmpty(errors, "username", "Username.is.empty",
"用户名不允许为空。");
User user = (User) obj;
if (user.getPassword() == null || user.getPassword().equals("")) {
// rejectValue()参数：错误字段名，全局错误码，默认错误提示信息
errors.rejectValue("password", "Password.is.empty", "密码不允许为空。");
} else if (user.getPassword().length() < 8) {
errors.rejectValue("password", "Length.too.short", "密码长度不能小于八位。");
}
}
}
Support（）方法的功能是判断该校验类，是否支持被校验的实体类。例如我们这个校验类负责对User类进行校验，supports（）方法传入被校验的实体类，通过反射机制获得User类实例，然后判断是否与传入的被校验实体类匹配。Validate（）方法则是进行校验的具体实现方法，方法参数列表中有一个Errors对象，负责往里面存放校验的错误信息。下面就是具体的校验规则了，我们可以使用ValidationUtils校验工具类的方法进行校验，提供的参数依次为存放错误信息对象error，校验的字段名（对于校验实体类中的属性），全局错误码（类似于Bean Validation校验中根据错误码，使用外部properties的错误提示信息），最后一个参数是默认错误提示信息，当全局错误码没有找到对应的提示信息时，使用默认的错误提示信息。
除了使用ValidationUtils校验工具类外，第23行还也可以使用erroe对象的方法，设置获取校验错误信息，参数和ValidationUtils类的方法几乎一致。
Controller实现类
校验器类配置完后，在具体的业务逻辑处理部分，Controller类中使用。
@Controller
@RequestMapping("user")
public class InterfaceValidationController {
@InitBinder
public void initBinder(DataBinder binder) {
// 为DataBinder对象设置Validator校验接口
binder.setValidator(new UserValidator());
}
@RequestMapping("login")
public String login(Model model, @Valid User user, BindingResult result) {
List<ObjectError> allErrors = null;
if (result.hasErrors()) {
allErrors = result.getAllErrors();
// 输出所有错误信息
for(ObjectError objectError : allErrors) {
System.out.println("code = " + objectError.getCode() +
"DefaultMessage = " + objectError.getDefaultMessage());
// 将错误信息发送到前端页面
model.addAttribute("allErrors", allErrors);
}
// 最后返回视图
return "users/login";
} else {
// 如果校验没有错误,跳转到成功登陆的页面
return "users/successLogin";
}
}
首先需要通过initBinder（）方法，在Controller类方法中进行校验器的绑定，方法需要DataBinder对象参数，DataBinder对象的功能是进行数据绑定，可以将数据进行类型转换，设置校验器等。DataBinder有一个成员变量BindingResult，进行了数据绑定了校验器绑定，当校验数据有错误信息时，就会将其放入到BindingResult对象中的Errors属性中，Errors对象集合前面说到，就是用来存放错误信息的。在Controller具体方法的参数列表中对要校验的数据对象User类添加@Valid注解，标识对该对象进行数据校验，接着添加BindingResult对象（这里有一点要注意，BindingResult参数位置必须紧跟在被校验的数据对象后面），当校验出现错误信息时，第15行我们就可以通过该对象的hasErrors（）方法判断校验是否出错，然后使用getAllErrors（）方法获取错误信息进行输出。最后第22行我们将错误信息传到前端页面上显示，给用户提示。
前端页面测试
最后，在前端页面进行简单的登陆测试：
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>登录界面</title>
</head>
<body>
<from action="login.action" method="post">
用户名：<input type="text" name="username" /></br>
密码： <input type="password" name="password" /></br>
<input type="submit" value="登录"/>
<!-- 显示校验错误信息 -->
<c:if test="${allErrors != null }">
<c:forEach items="${allErrors}" var="error">
</br><font color="red">${error.defaultMessage}</font>
</c:forEach>
</c:if>
</from>
</body>
</html>
第15行遍历后台发来的allErrors错误信息集合，如果出现校验出错，则显示错误信息。根据我们前面校验器的配置，对于User类对象的数据校验，用户名和密码都不允许为空：
当输入信息正确，用户名和密码都不为空，且密码长度不低于8位，便可成功跳转：
全局异常处理器Exception Resolver
对于程序运行时的错误信息，我们可以通过查看日志来排查错误，当我们把错误信息传到前端页面时，为了让用户能看懂错误原因，就需要对错误信息进行处理，在信息传送到前端页面前，将其捕获。完成错误信息捕获和加工处理，就需要配置我们的异常处理器。异常处理器用来自定义程序运行时如何解析异常，它需要自定义异常类，里面存储了对应异常的异常信息。还需要配置异常处理器，对于捕捉到的异常，如果是在自定义异常类中配置好的预期异常，则抛出相应的错误信息，否则，就进行其他显示。
自定义异常类
首先是自定义异常类，示例我们定义一个处理User类的异常类和异常处理器，在异常类中，设置对于User类出现异常时的错误信息存储。
package com.mvc.exception;
public class UserException extends Exception {
private static final long serialVersionUID = 1L;
private String exceptionMessage;
public UserException(String exceptionMessage) {
super(exceptionMessage);
this.exceptionMessage = exceptionMessage;
}
public String getExceptionMessage() {
return exceptionMessage;
}
public void setExceptionMessage(String exceptionMessage) {
this.exceptionMessage = exceptionMessage;
}
}
自定义异常类UserException专门负责处理User类异常，它怎么指定处理User类呢？这个是在异常处理器中完成，UserException继承了Exception类，这样我们就可以在具体Controller方法中将其throws抛出该异常。该类中定义了一个异常信息变量，用来存放异常信息，当异常处理器捕获到User类的异常时，通过UserException的构造方法设置异常信息，最后抛出UserException。
异常处理器
来到异常处理器的配置，异常处理器是捕获和处理异常的核心，在Spring MVC中，底层异常会一级一级往上抛，最后到达全局异常处理器，全局异常处理器的工作主要有四步：
- 捕获异常，解析出异常类型。
- 如果异常是预期异常（有定义好的异常类），则抛出相应的异常信息。
- 如果异常不是预期异常，则创建一个自定义异常类，抛出相应的异常信息（如：“未知异常信息”）。
- 将异常信息绑定到前端页面，跳转到相应的异常信息页面中去。
结合上面的自定义异常类，来看看针对User类的异常处理器的配置：
package com.mvc.exception;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
public class UserExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex) {
// 首先解析出异常的类型
UserException userException = null;
if (ex instanceof UserException) {
// 如果异常类型是UserException,则直接创建该类型的异常信息
userException = (UserException) ex;
} else {
// 否则创建一个自定义的异常类型
userException = new UserException("发生未知错误。");
}
// 取出错误信息
String errorMessage = userException.getExceptionMessage();
ModelAndView modelAndView = new ModelAndView();
// 错误信息传送到前端页面
modelAndView.addObject("errorMessage", errorMessage);
// 定向到错误提示页面
modelAndView.setViewName("errorPage/userError");
return modelAndView;
}
}
Spring MVC中，异常信息最终通过DispatcherServlet交由全局异常处理器处理，需要全局异常处理器实现HandlerExceptionResolver接口接，重写里面的resolverException（）方法完成异常处理。该方法中有两个参数要注意，object handler指定异常处理器要处理的对象，Exception ex显然就是接收底层抛出的异常。
在我们的异常处理器UserExceptionResolver中，第14行首先判断异常类型是否我们的定义的预期异常UserException，如果是，则抛出，否则，创建一个自定义异常类型，并给出错误提示“发生未知错误”。最后第26行，对异常信息处理完后，发送到前端页面进行展示，并跳转到错误提示界面。
测试用例
最后要使用我们的异常处理器，先要在Spring配置文件中添加这个异常处理器：
<!-- 配置全局异常处理器 --> <bean class="com.mvc.exception.UserExceptionResolver"></bean>
然后在Controller类方法中做相应的判断，如果出现预期异常，则抛出：
@Controller
@RequestMapping("user")
public class InterfaceValidationController {
@InitBinder
public void initBinder(DataBinder binder) {
// 为DataBinder对象设置Validator校验接口
binder.setValidator(new UserValidator());
}
@RequestMapping("login")
public String login(Model model, @Valid User user, BindingResult result)
throws UserException {
boolean allowVisit = checkUser(user);
if (!allowVisit) {
// 该用户没有访问权限,抛出异常
throw new UserException("您没有权限访问！");
}
List<ObjectError> allErrors = null;
if (result.hasErrors()) {
allErrors = result.getAllErrors();
// 输出所有错误信息
for(ObjectError objectError : allErrors) {
System.out.println("code = " + objectError.getCode() +
"DefaultMessage = " + objectError.getDefaultMessage());
// 将错误信息发送到前端页面
model.addAttribute("allErrors", allErrors);
}
// 最后返回视图
return "users/login";
} else {
// 如果校验没有错误,跳转到成功登陆的页面
return "users/successLogin";
}
}
可以看到第57行最后我们还要跳转到错误页面，将错误信息显示出来：
<%@ page language="java" import="java.util.*"
contentType="text/html; charset=utf-8" pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta charset="utf-8">
<title>错误提示</title>
</head>
<body>
发生异常，错误信息如下：</br>
<h3>
<font color="red">${errorMessage}</font>
</h3></br>
</body>
</html>
完整代码已上传GitHub：
https://github.com/justinzengtm/SSM-Framework/tree/master/SpringMVC_Project
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。
相关推荐
-
Spring中校验器(Validator)的深入讲解
前言 Spring框架的 validator 组件,是个辅助组件,在进行数据的完整性和有效性非常有用,通过定义一个某个验证器,即可在其它需要的地方,使用即可,非常通用. 应用在执行业务逻辑之前,必须通过校验保证接受到的输入数据是合法正确的,但很多时候同样的校验出现了多次,在不同的层,不同的方法上,导致代码冗余,浪费时间,违反DRY原则. 每一个控制器都要校验 过多的校验参数会导致代码太长 代码的复用率太差,同样的代码如果出现多次,在业务越来越复杂的情况下,维护成本呈指数上升. 可以考虑把校验的代
-
springmvc的validator数据校验的实现示例代码
一.什么是数据校验? 这个比较好理解,就是用来验证客户输入的数据是否合法,比如客户登录时,用户名不能为空,或者不能超出指定长度等要求,这就叫做数据校验. 数据校验分为客户端校验和服务端校验 客户端校验:js校验 服务端校验:springmvc使用validation校验,struts2使用validation校验.都有自己的一套校验规则. 二.springmvc的validation校验 Springmvc本身没有校验功能,它使用hibernate的校验框架,hibernate的校验框架和orm
-
springboot使用Validator校验方式
我相信每个做开发的都听过这句"永远不要相信用户的输入",因此后台需要对用户的每个输入项都做校验:手机号.用户名.密码.邮箱.身份证号······这时候就需要hibernate-Validator校验框架登场了,下面介绍springboot如何使用hibernate-Validator进行校验. 引入pom WAIT ~~~ starter-web的依赖 惊不惊喜,意不意外?springboot已帮我们集成了,我们只管拿!来!用! 添加注解 @NotBlank(message = &qu
-
springboot使用hibernate validator校验方式
一.参数校验 在开发中经常需要写一些字段校验的代码,比如字段非空,字段长度限制,邮箱格式验证等等,写这些与业务逻辑关系不大的代码个人感觉有两个麻烦: 验证代码繁琐,重复劳动 方法内代码显得冗长 每次要看哪些参数验证是否完整,需要去翻阅验证逻辑代码 hibernate validator(官方文档)提供了一套比较完善.便捷的验证实现方式. spring-boot-starter-web包里面有hibernate-validator包,不需要引用hibernate validator依赖. 二.hi
-
SpringMVC Validator验证示例
SpringMVC服务器验证一种是有两种方式,一种是基于Validator接口,一种是使用Annotaion JSR-303标准的验证,下面主要是学习这两种,工作中推荐后者,方便很多 一.基于Validator接口的验证. 首先创建User实例,并加入几个属性 public class User { private String username; private String password; private String nickname; public String getUsernam
-
SpringBoot 使用hibernate validator校验
本文将全面的介绍如何使用 validator 进行数据校验 本文源码: https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/springboot-validate 准备工作 我们只需要引入 spring-boot-starter-web 包即可使用 1.常用注解 常用注解 2.简单的实体校验 public class CardDTO { @NotBlank private String cardId; @Size
-
JSP中springmvc配置validator的注意事项
SpringMVC介绍之Validation 对于任何一个应用而言在客户端做的数据有效性验证都不是安全有效的,这时候就要求我们在开发的时候在服务端也对数据的有效性进行验证.SpringMVC自身对数据在服务端的校验有一个比较好的支持,它能将我们提交到服务端的数据按照我们事先的约定进行数据有效性验证,对于不合格的数据信息SpringMVC会把它保存在错误对象中,这些错误信息我们也可以通过SpringMVC提供的标签在前端JSP页面上进行展示. 关于springmvc配置validator的注意事项
-
Spring Validator接口校验与全局异常处理器
Spring Validator接口校验 上一篇日志使用Bean Validation校验机制,对基本数据类型进行校验,方法是在实体类属性上使用注解标识校验方式,最后在Controller类中具体方法的形参里添加@Vlidated注解.Bean Validation校验有一个缺点是,我们的数据校验是在Java实体类里进行约束的,如果我们有多个处理器方法需要用到同一个实体类,那么定义在实体类属性上的校验规则就不好划分了,有的处理器只需要校验一个属性,而有的处理器需要校验多个属性,我们不可能为每一个
-
基于SpringMVC的全局异常处理器介绍
近几天又温习了一下SpringMVC的运行机制以及原理 我理解的springmvc,是设计模式MVC中C层,也就是Controller(控制)层,常用的注解有@Controller.@RequestMapping.@Autowared.@Component,今天呢,我所要写的是SpringMVC的全局异常处理器,关联的接口有HandlerExceptionResolver(Eclipse用户可以按Ctrl+Shift+T进行搜索该接口),什么是全局异常处理器?为什么要用它呢? 在企业开发中,各种
-
Java全局异常处理器实现过程解析
前言 最近稍微闲了一点于是把这个半年都没更新的开源项目 cicada 重新捡了起来. 一些新关注的朋友应该还不知道这项目是干啥的?先来看看官方介绍吧(其实就我自己写的
-
SpringBoot配置GlobalExceptionHandler全局异常处理器案例
1. 创建全局异常处理器类GlobalExceptionHandler @ControllerAdvice: 定义统一的异常处理类,捕获 Controller 层抛出的异常.如果添加 @ResponseBody 返回信息则为JSON格式,这样就不必在每个Controller中逐个定义AOP去拦截处理异常. @RestControllerAdvice: 相当于 @ControllerAdvice 与 @ResponseBody 的结合体. @ExceptionHandler: 统一处理一种类的异常
-
如何基于Springboot完成新增员工功能并设置全局异常处理器
目录 1. 新增员工 1.1 需求分析 1.2 数据模型 1.3 程序执行流程 1.4 代码实现 2 全局异常处理 2.1 新增员工存在的问题 2.2 全局异常处理思路 2.3 全局异常处理器 2.4 全局异常处理器代码实现 2.5 测试 总结 1. 新增员工 1.1 需求分析 后台系统中可以管理员工信息,通过新增员工来添加后台系统用户.点击[添加员工]按钮跳转到新增页面,如下 当填写完表单信息, 点击"保存"按钮后, 会提交该表单的数据到服务端, 在服务端中需要接受数据, 然后将数据
-
yii2 开发api接口时优雅的处理全局异常的方法
前言:个人觉得,学习或温习一套Web框架,在快速阅读一遍文档后,应从路由,控制器,请求/响应对象,数据模型(Logic,Dao,Entity),全局异常处理几个方面下手,这几项了解后,框架上手就游刃有余了.然后我比较喜欢在开工前整理好框架的全局异常处理,方便写 api时错误的统一响应. 在api接口的开发过程中,我们需要对用户数据进行严格的校验,防止非法输入对服务产生安全问题,在开发过程中,我比较喜欢即时的以抛出异常的方式中断请求的处理,并以全局异常处理器格式化处理后统一返回给客户端. 今天就把
-
Spring Boot 捕捉全局异常 统一返回值的问题
在前后端分离的情况下,我们经常会定义一个统一的反回数据格式,通常都会包含状态码,返回信息,返回的数据,是否成功等参数. 1.ResultCode 单独定义了一个ReturnCode枚举类用于存储代码和返回的Message public enum ResultCode { //成功 SUCCESS(200), // 失败 FAIL(400), // 未认证(签名错误) UNAUTHORIZED(401), // 接口不存在 NOT_FOUND(404), // 服务器内部错误 INTERNAL_S
-
在spring中手写全局异常拦截器
为什么要重复造轮子 你可能会问,Spring已经自带了全局异常拦截,为什么还要重复造轮子呢? 这是个好问题,我觉得有以下几个原因 装逼 Spring的全局异常拦截只是针对于Spring MVC的接口,对于你的RPC接口就无能为力了 无法定制化 除了写业务代码,我们其实还能干点别的事 我觉得上述理由已经比较充分的解答了为什么要重复造轮子,接下来就来看一下怎么造轮子 造个什么样的轮子? 我觉得全局异常拦截应该有如下特性 使用方便,最好和spring原生的使用方式一致,降低学习成本 能够支持所有接口
-
Spring MVC全局异常实例详解
目录 无SpringMVC全局异常时的流程图 SpringMVC全局异常流程图 其实是一个ModelAndView对象 配置文件 applicationcontext.xml <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.
-
Spring Boot统一接口返回及全局异常处理
目录 1.解决方案 2.具体实现 2.1 定义状态码统一接口 2.2 公共模块状态码枚举类 2.3 定义全局自定义异常 2.4 定义统一接口格式输出类 2.5 定义统一接口格式输出类 2.6 接口统一输出优化 2.7 子系统如何实现 3.子系统定义状态码,实现BaseResultCode接口 前言: 前段时间接手了一个老项目,现在需要在此项目中添加一些新的需求,同事在开发过程中遇到了一些问题? 1.成功的状态到底是200还是0啊,订单系统200代表成功,而会员系统却是0代表成功. 2.接口返回的