如何快速定位和解决JSON解析错误：以Protobuf的JsonFormat.ParseException为例

用户8589624

发布于 2025-11-15 15:03:13

470

文章被收录于专栏：nginxnginx

如何快速定位和解决JSON解析错误：以Protobuf的JsonFormat.ParseException为例

在开发过程中，JSON数据的解析是一个常见的操作，尤其是在微服务架构中，服务之间的通信通常依赖于JSON格式的数据。然而，JSON数据的格式错误往往会导致解析失败，进而引发系统异常。本文将以一个实际的错误案例为例，详细讲解如何快速定位和解决JSON解析错误，帮助开发者提高问题排查的效率。

一、问题背景

在一次日常开发中，我们的系统日志中出现了如下错误信息：

2025-03-03 18:02:29.840 | ERROR | http-nio-8066-exec-1 | cn.ysx.service.openapi.impl.XinDuoAdServiceImpl | 获取渠道广告请求发送失败: 
com.googlecode.protobuf.format.JsonFormat$ParseException: 1:362: Expected string.
	at com.googlecode.protobuf.format.JsonFormat$Tokenizer.parseException(JsonFormat.java:765)
	at com.googlecode.protobuf.format.JsonFormat$Tokenizer.consumeString(JsonFormat.java:715)
	at com.googlecode.protobuf.format.JsonFormat.handlePrimitive(JsonFormat.java:1059)
	...

从错误日志中可以看出，问题出在 JsonFormat.ParseException，具体原因是程序在解析JSON数据时，期望得到一个字符串，但实际数据不符合预期。接下来，我们将详细分析如何定位和解决这个问题。

二、问题分析

1. 错误日志解读

首先，我们需要从错误日志中提取关键信息：

错误类型：com.googlecode.protobuf.format.JsonFormat$ParseException
错误信息：Expected string.
错误位置：第1行的第362个字符处
调用栈：错误发生在 cn.ysx.service.openapi.impl.XinDuoAdServiceImpl.getAdvertising 方法的第279行

通过这些信息，我们可以初步判断问题是由于JSON数据格式不正确导致的。

2. 可能的原因

JSON数据格式错误：某个字段的值应该是字符串，但实际是其他类型（如数字、布尔值等）。
数据源问题：如果JSON数据是从外部接口获取的，可能是接口返回的数据格式不正确。
代码逻辑问题：在生成或解析JSON数据时，代码逻辑可能存在缺陷。

三、问题定位

1. 查看调用栈

从调用栈中可以看到，错误发生在 XinDuoAdServiceImpl.getAdvertising 方法的第279行。我们需要查看该方法的代码，找到解析JSON数据的部分。

假设代码如下：

public void getAdvertising() {
    String jsonData = getJsonDataFromSomewhere(); // 获取JSON数据
    try {
        JsonFormat.merge(jsonData, builder); // 解析JSON数据
    } catch (JsonFormat.ParseException e) {
        logger.error("解析JSON数据失败", e);
        throw new RuntimeException("解析JSON数据失败", e);
    }
}

2. 打印JSON数据

为了进一步分析问题，我们可以在解析之前打印出JSON数据：

public void getAdvertising() {
    String jsonData = getJsonDataFromSomewhere(); // 获取JSON数据
    logger.info("Received JSON data: {}", jsonData); // 打印JSON数据
    try {
        JsonFormat.merge(jsonData, builder); // 解析JSON数据
    } catch (JsonFormat.ParseException e) {
        logger.error("解析JSON数据失败", e);
        throw new RuntimeException("解析JSON数据失败", e);
    }
}

通过日志输出，我们可以查看实际的JSON数据，检查是否有格式问题。

3. 检查数据源

如果JSON数据是从外部接口获取的，我们需要检查该接口的返回数据是否正确。可以使用工具（如Postman或curl）手动请求接口，查看返回的JSON数据。

例如，使用curl命令：

curl -X GET http://example.com/api/getAdData

如果返回的数据格式不正确，可能需要与接口提供方沟通，确保返回的数据格式符合预期。

四、问题解决

1. 修复JSON数据格式

假设我们从日志中看到的JSON数据如下：

{
    "adId": 12345,
    "adName": "Test Ad",
    "adTarget": "http://example.com",
    "adType": 1
}

根据错误提示，程序期望在第1行的第362个字符处得到一个字符串。我们需要检查JSON数据中是否有字段的值类型不正确。

例如，如果 adType 字段的值应该是字符串，但实际是数字，我们可以将其改为字符串：

{
    "adId": 12345,
    "adName": "Test Ad",
    "adTarget": "http://example.com",
    "adType": "1"
}

2. 修改代码逻辑

如果问题是由于代码逻辑导致的，我们需要修改生成或解析JSON数据的逻辑。例如，确保所有字段的值类型符合预期：

public String generateJsonData() {
    JsonObject jsonObject = new JsonObject();
    jsonObject.addProperty("adId", 12345);
    jsonObject.addProperty("adName", "Test Ad");
    jsonObject.addProperty("adTarget", "http://example.com");
    jsonObject.addProperty("adType", "1"); // 确保adType是字符串
    return jsonObject.toString();
}

3. 添加数据校验

为了防止类似问题再次发生，我们可以在解析JSON数据之前添加数据校验逻辑：

public void getAdvertising() {
    String jsonData = getJsonDataFromSomewhere(); // 获取JSON数据
    logger.info("Received JSON data: {}", jsonData); // 打印JSON数据

    // 数据校验
    if (!isValidJson(jsonData)) {
        logger.error("JSON数据格式不正确");
        throw new RuntimeException("JSON数据格式不正确");
    }

    try {
        JsonFormat.merge(jsonData, builder); // 解析JSON数据
    } catch (JsonFormat.ParseException e) {
        logger.error("解析JSON数据失败", e);
        throw new RuntimeException("解析JSON数据失败", e);
    }
}

private boolean isValidJson(String jsonData) {
    try {
        new JsonParser().parse(jsonData);
        return true;
    } catch (JsonSyntaxException e) {
        return false;
    }
}