SpringMVC自定义类型转换器

2019-06-12

从前端提交过来的所有参数都是字符串类型，而SpringMVC框架已经帮我们做了很多自动化转换工作，例如：String转数字类型，Boolean类型等。但是，很多时候我们依旧需要根据实际情况去定义自己的转换类，例如：将2010-01-01 20:05:06这样的字符串转换成Date日期类型，这时候我们就需要自定义类型转换器了。
下面记录自定义转换器的开发过程。

1、创建自定义类型转换器类，并实现Converter<S,T>接口

需要注意的是，这里的Converter接口所在的包为：org.springframework.core.convert.converter

import org.springframework.core.convert.converter.Converter;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 将字符串转换成日期类型。日期格式：yyyy-MM-dd HH:mm:ss
 */
public class String2DateConverter implements Converter<String, Date> {
    @Override
    public Date convert(String s) {
        Date date = null;
        if(s != null){
            // 按照特定格式进行日期转换
            SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            try {
                date = format.parse(s);
            }catch (Exception e){
                e.printStackTrace();
            }
        }
        return date;
    }
}

2、在Spring配置文件中配置ConversionServiceFactoryBean对象

在项目的Spring配置文件中的 beans 下添加 bean 节点，本项目的Spring配置文件为application.xml。配置代码如下：

<!--配置自定义类型转换器-->
<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
    <!-- converters中保存了所有的类型转换器 -->
    <property name="converters">
        <set>
            <!-- 配置自定义的类型转换器 -->
            <bean class="com.lanting.converter.String2DateConverter"></bean>
        </set>
    </property>
</bean>

3、配置ConversionServiceFactoryBean到SpringMVC中去

在Spring配置文件中（本项目的配置文件为application.xml），增加如下代码，让conversionService生效，<mvc:annotation-driven />默认只是让处理器映射器、前端控制器、处理器适配器生效，如果想让conversionService生效，就必须在<mvc:annotation-driven />中添加conversion-service="conversionService"说明。

1 2	<!--添加SpringMVC框架的注解支持，conversion-service="conversionService"为配置自定义转换器 --> <mvc:annotation-driven conversion-service="conversionService"/>

做完以上三步后，即可让前端提交过来的格式为“yyyy-MM-dd HH:mm:ss”的字符串转换成Date日期类型了。

4、说在后面的话

这种自定义转换器只适用于一般的表单提交方式的转换，不适用于JSON格式提交的情况（如果是JSON提交需要单独讨论）。

下面的参数接受方式可以被转换。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/params")
public class ParamsController {

    @RequestMapping("saveUser")
    public String saveUser(User user){
        System.out.println(user);
        return "success";
    }
}

User对象的结构为：

import java.io.Serializable;
import java.util.Date;

public class User implements Serializable {
    private String username;
    private String password;
    private Date birthday;// 日期类型，需要使用日期转换器转换

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
}

前端提交的表单结构为：


<form action="params/saveUser" method="post" autocomplete="off">

    <input required type="text" name="username" placeholder="请输入用户名">

    <input required type="password" name="password" placeholder="请输入密码">

    <input required type="text" placeholder="请选择生日" name="birthday" >

    <button type="submit">提交</button>

</form>