Spring MVC Formatter（数据格式化）详解

淡淡的烟草味﹌ 2024-03-31 13:57 10阅读 0赞

Spring MVC 框架的 Formatter 与 Converter 一样，也是一个可以将一种数据类型转换成另一种数据类型的接口。不同的是，Formatter 的源数据类型必须是 String 类型，而 Converter 的源数据类型是任意数据类型。

在 Web 应用中由 HTTP 发送的请求数据到控制器中都是以 String 类型获取，因此在 Web 应用中选择 Formatter 比选择 Converter 更加合理。

### 内置的格式化转换器 ###

Spring MVC 提供了几个内置的格式化转换器，具体如下。

*  NumberFormatter：实现 Number 与 String 之间的解析与格式化。
 *  CurrencyFormatter：实现 Number 与 String 之间的解析与格式化（带货币符号）。
 *  PercentFormatter：实现 Number 与 String 之间的解析与格式化（带百分数符号）。
 *  DateFormatter：实现 Date 与 String 之间的解析与格式化。

### 自定义格式化转换器 ###

自定义格式化转换器就是编写一个实现 org.springframework.format.Formatter 接口的 Java 类。该接口声明如下：

> 1.  `public interface Formatter<T>`

这里的 T 表示由字符串转换的目标数据类型。该接口有 parse 和 print 两个接口方法，自定义格式化转换器类必须覆盖它们。

> 1.  `public T parse(String s,java.util.Locale locale)`
> 2.  `public String print(T object,java.util.Locale locale)`

parse 方法的功能是利用指定的 Locale 将一个 String 类型转换成目标类型，print 方法与之相反，用于返回目标对象的字符串表示。

下面通过具体应用 springMVCDemo04 讲解自定义格式化转换器的用法，springMVCDemo04 应用与 springMVCDemo03 应用具有相同的 JAR 包、web.xml。

应用的具体要求如下：

1）用户在页面表单中输入信息来创建商品，输入页面效果如图 1 所示。

![1e9dc0a82f2bf1069ce10a6bcccfd6ef.png][]

图 1 信息输入页面

2）控制器使用实体 bean 类 GoodsModelb 接收页面提交的请求参数，GoodsModelb 类的属性如下。

> 1.  `private String goodsname;`
> 2.  `private double goodsprice;`
> 3.  `private int goodsnumber;`
> 4.  `private Date goodsdate;`

3）GoodsModelb 实体类接收请求参数时，商品名称、价格和数量使用内置的类型转换器完成转换；商品日期需要用自定义的格式化转换器完成。

4）用格式化转换器转换之后的数据显示在 showGoodsb.jsp 页面，效果如图 2 所示。

![70e80a2f538348cf906d8b6ca3972b6c.png][]  
图 2 格式化后信息的显示页面

由图 2 可以看出，日期由字符串值“2018-02-22”格式化成 Date 类型。

如果想实现上述 springMVCDemo04 应用的需求，需要做以下 5 件事：

*  创建实体类；
 *  创建控制器类；
 *  创建自定义格式化转换器类；
 *  注册格式化转换器；
 *  创建相关视图。

按照上述步骤采用自定义格式化转换器完成需求。

1）创建实体类

在 springMVCDemo04 的 src 目录下创建 pojo 包，并在该包中创建名为 GoodsModelb 的实体类，代码如下：

> 1.  `package pojo;`
> 2.  `import java.util.Date;`
> 3.  `public class GoodsModel {`
> 4.  `private String goodsname;`
> 5.  `private double goodsprice;`
> 6.  `private int goodsnumber;`
> 7.  `private Date goodsdate;`
> 8.  `//省略setter和getter方法`
> 9.  `}`

2）创建控制器类

在 springMVCDemo04 的 src 目录下创建 controller 包，并在该包中创建名为 FormatterController 的控制器类，代码如下：

> 1.  `package controller;`
> 2.  `import org.springframework.stereotype.Controller;`
> 3.  `import org.springframework.ui.Model;`
> 4.  `import org.springframework.web.bind.annotation.RequestMapping;`
> 5.  `import pojo.GoodsModelb;`
> 6.  `@Controller`
> 7.  `public class FormatterController {`
> 8.  `@RequestMapping("/formatter")`
> 9.  `public String myConverter(GoodsModelb gm, Model model) {`
> 10. `model.addAttribute("goods", gm);`
> 11. `return "showGoodsb";`
> 12. `}`
> 13. `}`

3）创建自定义格式化转换器类

在 springMVCDemo04 的 src 目录下创建 formatter 包，并在该包中创建名为 MyFormatter 的自定义格式化转换器类，代码如下：

