【SpringMVC】数据转换 & 数据格式化 & 数据校验

SpringMVC 2021-02-09

数据转换 & 数据格式化 & 数据校验

数据绑定流程

  1. Spring MVC 主框架将 ServletRequest 对象及目标方法的入参实例传递给 WebDataBinderFactory 实例，以创建 DataBinder 实例对象
  2. DataBinder 调用装配在 Spring MVC 上下文中的 ConversionService 组件进行数据类型转换、数据格式化工作。将 Servlet 中的请求信息填充到入参对象中
  3. 调用 Validator 组件对已经绑定了请求消息的入参对象进行数据合法性校验，并最终生成数据绑定结果 BindingData 对象
  4. Spring MVC 抽取 BindingResult 中的入参对象和校验错误对象，将它们赋给处理方法的响应入参

Spring MVC 通过反射机制对目标处理方法进行解析，将请求消息绑定到处理方法的入参中。数据绑定的核心部件是 DataBinder，运行机制如下：

数据转换

  • Spring MVC 上下文中内建了很多转换器，可完成大多数 Java 类型的转换工作。
  • ConversionService converters =
    • java.lang.Boolean -> java.lang.String :
      org.springframework.core.convert.support.ObjectToStringConverter@f874ca
    • java.lang.Character -> java.lang.Number : CharacterToNumberFactory@f004c9
    • java.lang.Character -> java.lang.String : ObjectToStringConverter@68a961
    • java.lang.Enum -> java.lang.String : EnumToStringConverter@12f060a
    • java.lang.Number -> java.lang.Character : NumberToCharacterConverter@1482ac5
    • java.lang.Number -> java.lang.Number : NumberToNumberConverterFactory@126c6f
    • java.lang.Number -> java.lang.String : ObjectToStringConverter@14888e8
    • java.lang.String -> java.lang.Boolean : StringToBooleanConverter@1ca6626
    • java.lang.String -> java.lang.Character : StringToCharacterConverter@1143800
    • java.lang.String -> java.lang.Enum : StringToEnumConverterFactory@1bba86e
    • java.lang.String -> java.lang.Number : StringToNumberConverterFactory@18d2c12
    • java.lang.String -> java.util.Locale : StringToLocaleConverter@3598e1
    • java.lang.String -> java.util.Properties : StringToPropertiesConverter@c90828
    • java.lang.String -> java.util.UUID : StringToUUIDConverter@a42f23
    • java.util.Locale -> java.lang.String : ObjectToStringConverter@c7e20a
    • java.util.Properties -> java.lang.String : PropertiesToStringConverter@367a7f
    • java.util.UUID -> java.lang.String : ObjectToStringConverter@112b07f
    • ……

自定义类型转换器

  • ConversionService 是 Spring 类型转换体系的核心接口。
  • 可以利用 ConversionServiceFactoryBean 在 Spring 的 IOC 容器中定义一个 ConversionService. Spring 将自动识别出 IOC 容器中的 ConversionService，并在 Bean 属性配置及 Spring MVC 处理方法入参绑定等场合使用它进行数据的转换
  • 可通过 ConversionServiceFactoryBean 的 converters 属性注册自定义的类型转换器
<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
  <property name="converters">
    <list>
      <bean class="com.nemo.springmvc.UserConverter"></bean>
    </list>
  </property>
</bean>

Spring 支持的转换器

Spring 定义了 3 种类型的转换器接口，实现任意一个转换器接口都可以作为自定义转换器注册到 ConversionServiceFactroyBean 中：

  • Converter<S,T>：将 S 类型对象转为 T 类型对象
  • ConverterFactory：将相同系列多个 “同质” Converter 封装在一起。如果希望将一种类型的对象转换为另一种类型及其子类的对象（例如将 String 转换为 Number 及 Number 子类 （Integer、Long、Double 等）对象）可使用该转换器工厂类
  • GenericConverter：会根据源类对象及目标类对象所在的宿主类 中的上下文信息进行类型转换

自定义转换器示例

<mvc:annotation-driven conversion-service=“conversionService”/> 会将自定义的 ConversionService 注册到 Spring MVC 的上下文中

