Spring MVC格式化器（Java学习笔记）

于 2023-04-05 11:57:48 发布
阅读量161 收藏
点赞数
分类专栏： Spring MVC 文章标签： java spring mvc
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_59803718/article/details/129967615
版权

在实际的项目开发中，经常会涉及到一些需要进行格式化的数据，例如金额、日期等。以金额为例，当金额为 10 万元时，在比较正式的场合往往要写成 ￥100000；而日期也可以被写作多种格式，例如 yyyy-MM-dd、yyyy-MM-dd hh:ss:mm 等。这些数据都要经过一定的格式化处理才能够正常使用。

Formatter接口

Spring 提供了一个 Formatter 接口， T 表示目标数据类型，它被称为格式化转换器。

Formatter 的作用与 Converter（类型转换器）相似，都是可以将一种数据类型转换成另一种数据类型。但不同的是，Formatter 的源类型必须是 String 类型，而 Converter 的源类型可以是任意数据类型。

package org.springframework.format;

public interface Formatter<T> extends Printer<T>, Parser<T> {
}

Formatter 接口继承了 Printer 和 Parser 接口，其泛型 T 表示字符串需要转换的目标类型。 在 Printer 和 Parser 接口中，分别包含一个 print() 方法和一个 parse() 方法。Spring MVC 中所有的格式化转换器实现类都必须重写（覆盖）这两个方法。

方法接口说明
T parse(String text, Locale locale) throws ParseException; Printer该方法能够将数据按照一定的格式输出成字符串。该方法中包含一个 Locale 类型的参数，即该方法可根据地区来做出相应的定制。
String print(T object, Locale locale); Parser该方法能够将满足一定格式的字符串转换为对象。其包含一个 Locale 类型的参数，即该方法可根据国家和地区做出相应的定制。

内置格式化转换器

Spring MVC 默认提供了多个内置的格式化器，通过它们，我们可以轻松地实现对日期（Date）类型和数值（Number）类型数据的格式化工作，具体如下。

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

虽然 Formatter 与 Converter 存在一定的差异，但格式化转换本质上还是属于“类型转换”的范畴，因此在 Spring MVC 中 Formatter（格式化转换器）实际上是委托给 Converter 机制实现的。

Spring 的格式化模块中定义了一个 FormattingConversionService 类，它是 ConversionService 接口（类型转换器的服务接口）的实现类。它与其他的类型转换器实现类不同，它不仅具有类型转换功能，还具有格式化转换功能。

Spring MVC 还专门为 FormattingConversionService 提供了一个名为 FormattingConversionServiceFactroyBean 的工厂类，它主要作用就是在 Spring 上下文中构造 FormattingConversionService 的实例。

除此之外，FormattingConversionServiceFactroyBean 还为以下 2 个格式化注解提供了支持，使得我们可以更加方便地使用 Spring MVC 内置的格式化器，对数据进行格式化转换。

格式化注解说明
@DateTimeFormat 注解使用该注解，能够实现对日期类型数据的格式化
@NumberFormat 注解使用该注解，能够实现对数值类型数据的格式化

我们知道，只要 Spring MVC 的配置文件中配置一个 mvc:annotation-driven 标签，Spring MVC 在启动时就会自动初始化一个 FormattingConversionServiceFactoryBean 类型的实例：ConversionService。

也就是说，我们只要在 Spring MVC 配置文件中配置了 mvc:annotation-driven 标签，就可以直接在 Spring MVC 项目中使用 @NumberFormat 注解和 @DateTimeFormat 注解，对 Number 类型和 Date 类型数据进行格式化转换。

日期格式化

@DateTimeFormat 注解可对 java.util.Date、java.util.Calendar、java.long.Long 等时间类型的数据进行标注，以实现对日期类型的数据进行格式化处理。

@DateTimeFormat 注解主要包含以下 3 个属性。

