关于Spring MVC中自定义类型转换器的方式

最新推荐文章于 2023-10-21 16:22:47 发布

原创最新推荐文章于 2023-10-21 16:22:47 发布 · 2.3k 阅读

4 ·

CC 4.0 BY-SA版权

Spring MVC 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何在SpringMVC中实现自定义数据转换器，包括Converter接口、PropertyEditor编辑器及WebBindingInitializer的使用，确保不同类型数据的正确转换。

关于Spring mvc ，我觉得他是一个特别人性化的框架，它的内部实现，帮我们省去了很多麻烦

例如，在我们在前端页面输入数据的时候，后台接受数据的时候，如果事先写好一个类，且后台接收到响应参数为该类型时，那么他就会自动匹配类的属性，并将值注入，那么后台接受到的参数就是一个已经注入好参数的实例；

这是一个User类，包含以下属性

import java.io.Serializable;

public class User implements Serializable {
	private String id;
	private String userName;
	private String password;

	public User() {
	}
     //省略get和set方法
}

前段jsp页面如下：

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>注册页面</title>
</head>
<body>
  <h3>注册页面</h3>
  ${message}
  <form action="register " method="post">
    <table>
      <tr>
      		<td><label>用户名:</label></td>
      		<td><input type ="text" id ="id" name="id"></td>
      </tr>
      <tr>
      		<td><label>密码:</label></td>
      		<td><input type ="password" id ="password" name="password"></td>
      </tr>
       <tr>
      		<td><label>真实姓名:</label></td>
      		<td><input type ="text" id ="userName" name="userName"></td>
      </tr>
       <tr>
      		<td><input type ="submit" id ="submit" value ="注册"></td>
      </tr>
    </table>
  </form>
</body>
</html>

后台接受到前端的请求时;

@RequestMapping("/login")
	public String userLogin(User user){
		System.out.println(user);   //输出即时前段输入的完整信息
		//.....
		return "success";
	}

Spring mvc将数据依照匹配注入，非常的人性化但是，在默认情况下，他只能将请求参数(字符串类型)转换为一部分类型。对于某些特殊类型则无法转换成功。

如果现在User类中新添加一个属性

private Date birthday；属性，那么在前段提交数据的时候，Springmvc 没办法将字符串类型的(1997-4-2)转换为Date类型的数据，那么我们就需要自己自定义数据转换器；

Spring 支持的数据转换器

Spring提供了3种类型的数据转换器接口，我们可以实现任意一种转换器接口，并将它作为自定义转换器注册到ConversionServiceFactoryBean当中。

一，Converser<S,T>接口是Spring中最简单的一个转换器，该接口只有一个方法

T convert(S source) 该方法负责将S类型的对象转换为T类型的对象。

二，ConverterFactory<S,R> 如果希望将一种类型的对象转换为另一种类型及其子类的对象，比如将String转换为Number以及Number的子类Integer,Doublele类型的对象，就需要一系列的connverter了，如StringToInteger,StringToDouble等，ConverterFactory<S,R>接口的作用就是将相同系列的converter封装在一起，该接口也只有一个方法：

<T extends R> Converter<S,T> GetConverter(Class<T> targetType)

S为源类型，R为目标类型的基类，T为R的子类

三，GenericConverter .Converter<S,T>接口只是负责讲一个类型对象转换为另一个类型对象，他并没有考虑对象上下文信息，因此不能完成复杂类型转换的工作。GenericConverter接口会根据源类对象及目标类对象的上下文信息进行类型转换

1.实现Converter接口进行类型转换。

在上述问题中，当前端输入一个字符串表示用户的生日信息的时候，spring不能帮我们转换数据格式，那么我们需要自定义一个转换器，自定义一个类实现Converter<S,T>接口

public class StringToDateConverter implements Converter<String, Date>{
	/*
	 * 这是配置转换器可以转换的格式,例如 yyyy年MM月dd日，  yyyy-MM-dd
	 */
    private String datePattern;
    
    public StringToDateConverter() {
	}
	