<mvc:annotation-driven conversion-ervice="conversionService"></mvc:annotation-driven>

<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
  <property name="converters">
    <list>
      <bean class="com.nemo.springmvc.UserConverter"></bean>
    </list>
  </property>
</bean>
@RequestMapping("/handle24")
public String handle24(@RequestParam("user") User user) {
    System.out.println(user);
    return "success";
}

关于 mvc:annotation-driven

  • <mvc:annotation-driven/> 会自动注册RequestMappingHandlerMapping、RequestMappingHandlerAdapter 与 ExceptionHandlerExceptionResolver 三个bean。
  • 还将提供以下支持：
    • 支持使用 ConversionService 实例对表单参数进行类型转换
    • 支持使用 @NumberFormat annotation、@DateTimeFormat 注解完成数据类型的格式化
    • 支持使用 @Valid 注解对 JavaBean 实例进行 JSR 303 验证
    • 支持使用 @RequestBody 和 @ResponseBody 注解

既没有配置 <mvc:default-servlet-handler/> 也没有配置 <mvc:annotation-driven/>

配置了 <mvc:default-servlet-handler/> 但没有配置 <mvc:annotation-driven/>

既配置了 <mvc:default-servlet-handler/> 又配置 <mvc:annotation-driven/>

@InitBinder

  • 由 @InitBinder 标识的方法，可以对 WebDataBinder 对象进行初始化。WebDataBinder 是 DataBinder 的子类，用于完成由表单字段到 JavaBean 属性的绑定
  • @InitBinder方法不能有返回值，它必须声明为void。
  • @InitBinder方法的参数通常是是 WebDataBinder
/**
 * 不自动绑定对象中的 roleSet 属性，另行处理。
 */
@InitBinder
public void intBinder(WebDataBinder dataBinder) {
    dataBinder.setDisallowFields("roleSet");
}

数据格式化

  • 对属性对象的输入/输出进行格式化，从其本质上讲依然属于 “类型转换” 的范畴。
  • Spring 在格式化模块中定义了一个实现 ConversionService 接口的 FormattingConversionService 实现类，该实现类扩展了 GenericConversionService，因此它既具有类型转换的功能，又具有格式化的功能
  • FormattingConversionService 拥有一个 FormattingConversionServiceFactroyBean 工厂类，后者用于在 Spring 上下文中构造前者
  • FormattingConversionServiceFactroyBean 内部已经注册了:
    • NumberFormatAnnotationFormatterFactroy：支持对数字类型的属性使用 @NumberFormat 注解
    • JodaDateTimeFormatAnnotationFormatterFactroy：支持对日期类型的属性使用 @DateTimeFormat 注解
  • 装配了 FormattingConversionServiceFactroyBean 后，就可以在 Spring MVC 入参绑定及模型数据输出时使用注解驱动了。
    <mvc:annotation-driven/> 默认创建的 ConversionService 实例即为 FormattingConversionServiceFactroyBean

日期格式化

@DateTimeFormat 注解可对 java.util.Date、java.util.Calendar、java.long.Long 时间类型进行标注：

  • pattern 属性：类型为字符串。指定解析/格式化字段数据的模式，如：”yyyy-MM-dd hh:mm:ss”
  • iso 属性：类型为 DateTimeFormat.ISO。指定解析/格式化字段数据的ISO模式，包括四种：ISO.NONE（不使用） -- 默 认、ISO.DATE(yyyy-MM-dd) 、ISO.TIME(hh:mm:ss.SSSZ)、ISO.DATE_TIME(yyyy-MM-dd hh:mm:ss.SSSZ)
  • style 属性：字符串类型。通过样式指定日期时间的格式，由两位字符组成，第一位表示日期的格式，第二位表示时间的格式：S：短日期/时间格式、M：中日期/时间格式、L：长日期/时间格式、F：完整日期/时间格式、-：忽略日期或时间格式

数值格式化

