Spring MVC 学习笔记 data binding conversionService

最新推荐文章于 2021-11-08 10:59:04 发布

琅琊山二当家

最新推荐文章于 2021-11-08 10:59:04 发布

阅读量2.9k

点赞数

分类专栏： spring

spring 专栏收录该内容

65 篇文章 0 订阅

订阅专栏

Servlet中的输入参数为都是string类型，而spring mvc通过data bind机制将这些string 类型的输入参数转换为相应的command object（根据view和controller之间传输数据的具体逻辑，也可称为model attributes, domain model objects）。在这个转换过程中，spring实际是先利用java.beans.PropertyEditor中的 setAdText方法来把string格式的输入转换为bean属性，亦可通过继承java.beans.PropertyEditorSupport来实现自定义的PropertyEditors,具体实现方式可参考spring reference 3.0.5 第 5.4节中的 Registering additional custom PropertyEditors部分。自定义完毕propertyEditor后，有以下几种方式来注册自定义的customer propertyEditor.

1:直接将自定义的propertyEditor放到需要处理的java bean相同的目录下

名称和java Bean相同但后面带Editor后缀。例如需要转换的java bean 名为User,则在相同的包中存在UserEditor类可实现customer propertyEditor的自动注册。

2:利用@InitBinder来注册customer propertyEditor

这个在之前的笔记中已经介绍过了，即在controller类中增加一个使用@InitBinder标注的方法，在其中注册customer Editor

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        dateFormat.setLenient(false);
        binder.registerCustomEditor(Date.class, new CustomDateEditor(
                dateFormat, false));
    }

3:继承 WebBindingInitializer 接口来实现全局注册 使用@InitBinder只能对特定的controller类生效，为注册一个全局的customer Editor，可以实现接口WebBindingInitializer 。

public class CustomerBinding implements WebBindingInitializer {
    @Override
    public void initBinder(WebDataBinder binder, WebRequest request) {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        dateFormat.setLenient(false);
        binder.registerCustomEditor(Date.class, new CustomDateEditor(
                dateFormat, false));

    }

并修改 servlet context xml配置文件

<bean
        class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="webBindingInitializer">
            <bean
                class="net.zhepu.web.customerBinding.CustomerBinding" />
        </property>
    </bean>

但这样一来就无法使用mvc:annotation-driven 了。
使用conversion-service来注册自定义的converter DataBinder实现了PropertyEditorRegistry, TypeConverter这两个interface，而在spring mvc实际处理时，返回值都是return binder.convertIfNecessary(见HandlerMethodInvoker中的具体处理逻辑)。因此可以使用customer conversionService来实现自定义的类型转换。

        <bean id="conversionService"
        class="org.springframework.format.support.FormattingConversionServiceFactoryBean">

        <property name="converters">
            <list>
                <bean class="net.zhepu.web.customerBinding.CustomerConverter" />
            </list>
        </property>
        
    </bean>

需要修改spring service context xml配置文件中的annotation-driven,增加属性conversion-service指向新增的conversionService bean。

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

实际自定义的converter如下。

