Gson的五大注解 @SerializedName、@Expose、@Since、@Until、@JsonAdapter
1. @SerializedName
序列化为json的时候，将提供的名称的值作为字段名。
//测试代码
class MyClass {
@SerializedName("nameA")
String a;
//alternate 备用解析名称
@SerializedName(value = "nameB", alternate = {"nameC", "nameD"})
String b;
String c;
public MyClass(String a, String b, String c) {
this.a = a;
this.b = b;
this.c = c;
}
@Override
public String toString() {
return "MyClass{" +
"a='" + a + '\'' +
", b='" + b + '\'' +
", c='" + c + '\'' +
'}';
}
}
（1）序列化
//序列化
public static void testSerializable() {
Gson gson = new Gson();
MyClass myClass = new MyClass("a", "b", "c");
String s = gson.toJson(myClass);
System.out.println("MyClass:" + s);
}
//输出
MyClass:{"nameA":"a","nameB":"b","c":"c"}
（1）反序列化
//反序列化
public static void testDeSerializable() {
Gson gson = new Gson();
String json = "{\"nameA\":\"a\",\"nameD\":\"b\",\"c\":\"c\"}";
MyClass myClass = gson.fromJson(json, MyClass.class);
System.out.println(myClass);
}
//输出 ，全部赋值成功
MyClass{a='a', b='b', c='c'}
细心地同学发现，反序列化的时候，字段''nameD''是在 alternate = {"nameC", "nameD"}定义的，alternate英文释义为“备用的”，也就是说，序列化的时候，字段一定是序列化为value的值，但是反序列化时，不论json中字段是value 还是alternate 中的值都会被匹配上，此地，将nameD换位nameB和nameC也同样会被序列化成功。
2. @Expose
序列化和反序列化时，根据serialize（序列化）和deserialize（反序列化）的值true或者false来确定是否要序列化和反序列化，默认都是true。
此时构建Gson的时候不要使用Gson gson = new Gson();，这样构建Gson对象会将该注销无效化，也就是说加不加该注解都一样，相当于没有加该注解。
class User0 {
//默认true,正常序列化和反序列化
@Expose
String name1;
//可以序列化，不可以反序列化
@Expose(serialize = true, deserialize = false)
String name2;
//可以反序列化，不可以序列化
@Expose(serialize = false, deserialize = true)
String name3;
@Expose(serialize = false, deserialize = false)
String name4;
@Expose(serialize = true, deserialize = true)
String name5;
//不带有Expose注解，相当于不可以正反序列化
String name6;
public User0(String name1, String name2, String name3, String name4, String name5, String name6) {
this.name1 = name1;
this.name2 = name2;
this.name3 = name3;
this.name4 = name4;
this.name5 = name5;
this.name6 = name6;
}
@Override
public String toString() {
return "User0{" +
"name1='" + name1 + '\'' +
", name2='" + name2 + '\'' +
", name3='" + name3 + '\'' +
", name4='" + name4 + '\'' +
", name5='" + name5 + '\'' +
", name6='" + name6 + '\'' +
'}';
}
}
（1）序列化
//序列化
public static void testSerializable() {
User0 user0 = new User0("1", "2", "3", "4", "5", "6");
// Gson gson = new Gson();//此时不要用该种方式
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
String s = gson.toJson(user0);
System.out.println("User0:" + s);
}
输出
User0:{"name1":"1","name2":"2","name5":"5"}
name1、name2、name5的serialize=true，所以可被序列化。
（2）反序列化
public static void testDeSerializable() {
String s = "{\"name1\":\"1\",\"name2\":\"2\",\"name3\":\"3\",\"name4\":\"4\",\"name5\":\"5\"}";
// Gson gson = new Gson();
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
User0 user0 = gson.fromJson(s, User0.class);
System.out.println(user0);
}
输出
User0{name1='1', name2='null', name3='3', name4='null', name5='5', name6='null'}
name2、name4、 name6他们的deserialize=false ,不可以反序列化。如果使用GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();构建Gson对象，不加@Expose，意味着该字段不能正反序列化。
3.@Since 和 @Until
@Since 代表从某个版本启用
@Until 代表从某个版本弃用
需要结合 new GsonBuilder().setVersion(3.0).create() 使用，不要使用 new Gson();
class User1 {
//不加不影响
String name1;
//版本从1.0开始启用
@Since(1.0)
String name2;
//从2.0开始启用
@Since(2.0)
String name3;
//到3.0开始弃用
@Until(3.0)
String name4;
//到4.0开始弃用
@Until(4.0)
String name5;
public User1(String name1, String name2, String name3, String name4, String name5) {
this.name1 = name1;
this.name2 = name2;
this.name3 = name3;
this.name4 = name4;
this.name5 = name5;
}
@Override
public String toString() {
return "User1{" +
"name1='" + name1 + '\'' +
", name2='" + name2 + '\'' +
", name3='" + name3 + '\'' +
", name4='" + name4 + '\'' +
", name5='" + name5 + '\'' +
'}';
}
}
（1）序列化
//序列化
public static void testSerializable() {
User1 user1 = new User1("1", "2", "3", "4", "5");
// Gson gson = new Gson();
Gson gson = new GsonBuilder().setVersion(1.0).create();
String s = gson.toJson(user1);
System.out.println("User1:" + s);
}
输出
User1:{"name1":"1","name2":"2","name4":"4","name5":"5"}
name3要到版本2.0才启用，其他情况可以自行测试。
（2）反序列化
public static void testDeSerializable() {
String json = "{\"name1\":\"1\",\"name2\":\"2\",\"name3\":\"3\",\"name4\":\"4\",\"name5\":\"5\"}";
// Gson gson = new Gson();
Gson gson = new GsonBuilder().setVersion(3.0).create();
User1 user1 = gson.fromJson(json, User1.class);
System.out.println(user1);
}
输出
User1{name1='1', name2='2', name3='3', name4='null', name5='5'}
版本3.0后，name4被弃用了。
4.@JsonAdapter
@JsonAdapter 是在 Gson 2.7 及以后版本才有。
@JsonAdapter(UserJsonAdapter.class)
class User2 {
String name1;
String name2;
public User2(String name1, String name2) {
this.name1 = name1;
this.name2 = name2;
}
@Override
public String toString() {
return "User2{" +
"name1='" + name1 + '\'' +
", name2='" + name2 + '\'' +
'}';
}
}
class UserJsonAdapter extends TypeAdapter<User2> {
//javabean 转成 json
@Override
public void write(JsonWriter out, User2 value) throws IOException {
if (value == null) {
out.nullValue();
return;
}
out.beginObject();
out.name("name1").value(value.name1);
out.name("name2").value(value.name2);
out.endObject();
}
//json 转为 javabean
@Override
public User2 read(JsonReader in) throws IOException {
if (in.peek() == JsonToken.NULL) {
in.nextNull();
return null;
}
in.beginObject();
in.nextName();
String name1Value = in.nextString();
in.nextName();
String name2Value = in.nextString();
in.endObject();
return new User2(name1Value, name2Value);
}
}
序列化
//序列化
public static void testSerializable() {
User2 user2 = new User2("1", "2");
Gson gson = new Gson();
String s = gson.toJson(user2);
System.out.println("User2:" + s);
}
反序列化
public static void testDeSerializable() {
String s = "{\"name1\":\"1\",\"name2\":\"2\"}";
Gson gson = new Gson();
User2 user2 = gson.fromJson(s, User2.class);
System.out.println(user2);
}
@JsonAdapter不仅可以加在类上，也可以加在字段上，字段多的话，就太麻烦了，具体用法也可以参考 TypeAdapter.java、JsonReader.java、JsonWriter.java等源码最上面的注释。
不想在类上加注解，也可以使用registerTypeAdapter注册，如下
Gson gson = new GsonBuilder().registerTypeAdapter(User2.class, new TypeAdapter<User2>() {
//javabean 转成 json
@Override
public void write(JsonWriter out, User2 value) throws IOException {
if (value == null) {
out.nullValue();
return;
}
out.beginObject();
out.name("name1").value(value.name1);
out.name("name2").value(value.name2);
out.endObject();
}
//json 转为 javabean
@Override
public User2 read(JsonReader in) throws IOException {
if (in.peek() == JsonToken.NULL) {
in.nextNull();
return null;
}
in.beginObject();
in.nextName();
String name1Value = in.nextString();
in.nextName();
String name2Value = in.nextString();
in.endObject();
return new User2(name1Value, name2Value);
}
}.nullSafe()).create();
完！
网友评论