@NumberFormat 可对类似数字类型的属性进行标注，它拥有两个互斥的属性：

  • style：类型为 NumberFormat.Style。用于指定样式类型，包括三种：Style.NUMBER（正常数字类型）、Style.CURRENCY（货币类型）、 Style.PERCENT（百分数类型）
  • pattern：类型为 String，自定义样式，如patter="#,###"；

格式化示例

<mvc:annotation-driven></mvc:annotation-driven>
public class User {
    @DateTimeFormat(pattern="yyyy/MM/dd")
    private Date birthday;

    @NumberFormat(pattern="#,###.###")
    private Double wages;
}
@RequestMapping("/handle19")
public String handle19(@ModelAttribute("user") User user) {
    user.setId(1000);
    System.out.println(user);
    return "success";
}

数据校验

JSR 303

  • JSR 303 是 Java 为 Bean 数据合法性校验提供的标准框架，它已经包含在 JavaEE 6.0 中
  • JSR 303 通过在 Bean 属性上标注类似于 @NotNull、@Max 等标准的注解指定校验规则，并通过标准的验证接口对 Bean 进行验证
注解 功能说明
@Null 被注解的元素必须为null
@NotNull 被注解的元素必须不为null
@AssertTure 被注解的元素必须为true
@AssertFalse 被注解的元素必须为false
@Min(value) 被注解的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注解的元素必须是一个数字其值必须小于等于指定的最大值
@DecimalMin(value) 被注解的元素必须是一个数字其值必须大于等于指定的最小值
@DecimalMax(value) 被注解的元素必须是一个数字其值必须小于等于指定的最大值
@Size(max,min) 被注解的元素的大小必须在指定的范围内
@Digits(integer,fraction) 被注解的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注解的元素必须是一个过去的日期
@Future 被注解的元素必须是一个将来的日期
@Pattern(value) 被注解的元素必须符合指定的正则表达式

Hibernate Validator 扩展注解

Hibernate Validator 是 JSR 303 的一个参考实现，除支持所有标准的校验注解外，它还支持以下的扩展注解

注解 功能说明
@Email 被注解的元素必须是电子邮箱地址
@Length 被注解的字符串的大小必须在指定的范围内
@NotEmpty 被注解的字符串必须非空
@Range 被注解的元素必须在合适的范围内

Spring MVC 数据校验

  • Spring 4.0 拥有自己独立的数据校验框架，同时支持 JSR 303 标准的校验框架。
  • Spring 在进行数据绑定时，可同时调用校验框架完成数据校验工作。在 Spring MVC 中，可直接通过注解驱动的方式进行数据校验
  • Spring 的 LocalValidatorFactroyBean 既实现了 Spring 的 Validator 接口，也实现了 JSR 303 的 Validator 接口。只要在 Spring 容器中定义了一个 LocalValidatorFactoryBean，即可将其注入到需要数据校验的 Bean 中。

  • Spring 本身并没有提供 JSR303 的实现，所以必须将 JSR303 的实现者的 jar 包放到类路径下。

  • <mvc:annotation-driven/> 会默认装配好一个 LocalValidatorFactoryBean，通过在处理方法的入参上标 注 @valid 注解即可让 Spring MVC 在完成数据绑定后执行数据校验的工作
  • 在已经标注了 JSR303 注解的表单/命令对象前标注一个 @Valid，Spring MVC 框架在将请求参数绑定到该入参对象后，就会调用校验框架根据注解声明的校验规则实施校验

  • Spring MVC 是通过对处理方法签名的规约来保存校验结果的：前一个表单/命令对象的校验结果保存到随后的入参中，这个保存校验结果的入参必须是 BindingResult 或 Errors 类型，这两个类都位于 org.springframework.validation 包中

  • 需校验的 Bean 对象和其绑定结果对象或错误对象时成对出现的，它们 之间不允许声明其他的入参
  • Errors 接口提供了获取错误信息的方法，如 getErrorCount() 或 getFieldErrors(String field)

  • BindingResult 扩展了 Errors 接口