属性类型说明
patternString用于指定解析或格式化日期时间的模式，其常用取值包括 yyyy-MM-dd、yyyy-MM-dd hh:mm:ss 等。
isoDateTimeFormat.ISO用于指定解析或格式化日期时间的 ISO 模式，其取值有 4 种：DATE：yyyy-MM-dd。TIME：hh:mm:ss:SSSZ。DATE_TIME：yyyy-MM-dd hh:mm:ss:SSSZ。NONE：无
styleString用于指定日期时间的格式。该属性由两个字符组成，第一个字符表示日期的格式，第二个字符表示时间的格式。S：短日期/时间格式。M：中日期/时间格式。L：长日期/时间格式。F：完整日期/时间格式。其默认值为“SS”，即日期和时间都采用短格式。

数值格式化@NumberFormat 注解可以用来格式化任何数字基本类型（如 int、long 等）或 java.lang.Number 类型的实例（如 BigDecimal、Integer 等)。

@NumberFormat 注解拥有两个互斥的属性，如下表。

属性类型说明
styleNumberFormat.Style该属性用于指定数值的样式类型，其取值有以下 4 种：DEFAULT：默认类型/NUMBER：正常数值类型/PERCENT：百分数类型/CURRENCY：货币数值类型
patternString该属性用于自定义数值的样式星星，例如 #,###

实例

创建Spring MVC项目添加相关依赖:
pom.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>formatter</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>formatter</name>
    <packaging>war</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.target>1.8</maven.compiler.target>
        <maven.compiler.source>1.8</maven.compiler.source>
        <junit.version>5.8.2</junit.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-engine</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
        <!--    Spring Web MVC 开发必备依赖-->
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-expression</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.15.RELEASE</version>
        </dependency>

        <!--    Thymeleaf的依赖-->
        <dependency>
            <groupId>org.attoparser</groupId>
            <artifactId>attoparser</artifactId>
            <version>2.0.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.25</version>
        </dependency>
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.15.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.unbescape</groupId>
            <artifactId>unbescape</artifactId>
            <version>1.1.6.RELEASE</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.3.2</version>
            </plugin>
        </plugins>
    </build>
</project>

web.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--请求和响应的字符串过滤器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!--来处理 PUT 和 DELETE 请求的过滤器-->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--配置 DispatcherServlet 的一个初始化参数：spring mvc 配置文件按的位置和名称-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>

        <!--作为框架的核心组件，在启动过程中有大量的初始化操作要做
            而这些操作放在第一次请求时才执行会严重影响访问速度
            因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时-->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <!--设置springMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求-->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

在rersource文件夹下创建springMVC.xml：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--开启组件扫描-->
    <context:component-scan base-package="com.example.formatter"/>

    <!-- 配置 Thymeleaf 视图解析器 -->
    <bean id="viewResolver"
          class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!-- 视图前缀 -->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!-- 视图后缀 -->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>
    <!--view-name：设置请求地址所对应的视图名称-->
    <mvc:view-controller path="/" view-name="supermarket"/>
    <!--注解驱动-->
    <mvc:annotation-driven/>
</beans>

bean.Supermarket类：

package com.example.formatter.bean;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.format.annotation.NumberFormat;

import java.math.BigDecimal;
import java.util.Date;


public class Supermarket {
    private String name;
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private Date date;
    /**
     * 使用 @NumberFormat 注解格式化数值
     */
    @NumberFormat(style = NumberFormat.Style.CURRENCY)
    private BigDecimal money;


    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public BigDecimal getMoney() {
        return money;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }

    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

    @Override
    public String toString() {
        return "Supermarket{" +
                "name='" + name + '\'' +
                ", date=" + date +
                ", money=" + money +
                '}';
    }
}

controller.MarketController

package com.example.formatter.controller;

import com.example.formatter.bean.Supermarket;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class MarketController {

    @RequestMapping(value = "/market", method = RequestMethod.POST)
    public String login(Supermarket market, Model model) {
        model.addAttribute("market", market);
        System.out.println(market);
        return "success";
    }
}

