当前位置 主页 > 网站技术 > 代码类 >

    Spring Validator接口校验与全局异常处理器

    栏目:代码类 时间:2019-11-12 12:06

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