	public void setDatePattern(String datePattern) {
		this.datePattern = datePattern;
	}
  
	@Override
	public Date convert(String date) {
		
		try {
			SimpleDateFormat dateFormat = new SimpleDateFormat(this.datePattern);
			return dateFormat.parse(date);//根据格式转换
		} catch (ParseException e) {
			e.printStackTrace();
			System.out.println("转换失败");
			return null;
		}
	}

}

定义好了这和转换器之后，将他注册到CinversionServiceFactoryBean的converters属性，那么当前端输入数据之后，spring在进行参数的时候使用我们自定义的数据转换器进行数据的转换，参数的注入

在applicationContext.xml文件中（也就是配置Spring上下文的文件中注册

<bean id = "conversionService"
     class = "org.springframework.context.support.ConversionServiceFactoryBean">
     		<property name="converters">  
     			<list>
     			  <bean class = "com.lzy.model.StringToDateConverter">
     			  		<property name="datePattern" value="yyyy年MM月dd日"></property>    <!-- 配置bean 以及bean的参数入参格式-->  
     			  </bean>
                        <!-- 这里可以配置多个格式的转换器 -->
                         </list>
     		</property>
     </bean>

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

注册成功之后，再次尝试前端输入（生日类型的值时），后才接收的时候，可以正常解析参数转换成功。

2.使用@InitBinder添加自定义编辑器转换数据

Springmvc在支持新的转换器框架的时候，也支持JavaBeans的PropertyEditor(但是他只支持字符串到Java对象的转换)。可以在控制器使用@InitBinder添加自定义的编辑器，在控制器中注册编辑器，在该控制器中就可以使用该类型转换。不用在applicationContext.xml中注册。

自定义编辑器需要继承自PropertyEditorSupport,重写其setAsText方法，代码如下

public class DateEditor extends PropertyEditorSupport{
    
	@Override
	public void setAsText(String text) throws IllegalArgumentException {
		SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy年MM月dd日");
		try {
			Date date = dateFormat.parse(text);
			setValue(date);
		} catch (ParseException e) {
			e.printStackTrace();
		}
	}
}

自定义好编辑器后，在控制器中注册之后，就可以实现类型的转换了。

	@InitBinder
	public void initBinder(WebDataBinder binder){  //WebDateBinder用于处理请求消息和处理方法的绑定工作
		binder.registerCustomEditor(Date.class, new DateEditor());//将传入的Date类型使用DateEditor类进行转换
	}

注册好了之后，测试，成功

三，使用WebBindingInitilizer注册全局自定义编辑器转换数据

希望在全局范围内使用自定义的编辑器，则可以通过实现WebBindingInitilizer接口并在该实现类中注册自定义编辑器来完成

public class DateBindingInitializer implements WebBindingInitializer{

	@Override
	public void initBinder(WebDataBinder binder, WebRequest request) {
		binder.registerCustomEditor(Date.class, new DateEditor());   //注册自定义的编辑器，将传入的Date类型的参数用DateEditor类型进行转换
	}

}

注册完毕之后，在控制器中，不使用@InitBinder注解的方法，而是在applicationCintext.xml文件中去配置全局的自定义编辑器。

    <bean class ="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
       <property name="webBindingInitializer">
         <bean class="com.lzy.model.DateBindingInitializer"></bean>
       </property>
    </bean>

<mvc:annotation-driven  />

这里需要注意一点，<mvc:annotation-driven /> 的配置应该放在全局变量的编辑器配置之后，否则会出错误。

配置完成后测试，正确。

多种转换器的优先顺序

对于同一个类型的对象来说，如果即在ConversionService中配置了自定义的类型转换器，又通过WebInitilizer接口配置了全局的自定义编辑器，同时还在控制器中使用@InitBinder注解装配了自定义的编辑器，此时spingmvc将按照优先顺序查找对应的转换器：

1，查询通过@InitBinder装配的自定义编辑器

2，查询通过ConversionService装配的自定义转换器

3，查询通过WebBindingInitilizer接口配置的全局自定义编辑器