 public class CustomerConverter implements Converter<String, Date> {
    @Override
    public Date convert(String source) {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        dateFormat.setLenient(false);
        try {
            return dateFormat.parse(source);
        } catch (ParseException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }        
        return null;
    }

对于requestBody或httpEntity中数据的类型转换 Spring MVC中对于requestBody中发送的数据转换不是通过databind来实现，而是使用HttpMessageConverter来实现具体的类型转换。例如，之前提到的json格式的输入，在将json格式的输入转换为具体的model的过程中，spring mvc首先找出request header中的contenttype，再遍历当前所注册的所有的HttpMessageConverter子类，根据子类中的canRead()方法来决定调用哪个具体的子类来实现对requestBody中的数据的解析。如果当前所注册的httpMessageConverter中都无法解析对应contexttype类型，则抛出HttpMediaTypeNotSupportedException （http 415错误）。那么需要如何注册自定义的messageConverter呢，很不幸，在spring 3.0.5中如果使用annotation-driven的配置方式的话，无法实现自定义的messageConverter的配置，必须老老实实的自己定义AnnotationMethodHandlerAdapter的bean定义，再设置其messageConverters以注册自定义的messageConverter。在3.1版本中，将增加annotation-driven对自定义的messageConverter的支持 (SPR-7504)，具体格式如下

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"/>
    </mvc:message-converters>
</mvc:annotation-driven>

另一篇：

第四章：数据类型转换——深入浅出学Spring Web MVC
浏览(21174)|评论(0) 交流分类：Java|笔记分类: SpringMVC

配套视频课程地址： http://sishuok.com/product/701

配套视频PPT下载地址： http://sishuok.com/forum/posts/list/6981.html

第一章：Spring Web MVC入门——深入浅出学Spring Web MVC

第二章：理解DispatcherServlet ——深入浅出学Spring Web MVC

第三章：注解式控制器开发详解 ——深入浅出学Spring Web MVC

第四章：数据类型转换——深入浅出学Spring Web MVC

第五章：数据格式化——深入浅出学Spring Web MVC

第六章：数据验证——深入浅出学Spring Web MVC

第七章：视图解析器——深入浅出学Spring Web MVC

第八章：拦截器——深入浅出学Spring Web MVC

第九章：对Ajax的支持——深入浅出学Spring Web MVC

第十章：文件上传下载——深入浅出学Spring Web MVC

第十一章：表单标签——深入浅出学Spring Web MVC

数据类型转换简介

当从页面提交数据到后台Action的时候，通过请求发送的数据，通常都是字符串类型的，不能满足后台Model中的数据类型的需要，因此需要进行数据类型转换。

从Spring3开始，我们可以使用如下架构进行类型转换、验证及格式化

n基本的流程

①：类型转换：内部的ConversionService会根据S源类型/T目标类型自动选择相应的Converter SPI进行类型转换，而且是强类型的，能在任意类型数据之间进行转换；

②：数据验证：支持JSR-303验证框架，如将@Valid放在需要验证的目标类型上即可；

③：格式化显示：其实就是任意目标类型---->String的转换，完全可以使用Converter SPI完成。

nSpring为了更好的诠释格式化/解析功能提供了Formatter SPI，支持根据Locale信息进行格式化/解析，而且该套SPI可以支持字段/参数级别的细粒度格式化/解析，流程如下：

①：类型解析（转换）：String---->T类型目标对象的解析，和PropertyEditor类似；

③：格式化显示：任意目标类型---->String的转换，和PropertyEditor类似。

Formatter SPI最大特点是能进行字段/参数级别的细粒度解析/格式化控制，即使是Converter SPI也是粗粒度的（到某个具体类型，而不是其中的某个字段单独控制），目前Formatter SPI还不是很完善。

Formatter SPI内部实现实际委托给Converter SPI进行转换，即约束为解析/格式化String<---->任意目标类型。

在Spring Web MVC环境中，数据类型转换、验证及格式化通常是这样使用的

①、类型转换：首先表单数据（全部是字符串）通过WebDataBinder进行绑定到命令对象，内部通过Converter SPI实现；

②：数据验证：使用JSR-303验证框架进行验证；

③：格式化显示：在表单页面可以通过如下方式展示通过内部通过Converter SPI格式化的数据和错误信息：

内建的类型转换器

第一组：标量转换器

1：StringToBooleanConverter ：String----->Boolean

如：true:true/on/yes/1； false:false/off/no/0

2：ObjectToStringConverter ：Object----->String ，调用toString方法转换

3：StringToNumberConverterFactory ：String----->Number（如Integer、Long等）

4：NumberToNumberConverterFactory ：Number子类型(Integer、Long、Double等)<——> Number子类型(Integer、Long、Double等)

5：StringToCharacterConverter ：String----->java.lang.Character，取字符串第一个字符

6：NumberToCharacterConverter ：Number子类型(Integer、Long、Double等)——> java.lang.Character

7：CharacterToNumberFactory ：java.lang.Character ——>Number子类型(Integer、Long、Double等)

8：StringToEnumConverterFactory ：String----->enum类型，通过Enum.valueOf将字符串转换为需要的enum类型

9：EnumToStringConverter ：enum类型----->String，返回enum对象的name()值

10：StringToLocaleConverter ：String----->java.util.Local

11：PropertiesToStringConverter ：java.util.Properties----->String，默认通过ISO-8859-1解码

12：StringToPropertiesConverter ：String----->java.util.Properties，默认使用ISO-8859-1编码

第二组：集合、数组相关转换器

1：ArrayToCollectionConverter ：任意S数组---->任意T集合（List、Set）

2：CollectionToArrayConverter ：任意T集合（List、Set）---->任意S数组

3：ArrayToArrayConverter ：任意S数组<---->任意T数组

4：CollectionToCollectionConverter ：任意T集合（List、Set）<---->任意T集合（List、Set），即集合之间的类型转换

5：MapToMapConverter ：Map<---->Map之间的转换

6：ArrayToStringConverter ：任意S数组---->String类型

7：StringToArrayConverter ：String--->数组，默认“,”分割，且去除字符串的两边空格

8：ArrayToObjectConverter ：任意S数组---->任意Object的转换，(如果目标类型和源类型兼容，直接返回源对象；否则返回S数组的第一个元素并进行类型转换)

9：ObjectToArrayConverter ：Object----->单元素数组

10：CollectionToStringConverter ：任意T集合（List、Set）---->String类型

11：StringToCollectionConverter ：String----->集合（List、Set），默认通过“,”分割，且去除字符串的两边空格(trim)

12：CollectionToObjectConverter ：任意T集合---->任意Object的转换，(如果目标类型和源类型兼容，直接返回源对象；否则返回S数组的第一个元素并进行类型转换)

13：ObjectToCollectionConverter ：Object----->单元素集合

第三组：默认（fallback）转换器

之前的转换器不能转换时调用

1：ObjectToObjectConverter ：

Object（S）----->Object（T），首先尝试valueOf进行转换、没有则尝试new 构造器(S)

2：IdToEntityConverter ：

Id(S)----->Entity(T)，查找并调用public static T find[EntityName](S)获取目标对象，EntityName是T类型的简单类型

3：FallbackObjectToStringConverter ：

Object----->String，ConversionService作为恢复使用，即其他转换器不能转换时调用（执行对象的toString()方法）

如上的转换器在使用转换服务实现DefaultConversionService和DefaultFormattingConversionService时会自动注册

n通过一个示例来说明，实现自定义String----->PhoneNumberModel的转换器

public class StringToPhoneNumberConverter implements Converter<String, PhoneNumberModel> {

Pattern pattern = Pattern.compile("^(\\d{3,4})-(\\d{7,8})$");

public PhoneNumberModel convert(String source) {

if(!StringUtils.hasLength(source)) {

//①如果source为空返回null

return null;

}

Matcher matcher = pattern.matcher(source);

if(matcher.matches()) {

//②如果匹配进行转换

PhoneNumberModel phoneNumber = new PhoneNumberModel();

phoneNumber.setAreaCode(matcher.group(1));

phoneNumber.setPhoneNumber(matcher.group(2));

return phoneNumber;

} else {

//③如果不匹配转换失败

throw new IllegalArgumentException(String.format("类型转换失败，需要格式[010-12345678]，但格式是[%s]", source));

}

} }

n使用的PhoneNumberModel

public class PhoneNumberModel {

private String areaCode;//区号

private String phoneNumber;//电话号码

//省略getter/setter

}

n简单的测试代码如下：

public static void main(String[] args) {

DefaultConversionService conversionService = new DefaultConversionService();

conversionService.addConverter(new StringToPhoneNumberConverter());

String phoneNumberStr = "010-12345678";

PhoneNumberModel phoneNumber = conversionService.convert(phoneNumberStr, PhoneNumberModel.class);

System.out.println("phoneNumber=="+phoneNumber);

}

n集成到Spring Web MVC环境

1：注册ConversionService实现和自定义的类型转换器

<list>

</list>

</property>

</bean>

FormattingConversionServiceFactoryBean：是FactoryBean实现，默认使用DefaultFormattingConversionService转换器服务实现；

converters：注册我们自定义的类型转换器，此处注册了String--->PhoneNumberModel。

n2：通过ConfigurableWebBindingInitializer注册ConversionService

</bean>

n3：注册ConfigurableWebBindingInitializer到RequestMappingHandlerAdapter

</bean>

通过如上配置，我们就完成了Spring3.0的类型转换系统与Spring Web MVC的集成。

n如果是使用的<mvc:annotation-drive>的方式，那么上面的第2和3步就不用做了，直接在<mvc:annotation-drive>里面配置conversion-service属性即可，示例：

<mvc:annotation-driven

conversion-service="conversionService"

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"/>
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"/>
    </mvc:message-converters>
</mvc:annotation-driven>

琅琊山二当家

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Spring MVC 学习笔记 data binding conversionService

Servlet中的输入参数为都是string类型，而spring mvc通过data bind机制将这些string 类型的输入参数转换为相应的command object（根据view和controller之间传输数据的具体逻辑，也可称为model attributes, domain model objects）。在这个转换过程中，spring实际是先利用java.beans.Property
复制链接

扫一扫