0

0

Jackson ObjectMapper JSON美化输出深度定制指南

心靈之曲

心靈之曲

发布时间:2025-11-27 12:07:02

|

744人浏览过

|

来源于php中文网

原创

Jackson ObjectMapper JSON美化输出深度定制指南

本教程详细介绍了如何使用jackson objectmapper实现json美化输出的精细控制。当默认的 serializationfeature.indent_output 不足以满足特定格式要求时,可以通过定制 defaultprettyprinter 并结合 defaultindenter 来精确控制对象和数组的缩进与换行,从而生成符合预期的、结构清晰的json格式化输出

1. 理解Jackson的JSON美化输出

Jackson库的ObjectMapper是Java中进行JSON序列化和反序列化的核心工具。为了提高JSON的可读性,ObjectMapper提供了美化(Pretty Print)输出的功能。最常见的方式是启用SerializationFeature.INDENT_OUTPUT特性:

objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true);

启用此特性后,ObjectMapper会使用默认的DefaultPrettyPrinter来格式化JSON输出,包括添加缩进和换行。然而,默认的美化器可能无法满足所有精细的格式化需求,例如特定位置的换行符、空数组内部的空格或键值对之间冒号的空格等。当默认行为不符预期时,我们就需要更深入地定制美化器。

2. 定制DefaultPrettyPrinter以实现精细控制

DefaultPrettyPrinter是Jackson用于美化JSON输出的默认实现。它提供了丰富的API来定制缩进和换行行为。要实现更精确的控制,我们需要创建并配置一个DefaultPrettyPrinter实例。

核心的定制方法是indentObjectsWith()和indentArraysWith(),它们分别用于设置对象和数组内部元素的缩进规则。这两个方法都接受一个Indenter接口的实现。Jackson提供了一个开箱即用的实现:DefaultIndenter。

DefaultIndenter允许我们定义缩进使用的字符串(例如两个空格、四个空格或一个制表符)以及换行符。通过将其应用于对象和数组,我们可以确保它们内部的元素按照一致且可控的方式进行缩进和换行。

以下是如何创建并配置一个DefaultPrettyPrinter的示例:

import com.fasterxml.jackson.core.util.DefaultIndenter;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

// ...

// 1. 创建DefaultPrettyPrinter实例
DefaultPrettyPrinter printer = new DefaultPrettyPrinter();

// 2. 配置对象内部的缩进器
// DefaultIndenter() 默认使用四个空格作为缩进,并使用系统默认的换行符。
// 这里我们使用两个空格作为缩进字符串。
printer.indentObjectsWith(new DefaultIndenter("  ", DefaultIndenter.SYS_LF));

// 3. 配置数组内部的缩进器
// 同样使用DefaultIndenter() 来确保数组元素有正确的缩进和换行。
printer.indentArraysWith(new DefaultIndenter("  ", DefaultIndenter.SYS_LF));

通过上述配置,我们确保了JSON对象和数组的开始和结束括号后,以及其内部元素之间,都会有正确的换行和缩进。

Google AI Studio
Google AI Studio

Google 推出的基于浏览器的集成开发环境

下载

3. 将定制的美化器集成到ObjectMapper

配置好DefaultPrettyPrinter后,需要告知ObjectMapper使用这个定制的美化器进行序列化。这可以通过setDefaultPrettyPrinter()方法实现:

ObjectMapper mapper = new ObjectMapper();
// 启用缩进输出特性,虽然通过writerWithDefaultPrettyPrinter()会覆盖此设置,但通常建议一同启用。
mapper.enable(SerializationFeature.INDENT_OUTPUT); 
mapper.setDefaultPrettyPrinter(printer); // 设置我们定制的PrettyPrinter

重要提示: setDefaultPrettyPrinter()方法设置的是ObjectMapper在启用SerializationFeature.INDENT_OUTPUT特性时将使用的默认美化器。

4. 执行JSON序列化

最后一步是使用配置好的ObjectMapper进行序列化。为了确保使用我们定制的美化器,最推荐的方式是通过writerWithDefaultPrettyPrinter()方法获取一个ObjectWriter实例,然后进行写入操作。

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

// 假设 ActionOutput 是一个简单的POJO类,包含构造函数和Getter方法
// public class ActionOutput {
//     private String key1;
//     private List key2;
//     private String key3;
//     // 构造函数、Getter/Setter
// }

// 准备待序列化的数据
List res = new ArrayList<>();
res.add(new ActionOutput("value1", List.of(), null));
res.add(new ActionOutput("value2", List.of("item1", "item2"), "another value"));

try {
    // 使用定制的美化器进行写入到文件
    // args[1] 假设是输出文件路径
    // mapper.writerWithDefaultPrettyPrinter() 会使用通过 setDefaultPrettyPrinter 设置的美化器
    mapper
        .writerWithDefaultPrettyPrinter() 
        .writeValue(new File(args[1]), res); 

    // 也可以写入到字符串并打印
    String jsonString = mapper
        .writerWithDefaultPrettyPrinter()
        .writeValueAsString(res);
    System.out.println(jsonString);

} catch (IOException e) {
    e.printStackTrace();
}

5. 完整示例与输出

为了更好地演示上述步骤,我们来看一个完整的示例。

首先,定义一个简单的Java POJO类:

// ActionOutput.java
import java.util.List;
import java.util.Objects; // 用于生成equals和hashCode,非序列化必需

public class ActionOutput {
    private String key1;
    private List key2;
    private String key3;

    // 全参构造函数,Jackson序列化时需要
    public ActionOutput(String key1, List key2, String key3) {
        this.key1 = key1;
        this.key2 = key2;
        this.key3 = key3;
    }

    // 无参构造函数,Jackson反序列化时可能需要
    public ActionOutput() {
    }

    // Getters (Jackson需要用于序列化)
    public String getKey1() { return key1; }
    public List getKey2() { return key2; }
    public String getKey3() { return key3; }

    // Setters (如果需要反序列化)
    public void setKey1(String key1) { this.key1 = key1; }
    public void setKey2(List key2) { this.key2 = key2; }
    public void setKey3(String key3) { this.key3 = key3; }

    @Override
    public String toString() {
        return "ActionOutput{" +
               "key1='" + key1 + '\'' +
               ", key2=" + key2 +
               ", key3='" + key3 + '\'' +
               '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        ActionOutput that = (ActionOutput) o;
        return Objects.equals(key1, that.key1) &&
               Objects.equals(key2, that.key2) &&
               Objects.equals(key3, that.key3);
    }

    @Override
    public int hashCode() {
        return Objects.hash(key1, key2, key3);
    }
}

接下来是序列化代码:

import com.fasterxml.jackson.core.util.DefaultIndenter;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

import java.io.

相关专题

更多
java
java

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

831

2023.06.15

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

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

737

2023.07.05

java自学难吗
java自学难吗

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

733

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中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

Java 项目构建与依赖管理(Maven / Gradle)
Java 项目构建与依赖管理(Maven / Gradle)

本专题系统讲解 Java 项目构建与依赖管理的完整体系,重点覆盖 Maven 与 Gradle 的核心概念、项目生命周期、依赖冲突解决、多模块项目管理、构建加速与版本发布规范。通过真实项目结构示例,帮助学习者掌握 从零搭建、维护到发布 Java 工程的标准化流程,提升在实际团队开发中的工程能力与协作效率。

10

2026.01.12

热门下载

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

精品课程

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

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.5万人学习

Java 教程
Java 教程

共578课时 | 45.1万人学习

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

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