Posted 2020-12-19Updated 2020-12-19

Gson增量解析

增量解析是我自己杜撰的一个名词，主要是有这样的场景，移动端请求服务端json数据的时候，考虑到流量资源的珍贵，如果本地已经请求过完整下信息，一般是将一个model更新的字段下发，而不是每次都下发完整的model。举个例子，我们向服务器请求user的信息，完整的数据格式可能是：

{“age”:20,”id”:1,”name”:”张三”,”sex”:”男”}

User中的id、name、sex可能是一直不变的，而age是有可能发生变化的，当客户端刷新user的信息时，服务端只下发age的信息就行了，以达到节省流量的目的，下发的数据格式可能是：

{“age”:25,”id”:1}

只有age发生变化，所以只下发了age的信息，id作为识别字段。我们用Gson解析的时候一般是直接调用fromJson函数，这个函数接受两个参数，一个是json字符串，一个是解析的model类。对于这种只有部分数据的json我们如何解析呢，难道重新定义一个SubUser类，处理这种解析然后赋值给User吗，这样做的代价是非常不灵活，更新的字段必须客户端写死，如果下次name或者sex也发生了变化呢，是不是SubUser类就需要修改然后发版？

能不能有个类似于fromJson的函数，他的第二个参数不再是一个类，而是一个实例，新的json数据只会更新这个实例的某些字段。Gson在解析的时候会调用model的默认构造函数new出一个实例，能不能不让它new而是直接在原有的实例基础上进行解析呢？查看Gson的官方文档，看到可以给Gson注册一个InstanceCreator，它是一个接口，顾名思义它是提供用户一个初始化model的函数：

public interface InstanceCreator<T> {
  
  public T createInstance(Type type);
}

这样我们就可以把原来的user作为初始化的实例，实现增量更新的解析。这是对于object的解析，可以这么做。如果是list呢，如何进行增量解析呢，总不能把原来的list作为返回值吧，目前我还没有很好的思路，只是将列表拆分成object分别进行解析。

下面简单的写一个demo：

User类：

public class User{

    public long id;

    public String name;

    public String sex;

    public int age;

    public long getId() {
        return id;
    }
}

GsonCreatorHelper类：

public class GsonCreatorHelper {

    public static User fromJson(String json, final User old) {
        try {
            JSONObject object = new JSONObject(json);
            long id = object.getLong("id");
            if (id == old.getId()) {
                Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new InstanceCreator<User>() {
                    @Override
                    public User createInstance(Type type) {
                        return old;
                    }
                }).create();
                return gson.fromJson(json, User.class);
            }
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return new Gson().fromJson(json, User.class);
    }

    public static List<User> fromJson(String json, final List<User> old) {
        try {
            List<User> result = new ArrayList<>();
            JSONArray array = new JSONArray(json);
            for (int i = 0; i < array.length(); i++) {
                JSONObject object = array.getJSONObject(i);
                final long id = object.getLong("id");
                Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new InstanceCreator<User>() {
                    @Override
                    public User createInstance(Type type) {
                        return getUserById(old, id);
                    }
                }).create();
                result.add(gson.fromJson(object.toString(), User.class));
            }
            return result;
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return new Gson().fromJson(json, new TypeToken<List<User>>() {
        }.getType());
    }

    private static User getUserById(List<User> users, long id) {
        for (User user : users) {
            if (user.getId() == id) {
                return user;
            }
        }
        return new User();
    }
}

MainActivity测试类：

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        String json1 = "{\"age\":20,\"id\":1,\"name\":\"张三\",\"sex\":\"男\"}";
        String json2 = "{\"age\":23,\"id\":1}";
        String json3 = "[{\"age\":20,\"id\":1,\"name\":\"张三\",\"sex\":\"男\"},{\"age\":23,\"id\":2,\"name\":\"李四\",\"sex\":\"男\"}]";
        String json4 = "[{\"age\":23,\"id\":1},{\"age\":33,\"id\":2}]";

        User user1 = new Gson().fromJson(json1, User.class);
        Log.e("user1", new Gson().toJson(user1));

        User user2 = GsonCreatorHelper.fromJson(json2, user1);
        Log.e("user2", new Gson().toJson(user2));

        List<User> user3 = new Gson().fromJson(json3, new TypeToken<ArrayList<User>>() {}.getType());
        Log.e("user3", new Gson().toJson(user3));

        List<User> user4 = GsonCreatorHelper.fromJson(json4, user3);
        Log.e("user4", new Gson().toJson(user4));
    }

10-08 18:18:41.419 28438-28438/com.panda.gsoninstancecreatortest E/user1: {"age":20,"id":1,"name":"张三","sex":"男"}
10-08 18:18:41.425 28438-28438/com.panda.gsoninstancecreatortest E/user2: {"age":23,"id":1,"name":"张三","sex":"男"}
10-08 18:18:41.436 28438-28438/com.panda.gsoninstancecreatortest E/user3: [{"age":20,"id":1,"name":"张三","sex":"男"},{"age":23,"id":2,"name":"李四","sex":"男"}]
10-08 18:18:41.441 28438-28438/com.panda.gsoninstancecreatortest E/user4: [{"age":23,"id":1,"name":"张三","sex":"男"},{"age":33,"id":2,"name":"李四","sex":"男"}]

从结果中我们可以看到user2和user4都是在user1和user3的基础上继续解析了新的json数据。大功告成！

#Android