【Java 高阶】一文精通 Spring MVC - 数据格式化器（六）

在这里插入图片描述

👉博主介绍：博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️ 个人社区：个人社区
💞 个人主页：个人主页
🙉 专栏地址： ✅ Java 高阶
🙉八股文专题：剑指大厂，手撕 Java 八股文

文章目录

- - 1. 什么是数据格式化器
  - 2. 数据格式化器的应用场景
  - 3. DateFormatter
  - 4. NumberFormatter
  - 5. CurrencyFormatter
  - 6. DateFormatterRegistrar
  - 7.FormattingConversionServiceFactoryBean
  - 8. 自定义格式化器

1. 什么是数据格式化器

SpringMVC 内置数据格式化是指在 SpringMVC 框架中，可以自动将请求参数或响应数据进行格式化。这样可以方便地将数据从一种格式转换为另一种格式，例如将字符串转换为日期对象，或将数字格式化为货币形式等。

SpringMVC 内置了许多常见的数据格式化器，可以通过注解或配置文件进行配置和使用。以下是一些常见的内置数据格式化器：

DateFormatter：用于将日期字符串转换为日期对象，或将日期对象格式化为指定的日期字符串格式。
NumberFormatter：用于将数字字符串转换为数字对象，或将数字对象格式化为指定的数字字符串格式。
CurrencyFormatter：用于将数字对象格式化为指定的货币字符串格式。
DateFormatterRegistrar：用于注册自定义的日期格式化器。
FormattingConversionServiceFactoryBean：用于配置和管理数据格式化器。

要使用内置数据格式化器，可以在 SpringMVC 的配置文件中进行相应的配置。例如，可以使用 <mvc:annotation-driven> 标签启用注解驱动的数据格式化支持，并在相应的字段或方法上使用 @DateTimeFormat 、 @NumberFormat 等注解来指定数据格式化方式。

如果内置的数据格式化器无法满足需求，还可以自定义数据格式化器来处理特定的格式化需求。可以实现 SpringMVC 的 Formatter 接口，并将其注册到 SpringMVC 的配置中。

2. 数据格式化器的应用场景

数据格式化器在 SpringMVC 中有很多应用场景。以下是一些常见的应用场景：

表单提交：当用户提交表单数据时，可以使用内置数据格式化器将用户输入的数据转换为目标对象的属性类型。例如，将字符串转换为日期对象、将字符串转换为数字对象等。
数据展示：在将数据展示给用户时，可以使用内置数据格式化器将数据格式化为用户友好的形式。例如，将日期对象格式化为指定的日期字符串格式、将数字对象格式化为货币形式等。
数据校验：在进行数据校验时，可以使用内置数据格式化器来验证输入数据的格式是否符合要求。例如，验证日期字符串是否符合指定的日期格式、验证数字字符串是否符合指定的数字格式等。
数据持久化：在将数据持久化到数据库或其他存储介质时，可以使用内置数据格式化器将数据转换为存储介质所需的格式。例如，将日期对象转换为数据库支持的日期格式、将数字对象转换为数据库支持的数字格式等。
响应数据格式化：在返回响应数据给客户端时，可以使用内置数据格式化器将数据格式化为指定的格式。例如，将日期对象格式化为指定的日期字符串格式、将数字对象格式化为指定的数字字符串格式等。

3. DateFormatter

DateFormatter 是 SpringMVC 内置的数据格式化器之一，用于将日期字符串转换为日期对象，或将日期对象格式化为指定的日期字符串格式。以下是 DateFormatter 的使用案例：

在 SpringMVC 的配置文件中配置 DateFormatter：

<bean id="dateFormatter" class="org.springframework.format.datetime.DateFormatter">
    <property name="pattern" value="yyyy-MM-dd" />
</bean>

在控制器中使用 DateFormatter：

@Controller
public class MyController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.addCustomFormatter(new DateFormatter("yyyy-MM-dd"));
    }

    @RequestMapping("/example")
    public String example(@RequestParam("date") Date date) {
        // 处理日期对象
        return "example";
    }
}