在目标方法中获取校验结果

  • 在表单/命令对象类的属性中标注校验注解，在处理方法对 应的入参前添加 @Valid，Spring MVC 就会实施校验并将校验结果保存在被校验入参对象之后的 BindingResult 或 Errors 入参中。
  • 常用方法：
    • FieldError getFieldError(String field)
    • List getFieldErrors()
    • Object getFieldValue(String field)
    • Int getErrorCount()

在页面上显示错误

  • Spring MVC 除了会将表单/命令对象的校验结果保存到对应的 BindingResult 或 Errors 对象中外，还会将所有校验 结果保存到 “隐含模型”
  • 即使处理方法的签名中没有对应于表单/命令对象的结果入参，校验结果也会保存在 “隐含对象” 中。
  • 隐含模型中的所有数据最终将通过 HttpServletRequest 的属性列表暴露给 JSP 视图对象，因此在 JSP 中可以获取错误信息
  • 在 JSP 页面上可通过
    显示错误消息

示例

index.jsp

<form:form action="hello/handle19.action" modelAttribute="user">
  <form:errors path="*"></form:errors>
  
  name:<input type="text" name="userName"/>
  <form:errors path="userName"></form:errors>

  email:<input type="text" name="email"/>
  <form:errors path="email"></form:errors>

  <input type="submit" value="Submit"/>
</form:form>

User.java

public class User {
    @DateTimeFormat(pattern="yyyy/MM/dd")
    @Past
    private Date birthday;

    @NumberFormat(pattern="#,###.##")
    @DecimalMax("9999")
    @DecimalMin("1000")
    private long salary;

    @Pattern(regexp="\\w{4,30}")
    private String userName;

    @Email
    private String email;
}

目标方法

@RequestMapping("/handle19")
public String handle19(@Valid @ModelAttribute("user") User user,BindingResult bindingResult) {
    if(bindingResult.hasErrors) {
        return "forward:/index.jsp"
    } else {
        System.out.println("验证通过。。。");
    }
    user.setId(1000);
    System.out.println(user);
    return "success"
}

提示消息的国际化

  • 每个属性在数据绑定和数据校验发生错误时，都会生成一个对应的 FieldError 对象。
  • 当一个属性校验失败后，校验框架会为该属性生成 4 个消息代码，这些代码以校验注解类名为前缀，结合 modleAttribute、属性名及属性类型名生成多个对应的消息代码：例如 User 类中的 password 属性标准了一个 @Pattern 注解，当该属性值不满足 @Pattern 所定义的规则时,就会产生以下 4 个错误代码：
    • Pattern.user.password
    • Pattern.password
    • Pattern.java.lang.String
    • Pattern

  • 当使用 Spring MVC 标签显示错误消息时， Spring MVC 会查看 WEB 上下文是否装配了对应的国际化消息，如果没有，则显示默认 的错误消息，否则使用国际化消息。

  • 若数据类型转换或数据格式转换时发生错误，或该有的参数不存在，或调用处理方法时发生错误，都会在隐含模型中创建错误消息。其错误代码前缀说明如下：
    • required：必要的参数不存在。如 @RequiredParam(“param1”) 标注了一个入参，但是该参数不存在
    • typeMismatch：在数据绑定时，发生数据类型不匹配的问题
    • methodInvocation：Spring MVC 在调用处理方法时发生了错误

  • 注册国际化资源文件
    xml <bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource"> <property name="basename" value="i18n"></property> </bean>

相关文章

SpringMVC之异常处理器的使用
开发过程中是不可避免地会出现各种异常情况的，例如网络连接...
Sping的AOP基本教程(使用注解方式)
说明：使用注解方式实现AOP切面。 什么是AOP？ 面向切面编程...
SpringMVC拦截器的使用
Spring MVC中的拦截器是一种可以在请求处理过程中对请求进行...
SpringMVC之域对象共享数据的多种方式
在 JavaWeb 中，共享域指的是在 Servlet 中存储数据，以便在...
SpringMVC实现文件上传&下载功能
文件上传 说明： 使用maven构建web工程。 使用Thymeleaf技术...
使用纯注解替换Spring配置文件&SpringMVC配置文件
创建初始化类，替换web.xml 在Servlet3.0环境中，Web容器(To...