在WEB-INF/templates下：
supermarket.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
  <meta charset="UTF-8">
  <title>测试</title>
</head>
<body>
<form th:action="@{/market}" method="post">
  <table>
    <tr>
      <td>名称：</td>
      <td><input type="text" name="name" required><br></td>
    </tr>
    <tr>
      <td>收入：</td>
      <td><input type="text" name="money" required><br></td>
    </tr>
    <tr>
      <td>日期：</td>
      <td><input type="date" name="date" required><br></td>
    </tr>

    <tr>
      <td colspan="2" align="center">
        <input type="submit" value="提交">
        <input type="reset" value="重置">
      </td>
    </tr>
  </table>
</form>
</body>
</html>

success.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
  <meta charset="UTF-8">
  <title>测试</title>
</head>
<body>
<table>
  <tr>
    <td>名称：</td>
    <td th:text="${market.getName()}"></td>
  </tr>
  <tr>
    <td>收入：</td>
    <td th:text="${market.getMoney()}"></td>
  </tr>
  <tr>
    <td>日期：</td>
    <td th:text="${#dates.format(market.getDate(),'yyyy-MM-dd')}"></td>
  </tr>
</table>
</body>
</html>

修改应用配置：
在这里插入图片描述
启动应用：
在这里插入图片描述
运行结果：
在这里插入图片描述

#学习原文