在上述示例中，配置了一个 DateFormatter 对象，并指定了日期格式为 “yyyy-MM-dd”。然后，在控制器的方法参数中使用了 @RequestParam 注解，将请求参数 “date” 自动转换为 Date 类型的对象。

通过这样的配置和使用，当请求中的 “date” 参数为符合指定格式的日期字符串时，SpringMVC 会自动将其转换为 Date 对象。反之，如果请求中的参数无法转换为 Date 对象，将会抛出异常或使用默认值。

4. NumberFormatter

NumberFormatter 是 SpringMVC 内置的数据格式化器之一，用于将数字字符串转换为数字对象，或将数字对象格式化为指定的数字字符串格式。以下是 NumberFormatter 的使用案例：

在 SpringMVC 的配置文件中配置 NumberFormatter：

<bean id="numberFormatter" class="org.springframework.format.number.NumberFormatter">
    <property name="pattern" value="#,##0.00" />
</bean>

在控制器中使用 NumberFormatter：

@Controller
public class MyController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.addCustomFormatter(new NumberFormatter("#,##0.00"));
    }

    @RequestMapping("/example")
    public String example(@RequestParam("amount") BigDecimal amount) {
        // 处理金额对象
        return "example";
    }
}

在上述示例中，配置了一个 NumberFormatter 对象，并指定了数字格式为 “#,##0.00”。然后，在控制器的方法参数中使用了 @RequestParam 注解，将请求参数 “amount” 自动转换为 BigDecimal 类型的对象。

通过这样的配置和使用，当请求中的 “amount” 参数为符合指定格式的数字字符串时，SpringMVC 会自动将其转换为 BigDecimal 对象。反之，如果请求中的参数无法转换为 BigDecimal 对象，将会抛出异常或使用默认值。

5. CurrencyFormatter

CurrencyFormatter 是 SpringMVC 内置的数据格式化器之一，用于将数字对象格式化为指定的货币字符串格式。以下是 CurrencyFormatter 的使用案例：

在 SpringMVC 的配置文件中配置 CurrencyFormatter：

<bean id="currencyFormatter" class="org.springframework.format.number.CurrencyFormatter">
    <property name="currencyCode" value="USD" />
</bean>

在控制器中使用 CurrencyFormatter：

@Controller
public class MyController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.addCustomFormatter(new CurrencyFormatter());
    }

    @RequestMapping("/example")
    public String example(@RequestParam("amount") BigDecimal amount) {
        // 处理金额对象
        return "example";
    }
}

在上述示例中，配置了一个 CurrencyFormatter 对象，并指定了货币代码为 “USD”（美元）。然后，在控制器的方法参数中使用了 @RequestParam 注解，将请求参数 “amount” 自动转换为 BigDecimal 类型的对象。

通过这样的配置和使用，当请求中的 “amount” 参数为数字时，SpringMVC 会自动将其格式化为指定货币格式的字符串。例如，将数字 1000 转换为 “$1,000.00”。

6. DateFormatterRegistrar

DateFormatterRegistrar 是 SpringMVC 内置的日期格式化注册器，用于注册自定义的日期格式化器。以下是 DateFormatterRegistrar 的使用案例：

创建自定义的日期格式化器：

public class CustomDateFormatter implements Formatter<Date> {

    private String pattern;

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

    @Override
    public Date parse(String text, Locale locale) throws ParseException {
        SimpleDateFormat dateFormat = createDateFormat(locale);
        return dateFormat.parse(text);
    }

    @Override
    public String print(Date date, Locale locale) {
        SimpleDateFormat dateFormat = createDateFormat(locale);
        return dateFormat.format(date);
    }

    private SimpleDateFormat createDateFormat(Locale locale) {
        SimpleDateFormat dateFormat = new SimpleDateFormat(pattern, locale);
        dateFormat.setLenient(false);
        return dateFormat;
    }
}

在上述示例中，我们创建了一个自定义的日期格式化器 CustomDateFormatter，实现了 Formatter 接口，并重写了 parse() 和 print() 方法来进行日期的解析和格式化。

