关于 Gson 的序列化与反序列化分别进行重命名

很多情况下，Json的序列化与反序列化，需要分别对应不同的字段名称，比如说：

序列化的时候要求：{user_name:"xxx"}  而反序列化的时候需要 {userName:"xxx"}

那么Gson该如何实现？

 

@SerializedName注解（只能放在属性级别，不能放到getter /setter）

该注解有两个属性，一个value、一个alternate（备用的意思）。

value的作用是：作为序列化与反序列化的默认匹配的名称；

alternate的作用是：作为反序列化的备用名称，只在反序列化中作为附选项；

 

如果只设置了 value 也就是默认的 @SerializedName("name") ，那么Gson在序列化与反序列化只会去匹配命名为name的字段。

如果设置@SerializedName(value="name",alternate={"name2","name3"}) ，那么Gson在反序列化上只要json字符串有 name、name2、name3 这三个字段出现都会匹配到，但是序列化的话，只能是为name。

 

所以，我们可以知道，我们如果想要将Json的序列化与反序列化，分别对应不同的名称，那么只需要设置@SerializedName(value="序列化、反序列化默认名称",alternate={"反序列化名称备选"})

举个例子：

Java类：

class User{

    private String userName;

}

 

 

我们想将Java 的User 类序列化成 { "userName":"张三"}，又要将 { "name":"张三"} 序列化成 User类。

那么我们只需要在userName属性上设置：

class User{

    @SerializedName(value="userName",alternate={"name"})

    private String userName;

}

 

参考资料：

https://futurestud.io/tutorials/gson-model-annotations-multiple-deserialization-names-with-serializedname