0

0

Jackson高级序列化:使用Converter扁平化嵌入式第三方对象

聖光之護

聖光之護

发布时间:2025-11-22 14:30:52

|

617人浏览过

|

来源于php中文网

原创

Jackson高级序列化:使用Converter扁平化嵌入式第三方对象

本文将深入探讨如何使用jackson库对来自第三方库的嵌入式对象进行自定义序列化。针对将`localizedtexts`类型对象从其原始的键值对结构转换为一个扁平化的`translation`列表的需求,我们将详细介绍如何通过实现jackson `converter`机制,结合辅助数据结构和注解,实现复杂的json结构转换,从而在不修改第三方库代码的前提下,满足特定的序列化输出格式要求。

需求背景与挑战

在处理领域模型(如Article类)时,我们经常会遇到需要将对象持久化到文档数据库(如MongoDB)的需求,通常是通过将其转换为JSON格式。一个常见的场景是,领域模型中包含来自第三方库的嵌入式对象,例如本例中的LocalizedTexts。LocalizedTexts是一个HashMap类型,用于存储不同语言的文本。Language也是一个第三方库提供的枚举类型。

默认情况下,Jackson会将LocalizedTexts序列化为一个嵌套的JSON对象,例如:

"designation": {
    "de": "designation3DE ...",
    "en": "designation3EN ..."
}

然而,实际需求可能是将所有LocalizedTexts类型的字段扁平化,并统一收集到一个名为translation的JSON数组中,每个数组元素包含原始字段名、翻译文本和对应的语言,例如:

"translation": [
    {
        "designation": "designation3DE ...",
        "language": "german"
    },
    {
        "designation": "designation3EN ...",
        "language": "english"
    }
]

由于LocalizedTexts和Language类来自第三方库,我们无法直接修改其源码以添加Jackson注解。因此,我们需要一种非侵入式的自定义序列化方案。

Jackson自定义序列化策略:Converter vs. JsonSerializer

Jackson提供了多种自定义序列化机制,其中最常见的包括JsonSerializer和Converter。

  • JsonSerializer: 适用于直接控制JSON生成过程的场景。通过继承StdSerializer并实现其serialize()方法,开发者可以利用JsonGenerator API精确地控制JSON输出的每一个细节。当需要对简单对象或特定字段进行细粒度控制时,JsonSerializer非常有效。然而,对于涉及复杂对象图转换和大量结构性变更的场景,编写JsonSerializer可能会导致低级别代码过多,且不易维护。
  • Converter: 更适合于在序列化前将一个对象类型转换为另一个“更易于序列化”的类型。Converter的目的是将基础类型转换为Jackson能够更流畅地序列化的中间类型,或者仅仅是为了改变序列化行为。当原始对象结构复杂,或需要进行大幅度结构转换时,Converter提供了一种更优雅、更易维护的解决方案。它将转换逻辑与实际的JSON生成解耦,使得代码更清晰。

对于本例中将多个嵌入式对象扁平化为一个列表的需求,Converter是更合适的选择,因为它允许我们将Article对象转换为一个全新的中间表示(一个包装类),该表示直接对应目标JSON结构,从而简化了序列化过程。

核心概念:Jackson Converter

要实现自定义的Converter,我们需要继承抽象类com.fasterxml.jackson.databind.util.StdConverter,并实现其convert()方法。该方法接收一个SOURCE类型的实例,并返回一个TARGET类型的实例。

BlackBox AI
BlackBox AI

AI编程助手,智能对话问答助手

下载

我们的策略是:

  1. 定义一个ArticleWrapper类,其结构与我们期望的JSON输出完全一致。
  2. 实现一个ArticleConverter,负责将原始的Article对象转换为ArticleWrapper对象。
  3. 在Article类上使用@JsonSerialize(converter = ArticleConverter.class)注解,指示Jackson在序列化时使用我们的自定义转换器。

步骤一:定义目标数据结构 ArticleWrapper

为了将Article对象序列化为目标JSON格式,我们首先需要定义一个与目标JSON结构相匹配的Java类。我们将此称为ArticleWrapper。这个包装类将包含Article中的所有非LocalizedTexts字段,并引入一个新的translation字段来承载扁平化的翻译数据。

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Builder;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.Singular;

import java.util.List;
import java.util.UUID;

@Builder
@Getter
@Setter
public class ArticleWrapper {
    @NonNull
    private UUID id;
    @JsonProperty("iNo")
    private Integer iNo;
    private boolean isValid;
    @NonNull
    private ReferenceArticleGroup articleGroup; // 假设 ReferenceArticleGroup 已定义
    private Integer numberOfDecimalsSalesPrice;
    @Singular
    private List codes;

    // 所有的 LocalizedTexts 数据将被扁平化存储在此列表中
    private List translation;
}

步骤二:构建扁平化翻译条目 LanguageAttribute

ArticleWrapper中的translation列表的每个元素都需要表示一个特定的翻译条目,例如 {"productInformation": "...", "language": "english"}。为此,我们定义一个辅助类LanguageAttribute。为了简洁和不可变性,这里使用Java 16的record类型。如果项目不使用Java 16或更高版本,可以将其实现为一个普通的POJO类。

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.util.Map;

// 假设 Language 是一个来自第三方库的枚举类型,例如:
// public enum Language { AA("aa"), AB("ab"), ...; public String getLangName() { ... } }
public record LanguageAttribute(
    @JsonAnyGetter // 将Map的内容直接扁平化到父对象中,而不是作为一个嵌套的"map"字段
    Map map,
    @JsonProperty("language")
    @JsonSerialize(converter = LanguageConverter.class) // 对 Language 枚举进行自定义序列化
    Language language) {}

@JsonAnyGetter 注解说明:此注解用于将map字段的键值对直接作为当前对象的属性输出到JSON中,而不是将map本身作为一个嵌套对象。例如,如果map包含{"productInformation": "..."},则JSON输出将直接是"productInformation": "...",而不是"map": {"productInformation": "..."}。这正是我们实现扁平化结构的关键。

@JsonUnwrapped 的局限性:虽然@JsonUnwrapped也可以用于类似目的,但在某些复杂场景下(如与@JsonAnyGetter或其他复杂结构结合时),它存在已知的Jackson issue #171,可能无法按预期工作。因此,@JsonAnyGetter在这里是更稳健的选择。

步骤三:自定义语言枚举序列化 LanguageConverter

LanguageAttribute中的language字段是一个Language枚举类型。为了将其序列化为小写字符串形式(例如"german"而非"GERMAN"),我们需要一个简单的Converter。

import com.fasterxml.jackson.databind.util.StdConverter;

// 假设 Language 枚举有一个 getLangName() 方法返回其小写名称,例如:
// public enum Language {
//     DE("german"), EN("english"), ES("spanish");
//     private final

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

832

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

738

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

734

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.5万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

Java 教程
Java 教程

共578课时 | 46.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号