Spring MVC 自定义数据转换器的思路案例详解

时间：2022-08-25 09:39:55

数据转换器是指将客户端 http 请求中的参数转换为业务方法中定义的形参，自定义表示开发者可以自主设计转换模式，HandlerAdapter 已经提供了通用的转换，比如将 String 转成 int，String 转成 double，表单数据的封装等，但是在特殊的业务场景下，HandlerAdapter 无法进行转换，就需要开发者自定义转换器。

我们需要实现 Converter 接口来协助 Spring MVC 完成数据类型的转换，下面通过两个案例来介绍如何自定义数据转换器。

案例一：客户端输入 String 类型的日期数据 “2021-09-16”，自定义转换器将该数据转为 Date 类型的对象。

Step1：创建 DateConverter 转换器，实现 org.springframework.core.convert.converter.Converter 接口，定义泛型为 <String,Date> ，将 String 类型的数值转换为 Date 类型；

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

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class DateConverter implements Converter<String, Date> {
    //解析的模式串
    private String pattern;

    public DateConverter(String pattern){
        this.pattern = pattern;
    }

    @Override
    public Date convert(String s) {
        //转换逻辑代码
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat(this.pattern);
        Date date = null;
        try {
            date = simpleDateFormat.parse(s);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return date;
    }
}

Step2：在 springmvc.xml 中配置转换器；

  • 配置 id="conversionService" 的 bean，bean 的类名称必须是 org.springframework.context.support.ConversionServiceFactoryBean，bean 必须包含一个 converters 属性，它将列出在应用程序中用到的所有自定义数据转换器。然后将我们自定义的 DateConverter 添加到 list 标签对中，通过有参构造函数创建 DateConverter 对象；
  • 在 <mvc:annotation-driven /> 标签元素的 conversion-service 属性添加 bean 名称；
<!-- 配置自定义转换器 -->
<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
    <property name="converters">
        <list>
            <bean class="com.trainingl.converter.DateConverter">
                <constructor-arg type="java.lang.String" value="yyyy-MM-dd"></constructor-arg>
            </bean>
        </list>
    </property>
</bean>

<mvc:annotation-driven conversion-service="conversionService">
    <!-- 消息转换器 -->
    <mvc:message-converters register-defaults="true">
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="supportedMediaTypes" value="text/html;charset=UTF-8"></property>
        </bean>
        <!-- 配置fastjson -->
        <bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter"></bean>
    </mvc:message-converters>
</mvc:annotation-driven>

Step3：创建 addDate 视图页面，提交form 表单数据到后台；

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <form action="/date" method="post">
        出生日期: <input type="date" name="birthday" />
        <input type="submit" value="提交">
    </form>
</body>
</html>

Step4：创建控制器的业务方法；

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

import java.util.Date;

@Controller
public class DateHandler {

    @RequestMapping("/date")
    @ResponseBody
    public String userDate(Date birthday){
        System.out.println(birthday);
        return birthday.toString();
    }
}

Step5：启动 Tomcat 服务器，运行程序；

Spring MVC 自定义数据转换器的思路案例详解

Spring MVC 自定义数据转换器的思路案例详解

案例二：注册一个 Student 对象，前端页面按照 “id-name-age” 的形式输入 String 类型的数据，通过转换器，可以将该 String 类型的数据直接转换为 Student 对象。

1、创建 Student 实体类；

package com.trainingl.entity;

public class Student {
    private Long id;
    private String name;
    private Integer age;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

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

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name="" + name + """ +
                ", age=" + age +
                "}";
    }
}

2、创建 StudentConverter 转换器；

import com.trainingl.entity.Student;
import org.springframework.core.convert.converter.Converter;

public class StudentConverter implements Converter<String, Student> {
    @Override
    public Student convert(String s) {
        //处理字符串信息
        String[] args = s.split("-");
        Student student = new Student();
        student.setId(Long.parseLong(args[0]));
        student.setName(args[1]);
        student.setAge(Integer.parseInt(args[2]));
        return student;
    }
}

3、springmvc.xml 中配置 StudentConverter 转换器；

<!-- 配置自定义转换器 -->
<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
    <property name="converters">
        <list>
            <bean class="com.trainingl.converter.DateConverter">
                <constructor-arg type="java.lang.String" value="yyyy-MM-dd"></constructor-arg>
            </bean>
            <bean class="com.trainingl.converter.StudentConverter">
            </bean>
        </list>
    </property>
</bean>

4、创建 addStudent 视图页面；

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>添加新同学</title>
</head>
<body>
    <form action="/addStu" method="post">
        学生信息：<input type="text" name="student">(提示:id-name-age)<br/>
        <input type="submit" value="提交">
    </form>
</body>
</html>

5、创建业务方法；

@Controller
public class StudentHandler {

    @RequestMapping("/addStu")
    @ResponseBody
    public String addStudent(Student student){
        System.out.println(student);
        return student.toString();
    }
}

启动 Tomcat 服务器，运行程序：

Spring MVC 自定义数据转换器的思路案例详解

从返回的结果中看出，输入的字符串信息被成功解析成了 Java 对象。

Spring MVC 自定义数据转换器的思路案例详解

总结：我们知道 http 表单中的所有请求参数都是 String 类型的，如果业务参数是 String 或者 int 类型，HandlerAdapter 组件可以自动完成数据转换，但如果参数是其他数据类型，比如：格式化字符串等，HandlerAdapter 是不能自动将 String 类型转换为 Date 类型或JavaBean 的，这时就需要开发者手动的创建自定义数据转换器。

到此这篇关于Spring MVC 自定义数据转换器的文章就介绍到这了,更多相关Spring MVC 自定义数据转换器内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://blog.csdn.net/qq_41775769/article/details/120328217

标签：

相关文章