如何使用GSON库通过指定键路径从JSON中获取值？

问题原因 #

Gson的JsonObject.get()方法仅支持传入单个键名，无法直接解析带点分隔符（.）或数组下标（[n]）的复合路径字符串，所以直接传入"personalDetails.name"这类路径会找不到对应键，返回null。

解决方案 #

方案1：手动逐层解析（适合简单场景） #

按照JSON结构层级，逐层获取对象或数组，再提取目标值：

JsonElement el = JsonParser.parseString(json);
JsonObject object = el.getAsJsonObject();

// 1. 获取 personalDetails.name
JsonObject personalDetails = object.getAsJsonObject("personalDetails");
String userName = personalDetails.get("name").getAsString();

// 2. 获取 products[1].productName 和 products[1].productPrice
JsonArray products = object.getAsJsonArray("products");
JsonObject targetProduct = products.get(1).getAsJsonObject();
String productName = targetProduct.get("productName").getAsString();
String productPrice = targetProduct.get("productPrice").getAsString();

方案2：封装工具类（支持路径字符串解析，适合复用） #

如果需要频繁通过路径取值，可以封装一个工具类自动解析路径，支持对象键（.分隔）和数组下标（[n]格式）：

import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;

public class JsonPathHelper {
    public static JsonElement getValueByPath(JsonObject root, String path) {
        if (root == null || path == null || path.isEmpty()) {
            return null;
        }
        
        JsonElement current = root;
        String[] pathSegments = path.split("\\.");
        
        for (String segment : pathSegments) {
            // 处理数组节点，如 products[1]
            if (segment.contains("[")) {
                String arrayKey = segment.substring(0, segment.indexOf("["));
                int index;
                try {
                    index = Integer.parseInt(segment.substring(segment.indexOf("[") + 1, segment.indexOf("]")));
                } catch (NumberFormatException e) {
                    return null; // 索引格式错误
                }
                
                if (!(current instanceof JsonObject)) {
                    return null;
                }
                JsonArray array = ((JsonObject) current).getAsJsonArray(arrayKey);
                if (array == null || index < 0 || index >= array.size()) {
                    return null; // 数组不存在或索引越界
                }
                current = array.get(index);
            } else {
                // 处理普通对象节点
                if (!(current instanceof JsonObject)) {
                    return null;
                }
                current = ((JsonObject) current).get(segment);
            }
            
            if (current == null) {
                break;
            }
        }
        return current;
    }
}

使用示例：

// 调用工具类获取值
String userName = JsonPathHelper.getValueByPath(object, "personalDetails.name").getAsString();
String productName = JsonPathHelper.getValueByPath(object, "products[1].productName").getAsString();
String productPrice = JsonPathHelper.getValueByPath(object, "products[1].productPrice").getAsString();

注意事项 #

• 路径格式需严格匹配，比如数组下标必须用[n]格式，不能遗漏括号；
• 若路径中某节点不存在或类型不匹配（比如预期是数组实际是对象），工具类会返回null，使用前需做非空判断；
• 数组索引从0开始，注意不要越界。

内容的提问来源于stack exchange，提问作者Ankit Ostwal