彻底搞懂Spring类型转换：从Converter到Formatter的优雅实现
【免费下载链接】spring-framework 
项目地址: https://gitcode.com/gh_mirrors/spr/spring-framework
你是否还在为数据类型转换编写大量重复代码？是否遇到过前端传来的字符串无法直接映射到后端实体类的情况？Spring Framework提供的类型转换机制可以帮你轻松解决这些问题。本文将带你深入了解Spring的Converter与Formatter接口，掌握如何优雅地实现自定义类型转换，让你的代码更简洁、更易维护。
类型转换核心接口概述
Spring类型转换体系的核心是两个接口：Converter和Formatter。它们分别用于不同场景下的数据转换需求，共同构成了Spring灵活而强大的类型转换机制。
Converter接口主要用于通用的类型转换，它可以将一种类型的对象转换为另一种类型的对象。而Formatter接口则专门用于String类型与其他类型之间的转换，特别适合处理用户输入的格式化数据。
Converter接口定义
Converter接口位于org.springframework.core.convert.converter包中，定义如下：
public interface Converter<S, T> {
T convert(S source);
}
这个接口非常简单，只有一个convert方法，接收源类型S的对象，返回目标类型T的对象。通过实现这个接口，我们可以定义任意两种类型之间的转换规则。
Formatter接口定义
Formatter接口位于org.springframework.format包中，定义如下：
public interface Formatter<T> extends Printer<T>, Parser<T> {
}
public interface Printer<T> {
String print(T object, Locale locale);
}
public interface Parser<T> {
T parse(String text, Locale locale) throws ParseException;
}
Formatter接口继承了Printer和Parser接口，分别用于将对象格式化为字符串和将字符串解析为对象。它还考虑了本地化（Locale）因素，非常适合处理用户界面的输入输出。
深入理解Converter接口
Converter接口是Spring类型转换体系中最基础也是最灵活的接口。它不仅支持简单的类型转换，还可以通过ConverterFactory和GenericConverter处理更复杂的转换场景。
基本Converter实现
下面是一个简单的Converter实现，用于将String类型转换为Integer类型：
public class StringToIntegerConverter implements Converter<String, Integer> {
@Override
public Integer convert(String source) {
if (source == null || source.isEmpty()) {
return null;
}
return Integer.parseInt(source.trim());
}
}
这个转换器非常简单，但在实际应用中，我们可能需要处理更复杂的转换逻辑。Spring提供了许多内置的Converter实现，涵盖了大部分常见的类型转换需求。
Converter注册与使用
要使用自定义的Converter，我们需要将其注册到ConverterRegistry中。Spring的ConversionService实现类通常都实现了ConverterRegistry接口，如GenericConversionService和DefaultConversionService。
DefaultConversionService conversionService = new DefaultConversionService();
conversionService.addConverter(new StringToIntegerConverter());
注册后，我们就可以使用ConversionService进行类型转换了：
Integer result = conversionService.convert("123", Integer.class);
高级Converter特性
除了基本的Converter接口，Spring还提供了ConverterFactory和GenericConverter，用于处理更复杂的转换场景。
ConverterFactory允许我们为一组相关类型创建转换器。例如，我们可以创建一个将String转换为任意Number类型的ConverterFactory：
public interface ConverterFactory<S, R> {
<T extends R> Converter<S, T> getConverter(Class<T> targetType);
}
GenericConverter则提供了更灵活的转换能力，它支持多源类型到多目标类型的转换，并可以访问转换上下文信息。
public interface GenericConverter {
Set<ConvertiblePair> getConvertibleTypes();
Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType);
}
这些高级特性使得Spring的类型转换机制能够应对各种复杂的转换需求。
深入理解Formatter接口
Formatter接口专门用于处理String类型与其他类型之间的转换，特别适合Web应用中处理用户输入的数据格式化问题。
基本Formatter实现
下面是一个简单的Formatter实现，用于将Date类型格式化为指定格式的字符串，以及将字符串解析为Date类型：
public class DateFormatter implements Formatter<Date> {
private final String pattern;
public DateFormatter(String pattern) {
this.pattern = pattern;
}
@Override
public String print(Date date, Locale locale) {
SimpleDateFormat sdf = new SimpleDateFormat(pattern, locale);
return sdf.format(date);
}
@Override
public Date parse(String text, Locale locale) throws ParseException {
SimpleDateFormat sdf = new SimpleDateFormat(pattern, locale);
return sdf.parse(text);
}
}
Formatter注册与使用
与Converter类似，Formatter也需要注册到FormatterRegistry中才能使用。Spring提供的FormattingConversionService是一个同时实现了ConversionService和FormatterRegistry接口的类，非常适合作为Web应用中的类型转换服务。
FormattingConversionService conversionService = new FormattingConversionService();
conversionService.addFormatter(new DateFormatter("yyyy-MM-dd"));
在Spring MVC应用中，我们可以通过配置WebBindingInitializer来注册自定义的Formatter：
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addFormatter(new DateFormatter("yyyy-MM-dd"));
}
}
注解驱动的格式化
Spring还提供了注解驱动的格式化功能，通过@NumberFormat和@DateTimeFormat等注解，我们可以轻松地指定字段的格式化规则。
public class User {
@DateTimeFormat(pattern = "yyyy-MM-dd")
private Date birthday;
@NumberFormat(pattern = "#,###.##")
private BigDecimal salary;
}
这些注解可以与Spring MVC的@RequestParam、@ModelAttribute等注解配合使用，自动完成请求参数的格式化转换。
Converter与Formatter的选择
Converter和Formatter都用于类型转换，但它们各有侧重，适用于不同的场景。了解它们的区别和适用场景，可以帮助我们更好地选择合适的转换方式。
功能对比
| 特性 | Converter | Formatter |
|---|---|---|
| 转换方向 | 任意类型之间 | 主要是String与其他类型 |
| 本地化支持 | 不直接支持 | 内置本地化支持 |
| 使用场景 | 通用类型转换 | 用户输入输出格式化 |
| 灵活性 | 高，支持复杂转换 | 中等，专注于字符串转换 |
适用场景分析
Converter适用于以下场景：
- 通用的类型转换，如Object到String、String到Number等
- 复杂的类型转换逻辑
- 需要在非Web环境中使用的转换
Formatter适用于以下场景：
- Web应用中的用户输入输出格式化
- 需要考虑本地化的场景
- 简单的字符串与其他类型的转换
在实际应用中，我们可以根据具体需求选择合适的转换方式，甚至可以结合使用两者，以达到最佳的转换效果。
实际应用案例
下面我们通过一个实际案例来演示如何在Spring应用中使用Converter和Formatter进行类型转换。
场景描述
假设我们正在开发一个电商网站，需要处理用户的收货地址信息。地址信息通常包括省份、城市、区/县等字段，我们希望能够将这些信息封装为一个Address对象，并支持与String类型的相互转换。
实现Converter
首先，我们定义一个Address类：
public class Address {
private String province;
private String city;
private String district;
// 构造函数、getter和setter省略
}
然后，实现一个String到Address的Converter：
public class StringToAddressConverter implements Converter<String, Address> {
@Override
public Address convert(String source) {
if (source == null || source.isEmpty()) {
return null;
}
String[] parts = source.split(",");
if (parts.length != 3) {
throw new IllegalArgumentException("Invalid address format");
}
return new Address(parts[0].trim(), parts[1].trim(), parts[2].trim());
}
}
同时，实现一个Address到String的Converter：
public class AddressToStringConverter implements Converter<Address, String> {
@Override
public String convert(Address source) {
if (source == null) {
return null;
}
return String.format("%s,%s,%s", source.getProvince(), source.getCity(), source.getDistrict());
}
}
注册Converter
接下来，我们需要将这些Converter注册到ConversionService中：
@Configuration
public class ConversionConfig {
@Bean
public ConversionService conversionService() {
DefaultConversionService conversionService = new DefaultConversionService();
conversionService.addConverter(new StringToAddressConverter());
conversionService.addConverter(new AddressToStringConverter());
return conversionService;
}
}
在Spring MVC中使用
在Spring MVC控制器中，我们可以直接使用Address类型作为请求参数：
@Controller
public class OrderController {
@PostMapping("/orders")
public String createOrder(@RequestParam Address shippingAddress, Model model) {
// 处理订单创建逻辑
model.addAttribute("address", shippingAddress);
return "order-confirmation";
}
}
在视图中，我们可以直接使用Address对象，Spring会自动调用相应的Converter将其转换为String：
<div>
<h3>收货地址</h3>
<p>${address}</p>
</div>
扩展：实现Formatter
如果我们需要在用户界面中更灵活地格式化Address对象，我们可以实现一个Formatter：
public class AddressFormatter implements Formatter<Address> {
@Override
public String print(Address object, Locale locale) {
if (object == null) {
return "";
}
return String.format("%s %s %s", object.getProvince(), object.getCity(), object.getDistrict());
}
@Override
public Address parse(String text, Locale locale) throws ParseException {
if (text == null || text.isEmpty()) {
return null;
}
String[] parts = text.split(" ");
if (parts.length != 3) {
throw new ParseException("Invalid address format", 0);
}
return new Address(parts[0], parts[1], parts[2]);
}
}
然后将其注册到FormatterRegistry中：
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addFormatter(new AddressFormatter());
}
}
通过这个案例，我们可以看到Converter和Formatter在实际应用中的强大功能和灵活性。它们可以帮助我们消除大量重复的类型转换代码，让我们的应用更加简洁、易维护。
总结与最佳实践
Spring的类型转换机制为我们提供了强大而灵活的类型转换能力，通过Converter和Formatter接口，我们可以轻松实现各种复杂的类型转换需求。在使用过程中，我们需要注意以下几点：
-
根据场景选择合适的转换方式：通用类型转换使用Converter，用户输入输出格式化使用Formatter。
-
充分利用Spring提供的内置转换器和格式化器，避免重复造轮子。
-
对于复杂的转换逻辑，考虑使用GenericConverter或ConverterFactory。
-
在Web应用中，推荐使用FormattingConversionService，它同时支持Converter和Formatter。
-
对于需要本地化的场景，优先考虑使用Formatter。
-
合理组织转换器代码，将相关的转换器放在一起，便于维护。
通过掌握Spring的类型转换机制，我们可以让代码更加简洁、优雅，提高开发效率和代码质量。希望本文能够帮助你深入理解Spring的Converter和Formatter接口，在实际项目中灵活运用它们解决类型转换问题。
Spring的类型转换体系是Spring框架的重要组成部分，深入理解和灵活运用这一机制，将有助于我们构建更加健壮、易维护的Spring应用。如果你想了解更多关于Spring类型转换的内容，可以参考Spring官方文档或相关源代码，如：
通过不断学习和实践，我们可以更好地利用Spring的强大功能，构建高质量的Java应用。
【免费下载链接】spring-framework 项目地址: https://gitcode.com/gh_mirrors/spr/spring-framework
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
