在 Java 中使 JSON 漂亮的最佳方法

Question

我有返回如下格式的对象列表（不漂亮）。

{"data":[{"id":1,"firstName":"Bill","lastName":"Johnson"}]

我希望它看起来像这样（漂亮）。

{
    "data":[{
        "id":1,"
        firstName":"Bill",
        "lastName":"Johnson"
        }]
}

这是我的方法签名，以及我对服务的调用以查询数据库以及将 json 打印到屏幕的返回。

public @ResponseBody ResponseEntity<ResponseData<List<NameSearchDTO>>> getInfo(@PathVariable String code, @PathVariable String idType)

ResponseData<List<NameSearchDTO>> response = new ResponseData<>();

List<NameSearchDTO> results = officeService.getByCode(code, idType); 
if (!results.isEmpty()) {
            response.setData(results);
            response.setStatus(Enum.SUCCESS.getDescription());
            response.setMessage(Enum.STATUS_SUCCESS.getDescription());
return new ResponseEntity<>(response, HttpStatus.OK);
}

ResponseData 类实现了可序列化。这是否使它成为“真正的”JSON，因为我没有使用 Jackson 或任何其他 JSON 库？

如何将响应传递给下面的 ObjectMapper 以使其美观？

ObjectMapper jacksonMapper = new ObjectMapper();
jacksonMapper.configure(SerializationFeature.INDENT_OUTPUT, true);

或者我需要创建某种 JSONHelper 类吗？

响应数据类

public class ResponseData <E> implements Serializable{


    private E data;
    private String status;
    private String message;
    private boolean hasValidationError = false;

    public E getData() {
        return data;
    }

    public void setData(E data) {
        this.data = data;
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public boolean getHasValidationError(){
        return hasValidationError;
    }

    public void setHasValidationError(boolean hasValidationError){
        this.hasValidationError = hasValidationError;
    }
}

Answer 1

我认为使用Jackson美化json字符串的最佳方法如下：

import com.fasterxml.jackson.databind.ObjectMapper;
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(yourObject)

Answer 2

你可以定义

• MappingJacksonHttpMessageConverter（不需要 Spring Boot）
• Jackson2ObjectMapperBuilder 豆
• 一个简单的ObjectMapper Bean 注解@Primary
• 一个配置属性（Spring Boot - 最简单的跳到这个）。

---

对于第一个解决方案，您需要实现 WebMvcConfigurer 接口
（如果您使用的是 Spring Boot，请跳过此接口）

@Configuration
class CustomWebMvcConfigurer implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(final List<HttpMessageConverter<?>> converters) {
        final ObjectMapper mapper =
                new Jackson2ObjectMapperBuilder()
                        .indentOutput(true)
                        .build();

        // Or build ObjectMapper without the Spring builder, it's the same thing
        converters.add(new MappingJackson2HttpMessageConverter(mapper));
    }
}

关键是这一行

indentOutput(true)

实际操作底层ObjectMapper 配置

public Jackson2ObjectMapperBuilder indentOutput(boolean indentOutput) {
    this.features.put(SerializationFeature.INDENT_OUTPUT, indentOutput);
    return this;
}

---

第二个比较简单

@Bean
Jackson2ObjectMapperBuilder jackson() {
   return new Jackson2ObjectMapperBuilder().indentOutput(true);
}

---

第三个就更简单了，就

@Bean
@Primary
ObjectMapper objectMapper() {
   final ObjectMapper mapper = new ObjectMapper();
   mapper.enable(SerializationFeature.INDENT_OUTPUT);  
   return mapper;
}

---

第四种方式只包括使用配置属性

spring.jackson.serialization.indent_output=true

Answer 3

您标记了gson，因此您可以使用此库显示 .json 文件：

import org.json.JSONObject

val json = "{\"data\":[{\"id\":1,\"firstName\":\"Bill\",\"lastName\":\"Johnson\"}]\n"

val jsonObject = JSONObject(json)

println(jsonObject.toString(4))

https://github.com/google/gson

Answer 4

我相信您正在寻找 Gson 漂亮的打印功能。 既然您已经用 gson 标记了您的问题，我认为如果您使用该库就可以了。 Mkyong 有一个很棒的漂亮打印教程Here。

教程的基本内容是：

Gson gson = new GsonBuilder().setPrettyPrinting().create();

Answer 5

无需导入一堆新东西。只有系统可能会抱怨什么（如果有的话）。但是，如果您已经在使用 Jackson，并且想使用映射器 -> 只需使用“readValue”或“writeValue”对吗？

这个链接解释了很多方法来做到这一点：Jackson Examples

删除您的结果分配并使用 Mapper 直接转换

ObjectMapper jacksonMapper = new ObjectMapper();
jacksonMapper.configure(SerializationFeature.INDENT_OUTPUT, true);
List<NameSearchDTO> mappedResults = mapper.readValue(officeService.getByCode(code, idType) ,new TypeReference<List<NameSearchDTO>>() {} );

然后将其添加到您的结果返回中。 （添加容器类似乎有点笨拙，但我不会假装知道您的要求）。

if (!mappedResults.isEmpty()) {
            response.setData(mappedResults);
            response.setStatus(Enum.SUCCESS.getDescription());
            response.setMessage(Enum.STATUS_SUCCESS.getDescription());
return new ResponseEntity<>(response, HttpStatus.OK);

Answer 6

您可以使用 JSONObject 中的 toString(int indentFactor)