Gson的使用进阶之注解

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();

完！

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 199,271评论 5赞 466
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 83,725评论 2赞 376
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 146,252评论 0赞 328
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 53,634评论 1赞 270
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,549评论 5赞 359
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 47,985评论 1赞 275
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,471评论 3赞 390
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,128评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,257评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1赞 328
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,940评论 3赞 316
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,528评论 3赞 302
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2赞 344
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2赞 339