Spring Boot 自定义Jackson ObjectMapper,你学会了吗?

网站建设2年前发布
52 00

在Spring Boot Web 项目中,当使用JSON格式接收数据和返回数据的时候,Spring Boot 默认使用一个ObjectMapper实例来序列化响应和反序列化请求。,在本文中,我们将看看配置序列化和反序列化选项的最常用方法。,默认情况下,Spring Boot的配置将禁用以下配置项。,举个例子,我们将通过使用String和LocalDateTime对象来示范定制选项。,我们还将定义一个简单的REST控制器来演示序列化。,默认情况下,这将是调用GET http://lolcahost:8080/coffee?brand=javazzz 时的响应。,我们希望排除空值,并有一个自定义的日期格式(dd-MM-yyyy HH:mm)。这就是我们的响应结果。,在使用Spring Boot时,我们可以选择定制默认的ObjectMapper或覆盖它。我们将在接下来的章节中介绍这两个选项。,在本节中,我们将看到如何定制Spring Boot使用的默认ObjectMapper。,1.应用程序属性和自定义 Jackson 模块,配置映射器的最简单方法是通过应用程序属性。,下面是配置的一般结构。,作为一个例子,下面是我们要添加的内容,以禁用SerializationFeature.WRITE_DATES_AS_TIMESTAMPS。,除了提到的特征类别,我们还可以配置属性的包含。,配置环境变量是最简单的方法。这种方法的缺点是,我们不能定制高级选项,比如为LocalDateTime定制日期格式。,在这一点上,我们会得到这样的结果。,为了实现我们的目标,我们将注册一个新的JavaTimeModule,用我们的自定义日期格式。,另外,配置属性文件coffee.properties将包含以下内容。,Spring Boot会自动注册任何类型为com.fastxml.jackson.databind.Module的bean。下面是我们的最终结果。,2.Jackson2ObjectMapperBuilderCustomizer,这个功能接口的目的是让我们创建配置。,它们将被应用于通过Jackson2ObjectMapperBuilder创建的默认ObjectMapper。,配置得以特定的顺序应用,我们可以使用@Order annotation来控制。如果我们想从不同的配置或模块来配置ObjectMapper,这种优雅的方法是适合的。,如果我们想完全控制配置,有几个选项可以禁用自动配置,只允许应用我们的自定义配置。,让我们仔细研究一下这些选项。,1.ObjectMapper,覆盖默认配置的最简单方法是定义一个ObjectMapper Bean并将其标记为@Primary。,当我们想完全控制序列化过程而不想允许外部配置时,我们应该使用这种方法。,2.Jackson2ObjectMapperBuilder,另一种干净的方法是定义一个Jackson2ObjectMapperBuilderbean。,实际上,Spring Boot在构建ObjectMapper时默认使用这个构建器,并会自动拾取定义的构建器。,它将默认配置两个选项。,根据Jackson2ObjectMapperBuilder 文档,如果classpath上有一些模块,它也会注册这些模块。,这种方法的优点是,Jackson2ObjectMapperBuilder提供了一种简单而直观的方法来构建ObjectMapper。,3.MappingJackson2HttpMessageConverter的方法,我们可以直接定义一个类型为MappingJackson2HttpMessageConverter的bean,Spring Boot会自动使用它。,为了测试我们的配置,我们将使用TestRestTemplate并将对象序列化为String。,通过这种方式,我们可以验证我们的Coffee对象在序列化时没有null值,并且具有自定义的日期格式。,在这篇文章中,我们看了使用Spring Boot时配置JSON序列化选项的几种方法。,我们看到了两种不同的方法:配置默认选项或重写默认配置。

© 版权声明

相关文章