Json 格式化工具类 支持Jackson、FastJson、Gson

Json 格式化工具类

1、使用Jackson的DefaultPrettyPrinter来格式化json

 /**
     * 将对象按以格式化json的方式写出
     * 使用的json为Jackson
     *
     * @param obj obj
     */
    public static String formatJson(Object obj) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        // 配置四个空格的缩进
        DefaultPrettyPrinter.Indenter indenter = new DefaultIndenter("    ", DefaultIndenter.SYS_LF);
        DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
        printer.indentObjectsWith(indenter); // Indent JSON objects
        printer.indentArraysWith(indenter);  // Indent JSON arrays

        return mapper.writer(printer).writeValueAsString(obj);
    }

2、使用Jackson的ObjectMapper的writerWithDefaultPrettyPrinter()来格式化json

/**
     * 输出格式化的json字符串
     * 使用的json为Jackson
     *
     * @param obj 任意对象
     * @return 格式化的json字符串
     * @throws JsonProcessingException jsonProcessingException
     */
    public static String formatJson2(Object obj) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
    }

3、使用FastJson来格式化json

 /**
     * 输出格式化的json字符串
     * 使用的json为FastJson
     * <p>
     * 加上SerializerFeature.DisableCircularReferenceDetect关闭循环引用
     * 解决：
     * [
     * {
     * "playVideo":"观看视频",
     * "aboutVersion":"版本详情"
     * },
     * {"$ref":"$[0]"},
     * {"$ref":"$[0]"},
     * {"$ref":"$[0]"}
     * ]
     *
     * @param obj obj
     * @return 格式化的json字符串
     */
    public static String formatJson3(Object obj) {
        // 输出格式化后的字符串
        String pretty = JSON.toJSONString(obj, SerializerFeature.PrettyFormat,
                SerializerFeature.WriteDateUseDateFormat, SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullListAsEmpty, 
                SerializerFeature.DisableCircularReferenceDetect);

        return pretty;
    }

4、使用Gson来格式化json

 /**
     * 输出格式化的json字符串
     * 使用的json为Gson
     *
     * @param obj obj
     * @return 格式化的json字符串
     */
    public static String formatJson4(Object obj) {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        return gson.toJson(obj);
    }

5、完整代码

package cn.lyf.utils;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.util.DefaultIndenter;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import lombok.extern.slf4j.Slf4j;

/**
 * @author lyf
 * @description:
 * @version: v1.0
 * @since 2022-05-06 21:12
 */
@Slf4j
public final class JsonUtil {
    private JsonUtil() {
    }
    
    /**
     * 将对象按以格式化json的方式写出
     * 使用的json为Jackson
     *
     * @param obj obj
     */
    public static String formatJson(Object obj) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        // 配置四个空格的缩进
        DefaultPrettyPrinter.Indenter indenter = new DefaultIndenter("    ", DefaultIndenter.SYS_LF);
        DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
        printer.indentObjectsWith(indenter); // Indent JSON objects
        printer.indentArraysWith(indenter);  // Indent JSON arrays

        return mapper.writer(printer).writeValueAsString(obj);
    }


    /**
     * 输出格式化的json字符串
     * 使用的json为Jackson
     *
     * @param obj 任意对象
     * @return 格式化的json字符串
     * @throws JsonProcessingException jsonProcessingException
     */
    public static String formatJson2(Object obj) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
    }

    /**
     * 输出格式化的json字符串
     * 使用的json为FastJson
     * <p>
     * 加上SerializerFeature.DisableCircularReferenceDetect关闭循环引用
     * 解决：
     * [
     * {
     * "playVideo":"观看视频",
     * "aboutVersion":"版本详情"
     * },
     * {"$ref":"$[0]"},
     * {"$ref":"$[0]"},
     * {"$ref":"$[0]"}
     * ]
     *
     * @param obj obj
     * @return 格式化的json字符串
     */
    public static String formatJson3(Object obj) {
        // 输出格式化后的字符串
        String pretty = JSON.toJSONString(obj, SerializerFeature.PrettyFormat,
                SerializerFeature.WriteDateUseDateFormat, SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullListAsEmpty, 
                SerializerFeature.DisableCircularReferenceDetect);

        return pretty;
    }

    /**
     * 输出格式化的json字符串
     * 使用的json为Gson
     *
     * @param obj obj
     * @return 格式化的json字符串
     */
    public static String formatJson4(Object obj) {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        return gson.toJson(obj);
    }
}