在 SpringMVC 的配置文件中配置 DateFormatterRegistrar：

<bean class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
    <property name="formatters">
        <set>
            <bean class="com.example.CustomDateFormatter">
                <constructor-arg value="yyyy-MM-dd" />
            </bean>
        </set>
    </property>
</bean>

在上述示例中，我们使用 FormattingConversionServiceFactoryBean 配置了自定义的日期格式化器 CustomDateFormatter，并指定了日期格式为 “yyyy-MM-dd”。

通过这样的配置，SpringMVC 将会注册我们自定义的日期格式化器，并在需要进行日期格式化或解析的地方使用它。

7.FormattingConversionServiceFactoryBean

FormattingConversionServiceFactoryBean 是 SpringMVC 内置的数据格式化器注册器，用于配置和管理数据格式化器。以下是 FormattingConversionServiceFactoryBean 的使用案例：

在 SpringMVC 的配置文件中配置 FormattingConversionServiceFactoryBean：

<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
    <property name="formatters">
        <set>
            <bean class="org.springframework.format.datetime.DateFormatter">
                <property name="pattern" value="yyyy-MM-dd" />
            </bean>
            <bean class="org.springframework.format.number.NumberFormatter">
                <property name="pattern" value="#,##0.00" />
            </bean>
            <!-- 添加其他的数据格式化器 -->
        </set>
    </property>
</bean>

在上述示例中，我们配置了一个 FormattingConversionServiceFactoryBean 对象，并在其中添加了内置的日期格式化器 DateFormatter 和数字格式化器 NumberFormatter。可以根据需要添加其他的数据格式化器。

在控制器中使用 FormattingConversionServiceFactoryBean：

@Controller
public class MyController {

    @Autowired
    private FormattingConversionServiceFactoryBean conversionService;

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.setConversionService(conversionService.getObject());
    }

    @RequestMapping("/example")
    public String example(@RequestParam("date") Date date, @RequestParam("amount") BigDecimal amount) {
        // 处理日期对象和金额对象
        return "example";
    }
}

在上述示例中，我们注入了 FormattingConversionServiceFactoryBean 对象，并在控制器的 initBinder() 方法中将其设置为 WebDataBinder 的 ConversionService。这样，在控制器的方法参数中使用了 @RequestParam 注解时，SpringMVC 会自动使用配置的数据格式化器进行参数的转换和格式化。

通过这样的配置和使用，我们可以方便地管理和使用多个数据格式化器，以满足不同类型的数据格式化需求。

8. 自定义格式化器

SpringMVC 提供了自定义格式化器的功能，可以根据特定的需求创建自定义的格式化器。以下是 SpringMVC 自定义格式化器的代码案例：

创建自定义格式化器：

public class CustomFormatter implements Formatter<CustomObject> {

    @Override
    public CustomObject parse(String text, Locale locale) throws ParseException {
        // 解析字符串并返回自定义对象
        CustomObject customObject = new CustomObject();
        // 解析逻辑...
        return customObject;
    }

    @Override
    public String print(CustomObject customObject, Locale locale) {
        // 将自定义对象格式化为字符串
        String formattedString = "";
        // 格式化逻辑...
        return formattedString;
    }
}

在上述示例中，我们创建了一个自定义的格式化器 CustomFormatter，实现了 Formatter 接口，并重写了 parse() 和 print() 方法来进行格式化和解析。

注册自定义格式化器：

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

<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
    <property name="formatters">
        <set>
            <bean class="com.example.CustomFormatter" />
        </set>
    </property>
</bean>

在 SpringMVC 的配置文件中，我们使用 <mvc:annotation-driven> 标签启用注解驱动的数据格式化支持，并配置了一个 FormattingConversionServiceFactoryBean 对象。在该对象中，我们将自定义的格式化器 CustomFormatter 添加到 formatters 集合中。

通过这样的配置，SpringMVC 将会注册我们自定义的格式化器，并在需要进行格式化或解析的地方使用它。