SpringMVC 自定义类型转换器 如String转Date等

我们在使用SpringMVC时，常常需要把表单中的参数映射到我们对象的属性中，我们可以在默认的spring-servlet.xml加上如下的配置即可做到普通数据类型的转换，如将String转换成Integer和Double等：

<mvc:annotation-driven />
　　或
<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean" />

　　其实  <mvc:annotation-driven /> 标签会默认创建并注册一个 RequestMappingHandlerMapping（在Spring3.2之前是DefaultAnnotationHandlerMapping） 和 RequestMappingHandlerAdapter （Spring3.2之前是AnnotationMethodHandlerAdapter），当然，如果上下文有对应的显示实现类，将该注解注册的覆盖掉。该注解还会创建一个ConversionService，即 FormattingConversionServiceFactoryBean。

 

　　如果想把一个字符串转换成其它实体类型，spring没有提供这样默认的功能，我们需要自定义类型转换器。

　　这里有个实体类Employee。

package com.proc;

public class Employee {

    private String name;
    private Integer age;
    private String gender;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getGender() {
        return gender;
    }
    public void setGender(String gender) {
        this.gender = gender;
    }
    @Override
    public String toString() {
        return "Employee [name=" + name + ", age=" + age + ", gender=" + gender
                + "]";
    }
    
}

规定将字符串转换成实体类的规则为：  name-age-gender

　　那么接下来就写一个类型转换器，需要实现一个接口org.springframework.core.convert.converter.Converter

package com.proc;

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

@Component
public class EmployeeConverter implements Converter<String, Employee> {

    @Override
    public Employee convert(String str) {
        Employee emp=null;
        //字符串格式 name-age-gender
        if(str!=null && str.split("-").length==3){
            emp=new Employee();
            String[] arr=str.split("-");
            emp.setName(arr[0]);
            emp.setAge(Integer.parseInt(arr[1]));
            emp.setGender(arr[2]);
        }
        return emp;
    }
}

　这里我们为转换器加上@Component注解，是为了让Spring自动扫描该转换器到容器中。这样就不用通过配置文件配置<bean>了

 

　　接下来编写控制器

package com.proc;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class EmployeeController {

    @RequestMapping("/add")
    public String add(@RequestParam("employee") Employee employee){
        System.out.println(employee);
        return "add";
    }
}

这里可以看到，参数的名字为employee，所有要为请求定义一个employee参数，该参数传入需要转换的字符串

 

　　除此之外，我们还需要在spring配置文件中配置，如下类容。让转换器生效

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">  
    
    <context:component-scan base-package="com.proc"></context:component-scan>
    
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/"/>
        <property name="suffix" value=".jsp"></property>
    </bean>

       <mvc:annotation-driven conversion-service="conversionService"/>
       
       <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
           <property name="converters">
               <set>
                   <ref bean="employeeConverter"/>
               </set>
           </property>
       </bean>
</beans>

测试代码：http://localhost:8080/springmvc-1/add?employee=caoyc-18-male

　　结果输出：Employee [name=caoyc, age=18, gender=male]

 

　   上面配置文件中我们使用配置了一个ConversionServiceFactoryBean。虽然可以这样，但不建议。我们通常用org.springframework.format.support.FormattingConversionServiceFactoryBean

 

为什么要这样用呢？这样用的好处是什么呢？

　　使用FormattingConversionServiceFactoryBean可以让SpringMVC支持@NumberFormat和@DateTimeFormat等Spring内部自定义的转换器。

方法二：SpringMVC注解@initbinder解决类型转换问题

在需要日期转换的Controller中使用SpringMVC的注解 @initbinder和Spring自带的 WebDateBinder类来操作。
WebDataBinder是用来绑定请求参数到指定的属性编辑器.由于前台传到controller里的值是String类型的，当往Model里Set这个值的时候，如果set的这个属性是个对象，Spring就会去找到对应的editor进行转换，然后再SET进去。
代码如下：

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

需要在SpringMVC的配置文件加上

<!-- 解析器注册 -->  
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"> <property name="messageConverters"> <list> <ref bean="stringHttpMessageConverter"/> </list> </property> </bean> <!-- String类型解析器，允许直接返回String类型的消息 --> <bean id="stringHttpMessageConverter" class="org.springframework.http.converter.StringHttpMessageConverter"/> 

换种写法

<mvc:annotation-driven>
    <mvc:message-converters> <bean class="org.springframework.http.converter.StringHttpMessageConverter"> <constructor-arg value="UTF-8"/> </bean> </mvc:message-converters> </mvc:annotation-driven>

拓展：
spring mvc在绑定表单之前，都会先注册这些编辑器，Spring自己提供了大量的实现类，诸如CustomDateEditor ，CustomBooleanEditor，CustomNumberEditor等许多，基本上够用。
使用时候调用WebDataBinder的registerCustomEditor方法
registerCustomEditor源码：

public void registerCustomEditor(Class<?> requiredType, PropertyEditor propertyEditor) { getPropertyEditorRegistry().registerCustomEditor(requiredType, propertyEditor); }

第一个参数requiredType是需要转化的类型。
第二个参数PropertyEditor是属性编辑器，它是个接口，以上提到的如CustomDateEditor等都是继承了实现了这个接口的PropertyEditorSupport类。
我们也可以不使用他们自带的这些编辑器类。
我们可以自己构造：

import org.springframework.beans.propertyeditors.PropertiesEditor;

public class DoubleEditor extends PropertyEditorSupport { @Override public void setAsText(String text) throws IllegalArgumentException { if (text == null || text.equals("")) { text = "0"; } setValue(Double.parseDouble(text)); } @Override public String getAsText() { return getValue().toString(); } }