SpringBoot中Formatter和Converter用法和区别小结

更新时间：2023年07月06日 08:41:27 作者：freesOcean

本文主要介绍了SpringBoot中Formatter和Converter用法和区别，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

功能区别：

两者的作用一样，都是类型转换。

org.springframework.format.Formatter只能做String类型到其他类型的转换。
org.springframework.core.convert.converter.Converter可以做任意类型的转换。

Converter是一般工具，可以将一种类型转换成另一种类型。例如，将String转换成Date，或者将Long转换成Date。Converter既可以用在web层，也可以用在其它层中。Formatter只能将String转成成另一种java类型。例如，将String转换成Date，但它不能将Long转换成Date。

Formatter

Formatter使用示例：

1.定义Formatter类：

需要实现Formatter接口, 并在pase方法中进行转换的逻辑。通过@Component自动将其添加到SpringBoot容器，这样就会自动生效。

@Component
public class StudentFormatter implements Formatter<Student> {
    /**
     * 校验不太严密，仅作演示
     */
    @Override
    public Student parse(String text, Locale locale) {
        if (NumberUtils.isParsable(text)) {
            Student s =  new Student();
            s.setAge(Integer.parseInt(text));
            return s;
        }
        return null;
    }
    @Override
    public String print(Student money, Locale locale) {
        if (money == null) {
            return null;
        }
        return money.getAge()+"";
    }
}

2.Controller中的代码：

@PostMapping(path = "/stu")
@ResponseBody
public String sst(NewRequest newCoffee) {
    return newCoffee.getStudent().getAge()+"";
}

数据实体：

@Getter
@Setter
@ToString
public class NewRequest {
    private String name;
    private Student student;
}

3.访问：http://localhost:8080/stu

采用application/x-www-form-urlencoded 参数类型传递参数。

这样服务端收到参数，就会自动将字符串转换成一个Student对象。

注意点：这里采用了application/x-www-form-urlencoded提交参数，所以在Controller中不能加@RequestBody，并且参数名称要和数据对象的属性保持一致。如果采用json格式数据交互，测试发现解析报错。

{
    "timestamp": "2019-09-05T07:42:00.809+0000",
    "status": 400,
    "error": "Bad Request",
    "message": "JSON parse error: Current token (VALUE_STRING) not numeric, can not use numeric value accessors; nested exception is com.fasterxml.jackson.databind.JsonMappingException: Current token (VALUE_STRING) not numeric, can not use numeric value accessors\n at [Source: (PushbackInputStream); line: 1, column: 29] (through reference chain: geektime.spring.springbucks.waiter.controller.request.NewCoffeeRequest[\"price\"])",
    "path": "/coffee/addJson"
}

说明在转换成自定义的对象时，必须通过form格式进行传参。

但奇怪的是Date类型的转换，通过json格式传递参数，可以正常转换。如下：

@Component
public class DateFormatter implements Formatter<Date> {
    @Override
    public Date parse(String text, Locale locale) throws ParseException {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmmss");
        System.out.println("parse input text: " + text);
        System.out.println("parse date: " + dateFormat.parse(text));
        return dateFormat.parse(text);
    }
    @Override
    public String print(Date object, Locale locale) {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmmss");
        System.out.println("print method." + object);
        return dateFormat.format(object);
    }
}

Controller中：

    @ResponseBody
    @PostMapping(path = "/date")
    public String formatterStringToDate(@RequestBody ZXRequest date) {
        System.out.println("action method: " + date.getDate().getTime());
        return date.getDate().getTime()+"";
    }

数据类：

@Getter
@Setter
@ToString
public class ZXRequest {
    private Date date;
}

访问：

可以正常返回。说明转换正确。关于原因，目前尚不清楚，有知道的，希望留言。

Converter使用示例：

1.创建转换类：其他步骤和Formatter完全一样。

@Component
public class StudentConvert implements Converter<String ,Student> {
    @Override
    public Student convert(String text) {
        if (NumberUtils.isParsable(text)) {
            Student s =  new Student();
            s.setAge(Integer.parseInt(text));
            return s;
        }
        return new Student();
    }
}

如果同时定义了Converter和Formatter，并且转换同一个类型，会采用哪个进行转换？

测试证明，同时定义Student的转换类，会采用Formatter。

到此这篇关于SpringBoot中Formatter和Converter用法和区别小结的文章就介绍到这了,更多相关SpringBoot Formatter Converter 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

JAVA POI设置EXCEL单元格格式用法举例
这篇文章主要给大家介绍了关于JAVA POI设置EXCEL单元格格式用法的相关资料,POI中可能会用到一些需要设置EXCEL单元格格式的操作,需要的朋友可以参考下
2023-08-08
springboot logback如何从apollo配置中心读取变量
这篇文章主要介绍了springboot logback如何从apollo配置中心读取变量的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
详解SpringBoot如何统一处理返回的信息
现在的项目是前后端开发的居多，那么我们怎么定义接口返回的数据，怎么使用 Spring Boot 来统一处理返回的信息呢，本文就来和大家简单讲讲
2023-06-06
详解Java匿名内部类
这篇文章介绍了Java匿名内部类的实现，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-12-12
Idea和Docker如何集成
今天就介绍下idea和Docker如何集成,要集成之前,需要我们本机能够访问docker服务,也就是我们的docker服务需要开启远程模式,本文给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
2023-10-10
Java实现分页代码
这篇文章主要为大家详细介绍了Java实现分页代码，提高查询效率,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-09-09
基于JDOM生成解析XML过程解析
这篇文章主要介绍了基于JDOM生成解析XML过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-10-10
Java Servlet中Response对象的使用方法
本文介绍了Java Servlet中Response对象的使用方法，包括设置响应头、设置响应编码、向客户端发送数据、重定向等操作，同时介绍了常用的响应状态码和响应类型，帮助读者更好地理解和掌握Servlet中Response对象的用法
2023-05-05
避免多个jar通过maven打包导致同名配置文件覆盖冲突问题
这篇文章主要介绍了避免多个jar通过maven打包导致同名配置文件覆盖冲突问题，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
Java基于NIO实现群聊系统
这篇文章主要为大家详细介绍了Java基于NIO实现群聊系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-11-11