> 1.  `package controller;`
> 2.  `import java.text.ParseException;`
> 3.  `import java.text.SimpleDateFormat;`
> 4.  `import java.util.Date;`
> 5.  `import java.util.Locale;`
> 6.  `import org.springframework.format.Formatter;`
> 7.  `public class MyFormatter implements Formatter<Date> {`
> 8.  `SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");`
> 9.  `public String print(Date object, Locale arg1) {`
> 10. `return dateFormat.format(object);`
> 11. `}`
> 12. `public Date parse(String source, Locale arg1) throws ParseException {`
> 13. `return dateFormat.parse(source); // Formatter只能对字符串转换`
> 14. `}`
> 15. `}`

4）注册格式化转换器

在 springMVCDemo04 的 WEB-INF 目录下创建配置文件 springmvc-servlet.xml，并在配置文件中注册格式化转换器，具体代码如下：

> 1.  `<?xml version="1.0" encoding="UTF-8"?>`
> 2.  `<beans xmlns="http://www.springframework.org/schema/beans"`
> 3.  `xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc"`
> 4.  `xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context"`
> 5.  `xsi:schemaLocation="`
> 6.  `http://www.springframework.org/schema/beans`
> 7.  `http://www.springframework.org/schema/beans/spring-beans.xsd`
> 8.  `http://www.springframework.org/schema/context`
> 9.  `http://www.springframework.org/schema/context/spring-context.xsd`
> 10. `http://www.springframework.org/schema/mvc`
> 11. `http://www.springframework.org/schema/mvc/spring-mvc.xsd">`
> 12. ``
> 13. `<context:component-scan base-package="controller" />`
> 14. ``
> 15. `<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">`
> 16. `<property name="formatters">`
> 17. `<list>`
> 18. `<bean class="formatter.MyFormatter"/>`
> 19. `</list>`
> 20. `</property>`
> 21. `</bean>`
> 22. `<mvc:annotation-driven conversion-service="conversionService"/>`
> 23. `<bean`
> 24. `class="org.springframework.web.servlet.view.InternalResourceViewResolver">`
> 25. `<property name="prefix" value="/WEB-INF/jsp/" />`
> 26. `<property name="suffix" value=".jsp" />`
> 27. `</bean>`
> 28. `</beans>`

5）创建相关视图

在 springMVCDemo04 应用的 WebContent 目录下创建信息输入页面 inputb.jsp，核心代码如下：

> 1.  `<%@ page language="java" contentType="text/html; charset=UTF-8"`
> 2.  `pageEncoding="UTF-8"%>`
> 3.  `<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">`
> 4.  `<html>`
> 5.  `<head>`
> 6.  `<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">`
> 7.  `<title>添加商品信息</title>`
> 8.  `</head>`
> 9.  `<body>`
> 10. `<form action="addGoods" method="post">`
> 11. `<table border=1 bgcolor="lightblue" align="center">`
> 12. `<tr>`
> 13. `<td>商品名称：</td>`
> 14. `<td><input class="textSize" type="text" name="goodsname" /></td>`
> 15. `</tr>`
> 16. `<tr>`
> 17. `<td>商品价格：</td>`
> 18. `<td><input class="textSize" type="text" name="goodsprice" /></td>`
> 19. `</tr>`
> 20. `<tr>`
> 21. `<td>商品数量：</td>`
> 22. `<td><input class="textSize" type="text" name="goodsnumber" /></td>`
> 23. `</tr>`
> 24. `<tr>`
> 25. `<td>商品日期：</td>`
> 26. `<td><input class="textSize" type="text" name="goodsdata" />（yyyy-MM-dd）</td>`
> 27. `</tr>`
> 28. `<tr>`
> 29. `<td colspan="2" align="center">`
> 30. `<input type="submit" value="提交" />`
> 31. `</td>`
> 32. `</tr>`
> 33. `</tab1e>`
> 34. `</form>`
> 35. `</body>`
> 36. `</html>`

在 springMVCDemo04 应用的 /WEB-INF/jsp 目录下创建信息显示页面 showGoodsb.jsp，核心代码如下：

> 1.  `<body>`
> 2.  `您创建的商品信息如下：`
> 3.  ``
> 4.  `商品名称为：${goods.goodsname }<br/>`
> 5.  `商品价格为：${goods.goodsprice }<br/>`
> 6.  `商品名称为：${goods.goodsnumber }<br/>`
> 7.  `商品日期为：${goods.goodsdate}`
> 8.  `</body>`

最后通过地址“http://localhost：8080/springMVCDemo04/inputb.jsp”测试应用。

[1e9dc0a82f2bf1069ce10a6bcccfd6ef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/5625e5901dbf450eb7d76fad302ecb15.png
[70e80a2f538348cf906d8b6ca3972b6c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/4e038312db6f419c918c703d89d953c2.png