Java Spring Boot 响应没有将整个响应转换为 JSON

Question

我遇到一个问题，我的 Spring Boot 响应实体大部分被转换为 JSON，但正文仍保留为字符串。

我已经阅读了该站点上的许多其他问题，但它们似乎都指向同一件事。

pom.xml 依赖项

    <dependencies>
        <!--OpenAPI Generator Dependencies-->
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.0.2</version>
        </dependency>
        <!--Http Dependencies-->
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
        </dependency>
        <!--Log4j Dependencies-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <!--Spring Framework Dependencies-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!--Dotenv Dependencies-->
        <dependency>
            <groupId>io.github.cdimascio</groupId>
            <artifactId>java-dotenv</artifactId>
            <version>${dotenv.version}</version>
        </dependency>

        <!--JSON Object Dependencies-->
        <dependency>
            <groupId>org.json</groupId>
            <artifactId>json</artifactId>
            <version>20220924</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.14.1</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.14.1</version>
        </dependency>

    </dependencies>

ApiResponse 类

public class ApiResponse {
    // class used to model api response data
    public Integer statusCode;
    public String statusReason;
    public String statusLine;
    public String url;
    public String body;
    public ProtocolVersion protocolVersion;

    public String getStatusLine() {
        return statusLine;
    }

    public void setStatusLine(String statusLine) {
        this.statusLine = statusLine;
    }

    public ProtocolVersion getProtocolVersion() {
        return protocolVersion;
    }

    public String getStatusReason() {
        return statusReason;
    }

    public void setStatusReason(String statusReason) {
        this.statusReason = statusReason;
    }

    public void setProtocolVersion(ProtocolVersion protocolVersion) {
        this.protocolVersion = protocolVersion;
    }

    public Integer getStatusCode() {
        return statusCode;
    }

    public void setStatusCode(Integer statusCode) {
        this.statusCode = statusCode;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getBody() {
        return body;
    }

    public void setBody(String body) {
        this.body = body;
    }

}

过程响应方法

    public ApiResponse processResponse(CloseableHttpResponse response) throws IOException {
        // process custom apache httpClient response
        ApiResponse apiResponse = new ApiResponse();
        apiResponse.setProtocolVersion(response.getProtocolVersion());
        apiResponse.setStatusCode(response.getStatusLine().getStatusCode());
        apiResponse.setStatusReason(response.getStatusLine().getReasonPhrase());
        apiResponse.setStatusLine(response.getStatusLine().toString());

        HttpEntity entity = response.getEntity();
        if (entity != null) {
            // return it as a String
            String result = EntityUtils.toString(entity);
            apiResponse.setBody(result);
        }
        response.close();
        return apiResponse;
    }

getCall 方法

    @GetMapping(value = "/getHealth", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<ApiResponse> getClientHealth() throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException {

        Client clientSetup = new Client(dotEnv.get("URL"), 80);

        try {
            ApiResponse response = clientSetup.getHealth();

            return new ResponseEntity<>(response, HttpStatusCode.valueOf(response.getStatusCode()));
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

响应

{
  "statusCode": 200,
  "statusReason": "OK",
  "statusLine": "HTTP/1.1 200 OK",
  "url": null,
  "body": "{\"status\":\"Healthy!\"}",
  "protocolVersion": {
    "protocol": "HTTP",
    "major": 1,
    "minor": 1
  }
}

问题出在"body": "{\"status\":\"Healthy!\"}"

当通过我的 Spring Boot ResponseEntity 返回时，我未能成功将正文从字符串转换为 JSON。

Answer 1

通过 ApiResponse 的定义，您得到的正是您所要求的。

public String body;

如果您希望 Jackson 将其序列化为对象的一部分。它需要被定义为对象的一部分。 这可能就像将其更改为 JsonNode 一样简单。

public JsonNode body;

并从实体生成 JsonNode。

if (entity != null) {
  // return it as a JsonNode
  String stringResponse = EntityUtils.toString(entity);
  ObjectMapper mapper = new ObjectMapper();
  JsonNode jsonNode = mapper.readTree(stringResponse);
  apiResponse.setBody(jsonNode);
}

尽管如果您的 ApiResponse 对象更准确地模拟它所持有的内容可能会更好。

Answer 2

正如其他人所说，通过将 ApiResponse.body 的类型声明为字符串，这正是存储在那里的内容； JSON 序列化程序不知道字符串的内容，因此它只是将其序列化（需要转义以使其成为有效的字符串值）。

我可以想到 2 个选项来使它成为一个更有用的可以序列化的对象：A）将从下游 API 获得的响应 HttpEntity 转换为仅包含您关心的属性的简单 DTO；或 B) 直接使用 HttpEntity<> 并指示序列化程序忽略您不关心的属性（例如您报告的异常中的 EofSensorInputStream）。

选项 A 似乎很明显，所以我不会显示它的代码。以下是完成选项 B 的方法：

public class ApiResponse {
    // ... other fields ...
    private HttpEntity<?> body;

    // ... other methods ...

    @JsonIncludeProperties({"body", "headers"})
    public HttpEntity<?> getBody() {
        return body;
    }

这指示序列化程序在序列化 ApiResponse 的 body 时仅包含 body 和 headers，而忽略 HttpEntity 中的任何其他内容。