L葵-阳S
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
实现Formatter接口
qq_40561126的博客
12-27 468
package com.gem.formatter; import org.springframework.format.Formatter; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; import java.util.Locale; public cl...
SpringMVC-12-格式化Formatter
时光
07-12 166
SpringMVC-12-格式化Formatter
Spring MVC Formatter（数据格式化）详解
最新发布
unber的博客
12-01 901
Spring MVC 框架的 Formatter与 Converter一样，也是一个可以将一种数据类型转换成另一种数据类型的接口。不同的是，Formatter的源数据类型必须是 String 类型，而 Converter的源数据类型是任意数据类型。
Maven xml文件格式化插件
隔壁老瓦的专栏
08-13 2062
Spring Java Format What is This? A set of plugins that can be applied to any Java project to provide a consistent “Spring” style. The set currently consists of: A source formatter that applies wrapping and whitespace conventions A checkstyle plug
@DateTimeFormat注解问题
wangjianhua_love的博客
04-25 1万+
org.springframework.format.annotation.DateTimeFormat在springMVC框架中对日期string类型转化时,会出现日期冬夏令时的问题,比如birthdate=1986-05-04转换成@DateTimeFormat(pattern = "yyyy-MM-dd")private Date birthdate;会报非法异常调用方法在org.elast...
Spring MVC 学习笔记 十二 PDF/Excel格式输出
03-24
本学习笔记主要围绕Spring MVC的使用、配置和核心组件进行深入探讨，旨在帮助开发者更好地理解和掌握这一框架。 在Spring MVC中，Model代表业务逻辑和数据，View负责数据的展示，而Controller处理用户请求，协调...
Spring MVC 学习笔记 九 json格式的输入和输出
03-23
在这个学习笔记中，我们将深入探讨如何在Spring MVC中处理JSON格式的数据，包括输入和输出。JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，广泛应用于前后端数据传输。 1. **JSON格式简介** ...
Spring MVC 学习笔记 十一 data binding
03-24
本学习笔记将深入探讨Spring MVC中的数据绑定特性。 1. **数据绑定的基本概念** 数据绑定是Spring MVC中的一种核心功能，它允许我们将HTTP请求参数、JSON或XML数据自动映射到Java对象的属性上。这减少了手动提取...
Spring MVC 学习笔记
11-28
以下是对Spring MVC学习笔记的详细解释： 1. **创建项目**： 创建Spring MVC项目通常从构建一个Maven工程开始。在命令行中使用Maven的`archetype:generate`命令创建一个JEE5的Web工程。在提供的例子中，使用了特定...
基于注解的spring_3.0.x_MVC学习笔记
01-26
在本篇基于注解的Spring 3.0.x MVC学习笔记中，我们将深入探讨Spring MVC在3.0版本中的...接下来，你可以进一步探索如数据绑定、转换器和格式化器、拦截器、AOP等方面的内容，以全面掌握Spring 3.0.x MVC的强大功能。
SpringMVC的格式化转换器Formatter
nuist_NJUPT的博客
09-29 559
SpringMVC的格式化转换器Formatter SpringMVC框架的Formatter和Converter一样，也是一个可以将一种数据类型转换成另外一种数据类型的接口，不同的是Formatter的数据源必须是String类型，而Converter源数据类型可以是任意的。 因为在WEB应用中由http发送的请求数据到控制器都是以String类型获取，因此在Web应用中选择Formatter比选择Converter更合理。 下面演示一个用户在信息采集页面输入数据，创建商品信息，控制器类接收请求参数，并调
SpringMVC--Formatter（数据格式化）详解
吴声子夜歌的博客
10-31 1365
Spring MVC Formatter Spring MVC 框架的 Formatter 与 Converter<S，T> 一样，也是一个可以将一种数据类型转换成另一种数据类型的接口。不同的是，Formatter 的源数据类型必须是 String 类型，而 Converter<S，T> 的源数据类型是任意数据类型。 在 Web 应用中由 HTTP 发送的请求数据到控制器中...
数据前置参数类型转换@InitBinder、Formatter＜?＞、Converter＜?＞的使用
风团团
01-13 486
前言：在很多时候我们在进行调用接口的时候，传入的参数类型不是指定的特别明确（或者是不能进行自动类型转换），会导致调用接口失败的情况出现，如果我们在调用接口之前进行数据格式化，手动进行数据类型转换，那么就不会出现调用接口失败的情况出现了。这些注解无非也就是做这些工作的。 下面列举工作绝大部分用到的场景 @ResponseBody @RequestMapping(value = "/bookDo", produces = "application/json" , c.
深入分析Spring Formatter
everyok的博客
07-24 1215
  在Web项目中，通常需要将数据转换为具有某种格式的字符串进行展示，因此Spring3引入了格式化转换器（Formatter SPI） 和格式化服务API（FormattingConversionService）从而支持这种需求。现在来看看格式转换器相关的接口定义： Printer接口：格式化显示接口，将T类型的对象根据Locale信息以某种格式进行打印显示（即返回字符串形式），源码如下图所示...
使用Formatter格式化数据
汉南最後の読書人
03-25 9902
代码： registerForm.jsp 测试Formatter接口 注册页面 登录名: 生日:
如何正确使用表格组件的formatter属性
热门推荐
wangmj518的专栏
07-10 1万+
fastadmin前端表格组件使用的是bootstrap-table，如果我们想要自定义表格的内容，可以使用formatter属性。最常规的用法如下： columns: [ [ { field: 'type', title: __('type'), formatter: fun...
springboot自定义Converter和Formatter
剪刀手何金银的技术博客
11-09 1240
Converter和Formatter(pojo参数绑定解析器) 当我们在controller方法的入参为一个javabean类型并且没有使用任何注解进行标注，springboot将会使用ServletModelAttributeMethodProcessor方法处理器对请求参数和javaBean对象的属性进行绑定，在ServletModelAttributeMethodProcessor内部会调用参数转换器将请求参数与javaBean的属性对象进行类型转换再使用反射进行参数绑定，例如 请求参数时stri
Spring MVC与MyBatis集成：企业级云笔记登录实现
在本系列的学习中，我们将重点探讨如何在云笔记应用中集成Spring MVC（Model-View-Controller）架构模式，以及Spring IoC (Inversion of Control) 和 MyBatis 数据持久层框架。 首先，我们从云笔记项目的环境搭建...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值