基于Gson实现Json根据key排序

接到领导指示，现有需求，需要提供一个方法对JSON根据key排序、加密，用于第三方接口调用前进行鉴定。

要求：JSON内所有key都需要排序，如果value值也是JSON 对象、或者JSON数组，也需要根据key排序

引入Gson包

        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.5</version>
        </dependency>

可以看到Gson 中的JsonObject的本质上是一个LinkedTreeMap()，是一个有序的map

 

1. 因此，对于JsonObject 我们只需要拿到key，先对key排序后，然后顺序塞入即可，
部分代码：

 // key 排序
 List<Object> keyList = list.stream().sorted().collect(Collectors.toList());
for (Object key : keyList) {
     String keyStr = key + "";
     JsonElement jsonElement = jsonObject.get(keyStr);
     JsonElement o = sort(jsonElement);
     returnJsonObject.add(keyStr, o);
}

2.  对于JsonArray，我们只需要遍历所有子项，按照上述 1 步骤走一遍即可

3.  采取递归循环的方式，遍历所有的子项，直到子项不是JsonObject或JsonArray类型

完整代码：

 public static String sortJson(JsonElement obj) {
        JsonElement jsonElement = sort(obj);
        return jsonElement.toString();
    }

    private static JsonElement sort(JsonElement obj){
        if(obj instanceof JsonObject){
            JsonObject returnJsonObject = new JsonObject();
            JsonObject jsonObject = (JsonObject)obj;
            Set<String> keySet = jsonObject.keySet();
            List<Object> list = new ArrayList<>(keySet);
            // key 排序
            List<Object> keyList = list.stream().sorted().collect(Collectors.toList());
            for (Object key : keyList) {
                String keyStr = key + "";
                JsonElement jsonElement = jsonObject.get(keyStr);
                JsonElement o = sort(jsonElement);
                returnJsonObject.add(keyStr, o);
            }
            return returnJsonObject;
        }else if(obj instanceof JsonArray){
            JsonArray returnJsonArray = new JsonArray();
            JsonArray jsonArray = (JsonArray) obj;
            for(int i = 0;i<jsonArray.size();i++){
                JsonElement jsonElement = jsonArray.get(i);
                JsonElement o = sort(jsonElement);
                returnJsonArray.add(o);
            }
            return returnJsonArray;
        }
        return obj;
    }

 4. 方法同时支持对JsonObject类型，JsonArray类型进行排序

该工具没有大量的数据测试过，如有问题，请自行更改