Spring基础知识（16）- Spring MVC (六) | 类型转换器(Converter)、数据格式化(Formatter)
1. 类型转换器（Converter）
Spring MVC 框架的类型转换，一般发生在视图（JSP）与控制器（Controller）相互传递数据时。对于基本类型（例如 int、long、float、double、boolean 以及 char 等）已经做好了基本类型转换。
Spring MVC 框架的 Converter<S，T> 是一个可以将一种数据类型转换成另一种数据类型的接口，这里 S 表示源类型，T 表示目标类型。开发者在实际应用中使用框架内置的类型转换器基本上就够了，但有时需要编写具有特定功能的类型转换器。
例如，用户输入的日期可能有许多种形式，如“December 25,2014”、“12/25/2014” 和 “2014-12-25”，这些都表示同一个日期。默认情况下，Spring 会期待用户输入的日期样式与当前语言区域的日期样式相同。
1) 内置的类型转换器
在 Spring MVC 框架中，对于常用的数据类型，开发者无须创建自己的类型转换器，因为 Spring MVC 框架有许多内置的类型转换器用于完成常用的类型转换。Spring MVC 框架提供的内置类型转换包括以下几种类型。
(1) 标量转换器
| 名称 | 作用 |
| StringToBooleanConverter | String 到 boolean 类型转换 |
| ObjectToStringConverter | Object 到 String 转换，调用 toString 方法转换 |
| StringToNumberConverterFactory | String 到数字转换（例如 Integer、Long 等） |
| NumberToNumberConverterFactory | 数字子类型（基本类型）到数字类型（包装类型）转换 |
| StringToCharacterConverter | String 到 Character 转换，取字符串中的第一个字符 |
| NumberToCharacterConverter | 数字子类型到 Character 转换 |
| CharacterToNumberFactory | Character 到数字子类型转换 |
| StringToEnumConverterFactory | String 到枚举类型转换，通过 Enum.valueOf 将字符串转换为需要的枚举类型 |
| EnumToStringConverter | 枚举类型到 String 转换，返回枚举对象的 name 值 |
| StringToLocaleConverter | String 到 java.util.Locale 转换 |
| PropertiesToStringConverter | java.util.Properties 到 String 转换，默认通过 ISO-8859-1 解码 |
| StringToPropertiesConverter | String 到 java.util.Properties 转换，默认使用 ISO-8859-1 编码 |
(2) 集合、数组相关转换器
| 名称 | 作用 |
| ArrayToCollectionConverter | 任意数组到任意集合（List、Set）转换 |
| CollectionToArrayConverter | 任意集合到任意数组转换 |
| ArrayToArrayConverter | 任意数组到任意数组转换 |
| CollectionToCollectionConverter | 集合之间的类型转换 |
| MapToMapConverter | Map之间的类型转换 |
| ArrayToStringConverter | 任意数组到 String 转换 |
| StringToArrayConverter | 字符串到数组的转换，默认通过“，”分割，且去除字符串两边的空格（trim） |
| ArrayToObjectConverter | 任意数组到 Object 的转换，如果目标类型和源类型兼容，直接返回源对象；否则返回数组的第一个元素并进行类型转换 |
| ObjectToArrayConverter | Object 到单元素数组转换 |
| CollectionToStringConverter | 任意集合（List、Set）到 String 转换 |
| StringToCollectionConverter | String 到集合（List、Set）转换，默认通过“，”分割，且去除字符串两边的空格（trim） |
| CollectionToObjectConverter | 任意集合到任意 Object 的转换，如果目标类型和源类型兼容，直接返回源对象；否则返回集合的第一个元素并进行类型转换 |
| ObjectToCollectionConverter | Object 到单元素集合的类型转换 |
注意：在使用内置类型转换器时，请求参数输入值与接收参数类型要兼容，否则会报 400 错误。
2) 自定义类型转换器
当 Spring MVC 框架内置的类型转换器不能满足需求时，开发者可以开发自己的类型转换器。
例如，用户在页面表单中输入商品信息。当输入“Tomato,3.02,5” 时表示在程序中自动创建一个 new Goods，并将 “Tomato” 值自动赋给 name 属性，将 3.02 值自动赋给 price 属性，将 “5” 值自动赋给 number 属性。
如果想实现上述应用，需要做以下 5 件事：
(1) 创建实体类；
(2) 创建相关视图；
(3) 创建自定义类型转换器类；
(4) 注册类型转换器；
(5) 创建控制器类；
示例
在 “Spring基础知识（12）- Spring MVC (二)” 的示例里，更新过 springmvc-beans.xml 的 SpringmvcBasic 项目基础上，修改如下。
(1) 创建 src/main/java/com/example/entity/Goods.java 文件
1 package com.example.entity; 2 3 import java.util.Date; 4 5 public class Goods { 6 private String name; 7 private double price; 8 private int number; 9 private Date createDate; 10 11 public Goods() { 12 13 } 14 15 public String getName() { 16 return name; 17 } 18 19 public void setName(String name) { 20 this.name = name; 21 } 22 23 public double getPrice() { 24 return price; 25 } 26 27 public void setPrice(double price) { 28 this.price = price; 29 } 30 31 public int getNumber() { 32 return number; 33 } 34 35 public void setNumber(int number) { 36 this.number = number; 37 } 38 39 public Date getCreateDate() { 40 return createDate; 41 } 42 43 public void setCreateDate(Date createDate) { 44 this.createDate = createDate; 45 } 46 47 }
(2) 创建 src/main/webapp/WEB-INF/jsp/goods.jsp 文件
1 <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %> 2 <html> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5 <title>Goods</title> 6 </head> 7 <body> 8 9 <h4>Goods</h4> 10 11 <p>内置的类型转换器 (StringToCollectionConverter)</p> 12 <form method="POST" action="${pageContext.request.contextPath }/converter/goods/post"> 13 <p>输入 Goods 信息（格式："name,price,number" ）:<br> 14 <input name="goods" value="Tomato,3.02,5" style="width: 50%"/></p> 15 <p><input type="submit" value="Submit"/></p> 16 </form> 17 18 <hr/> 19 <p>自定义类型转换器 (GoodsConverter)</p> 20 <form method="POST" action="${pageContext.request.contextPath }/converter/goods/post2"> 21 <p>输入 Goods 信息（格式："name,price,number" ）:<br> 22 <input name="goods" value="Tomato,3.02,5" style="width: 50%"/></p> 23 <p><input type="submit" value="Submit"/></p> 24 </form> 25 26 </body> 27 </html>
(3) 创建 src/main/java/com/example/converter/GoodsConverter.java 文件
1 package com.example.converter; 2 3 import org.springframework.core.convert.converter.Converter; 4 import org.springframework.stereotype.Component; 5 import com.example.entity.Goods; 6 7 @Component 8 public class GoodsConverter implements Converter<String, Goods> { 9 @Override 10 public Goods convert(String source) { 11 12 Goods goods = new Goods(); 13 String stringvalues[] = source.split(","); 14 15 if (stringvalues != null && stringvalues.length == 3) { 16 goods.setName(stringvalues[0]); 17 goods.setPrice(Double.valueOf(stringvalues[1])); 18 goods.setNumber(Integer.valueOf(stringvalues[2])); 19 return goods; 20 } else { 21 throw new IllegalArgumentException(String.format("Invalid data format (%s)", source)); 22 } 23 } 24 }
(4) 修改 springmvc-beans.xml 文件，添加如下配置
1 <!-- 注册类型转换器 GoodsConverter --> 2 <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean"> 3 <property name="converters"> 4 <list> 5 <bean class="com.example.converter.GoodsConverter" /> 6 </list> 7 </property> 8 </bean> 9 10 <mvc:annotation-driven conversion-service="conversionService" />
(5) 创建 src/main/java/com/example/controller/ConverterController.java 文件
1 package com.example.controller; 2 3 import java.util.List; 4 5 import org.springframework.stereotype.Controller; 6 import org.springframework.ui.Model; 7 import org.springframework.web.bind.annotation.RequestMapping; 8 import org.springframework.web.bind.annotation.RequestParam; 9 import com.example.entity.Goods; 10 11 @Controller 12 @RequestMapping("/converter") 13 public class ConverterController { 14 15 @RequestMapping("/goods") 16 public String goods() { 17 return "goods"; 18 } 19 20 @RequestMapping("/goods/post") 21 public String goodsPost(@RequestParam("goods") List<String> goods, Model model) { 22 23 String str = "<br>StringToCollectionConverter<br>"; 24 str += "Name: " + goods.get(0) + "<br>"; 25 str += "Price: " + goods.get(1) + "<br>"; 26 str += "Number: " + goods.get(2) + "<br>"; 27 model.addAttribute("message", str); 28 return "success"; 29 } 30 31 @RequestMapping("/goods/post2") 32 public String goodsPost2(@RequestParam("goods") Goods goods, Model model) { 33 34 String str = "<br>GoodsConverter<br>"; 35 str += "Name: " + goods.getName() + "<br>"; 36 str += "Price: " + goods.getPrice() + "<br>"; 37 str += "Number: " + goods.getNumber() + "<br>"; 38 model.addAttribute("message", str); 39 return "success"; 40 } 41 }
访问：http://localhost:9090/converter/goods
2. 数据格式化（Formatter）
Spring MVC 框架的 Formatter<T> 与 Converter<S, T> 一样，也是一个可以将一种数据类型转换成另一种数据类型的接口。不同的是，Formatter 的源类型必须是 String 类型，而 Converter 的源类型可以是任意数据类型。
Formatter 更适合 Web 层，而 Converter 可以在任意层中。所以对于需要转换表单中的用户输入的情况，应该选择 Formatter，而不是 Converter。
在 Web 应用中由 HTTP 发送的请求数据到控制器中都是以 String 类型获取，因此在 Web 应用中选择 Formatter<T> 比选择 Converter<S, T> 更加合理。
1) 内置的格式化转换器
Spring MVC 提供了几个内置的格式化转换器，具体如下。
NumberFormatter：实现 Number 与 String 之间的解析与格式化。
CurrencyFormatter：实现 Number 与 String 之间的解析与格式化（带货币符号）。
PercentFormatter：实现 Number 与 String 之间的解析与格式化（带百分数符号）。
DateFormatter：实现 Date 与 String 之间的解析与格式化。
2) 自定义格式化转换器
自定义格式化转换器就是编写一个实现 org.springframework.format.Formatter 接口的 Java 类。该接口声明如下。
public interface Formatter<T>
这里的 T 表示由字符串转换的目标数据类型。该接口有 parse 和 print 两个接口方法，自定义格式化转换器类必须覆盖它们。
public T parse(String s, java.util.Locale locale)
public String print(T object, java.util.Locale locale)
parse 方法的功能是利用指定的 Locale 将一个 String 类型转换成目标类型，print 方法与之相反，用于返回目标对象的字符串表示。
示例
在 “Spring基础知识（12）- Spring MVC (二)” 的示例里，更新过 springmvc-beans.xml 的 SpringmvcBasic 项目基础上，修改如下。
(1) 使用 src/main/java/com/example/entity/Goods.java 文件（同上）
1 package com.example.entity; 2 3 import java.util.Date; 4 5 public class Goods { 6 private String name; 7 private double price; 8 private int number; 9 private Date createDate; 10 11 public Goods() { 12 13 } 14 15 // 省略 getter 和 setter 方法 16 ... 17 }
(2) 创建 src/main/webapp/WEB-INF/jsp/goods2.jsp 文件
1 <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %> 2 <html> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5 <title>Goods (2)</title> 6 </head> 7 <body> 8 9 <h4>Goods (2)</h4> 10 <form method="POST" action="${pageContext.request.contextPath }/formatter/goods2/post"> 11 <table> 12 <tr> 13 <td>Name:</td> 14 <td><input name="name" value="Tomato" /></td> 15 </tr> 16 <tr> 17 <td>Price:</td> 18 <td><input name="price" value="3.02" /></td> 19 </tr> 20 <tr> 21 <td>Number:</td> 22 <td><input name="number" value="5" /></td> 23 </tr> 24 <tr> 25 <td>Create Date:</td> 26 <td><input name="createDate" value="2020-01-01" /></td> 27 </tr> 28 <tr> 29 <td colspan="2"> 30 <input type="submit" value="Submit"/> 31 </td> 32 </tr> 33 </table> 34 </form> 35 36 </body> 37 </html>
(3) 创建 src/main/java/com/example/formatter/DataFormatter.java 文件
1 package com.example.formatter; 2 3 import java.util.Date; 4 import java.util.Locale; 5 import java.text.ParseException; 6 import java.text.SimpleDateFormat; 7 import org.springframework.format.Formatter; 8 import org.springframework.stereotype.Component; 9 10 @Component 11 public class DataFormatter implements Formatter<Date> { 12 SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); 13 public String print(Date object, Locale arg1) { 14 return dateFormat.format(object); 15 } 16 public Date parse(String source, Locale arg1) throws ParseException { 17 return dateFormat.parse(source); // Formatter 只能对字符串转换 18 } 19 }
(4) 修改 springmvc-beans.xml 文件，添加如下配置
1 <!-- 注册 DataFormatter --> 2 <bean id="formattingConversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean"> 3 <property name="formatters"> 4 <set> 5 <bean class="com.example.formatter.DataFormatter" /> 6 </set> 7 </property> 8 </bean> 9 10 <mvc:annotation-driven conversion-service="formattingConversionService" />
(5) 创建 src/main/java/com/example/controller/FormatterController.java 文件
1 package com.example.controller; 2 3 import org.springframework.stereotype.Controller; 4 import org.springframework.ui.Model; 5 import org.springframework.web.bind.annotation.RequestMapping; 6 7 import com.example.entity.Goods; 8 9 @Controller 10 @RequestMapping("/formatter") 11 public class FormatterController { 12 13 @RequestMapping("/goods2") 14 public String goods2() { 15 return "goods2"; 16 } 17 18 @RequestMapping("/goods2/post") 19 public String goods2Post(Goods goods, Model model) { 20 21 String str = "<br>"; 22 str += "Name: " + goods.getName() + "<br>"; 23 str += "Price: " + goods.getPrice() + "<br>"; 24 str += "Number: " + goods.getNumber() + "<br>"; 25 str += "Create Date: " + goods.getCreateDate() + "<br>"; 26 model.addAttribute("message", str); 27 return "success"; 28 } 29 }
访问：http://localhost:9090/formatter/goods2
浙公网安备 33010602011771号