美文网首页
Gson基本用法

Gson基本用法

作者: crMiao | 来源:发表于2019-05-11 16:19 被阅读0次

    Gson是谷歌官方推出的 JSON 包。

    一. 导入Android Studio工程

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

    二. 序列化

    使用Gson将它序列化时,都使用同一个方法,直接返回String

    Gson gson = new Gson();
    String userJson = gson.toJson(object);
    

    三. 反序列化

    1. 简单的 Java Object

    Object object = gson.fromJson(objectJson, Object.class);
    

    适用于独立对象,不管内部是Object还是下面提到的Collection

    2. Array

    String name = "['xiaoming','xiaochen','xiaowang']";
    

    例如,需要讲上面的String序列化为String[],使用的方法如下:

    Gson gson = new Gson();
    String[] nameArray = gson.fromJson(name, String[].class);
    

    整体类似于1的简单Object

    3. List, Map, Set

    String userJson = "[{'isDeveloper':false,'name':'xiaoming','age':26,'email':'xiaoming@mail.com'},{'isDeveloper':true,'name':'xiaowang','age':27,'email':'xiaowang@mail.com'}]";
    
    Gson gson = new Gson();
    Type userListType = new TypeToken<ArrayList<User>>(){}.getType();
    
    List<User> userList = gson.fromJson(userJson, userListType); 
    

    对于List,反序列化时必须提供它的Type,通过Gson提供的TypeToken<T>.getType()方法可以获得当前List的Type。

    四. 值为null时,序列化/反序列化

    1. 序列化:当某个变量值为null时,Gson在序列化的时候直接把这个变量忽略了。
    2. 反序列化:对于JSON字符串里没有的变量,Gson在反序列化时会给它一个默认值,int类型默认为0,bool类型默认为false,String类型默认为null。

    五. 控制序列化/反序列化 的变量名称

    仍然以User对象为例,目前User对象里有四个变量name, age, email, isDeveloper。假如,某一天,JSON字符串的变量名name变成了fullName,无需紧张,我们不用把User类里的变量name改为fullName,然后把它的get和set方法都改了,然后把用到get/set方法的地方全改过来。只需要用Gson提供的注解方法@SerializedName就行了,如下:

    public class User {
        private boolean isDeveloper;
        @SerializedName("fullName")
        private String name;
        private int age;
        private String email;
        ...
    }
    

    这样虽然JSON字符串里的变量名为fullName,但是反序列化后fullName的值会映射给name。同样,把一个User对象序列化,变量name会自动转换为fullName。

    然而现实远比想象中复杂,这个JSON有时候传的是fullName,有时候传的是name,这时该怎么办呢? 不用担心,@SerializedName 接受两个参数,value 和 alternate ,顾名思义,alternate 是备选变量名,比如下面这段代码:

    public class User {
        private boolean isDeveloper;
        @SerializedName(value = "name", alternate = "fullName")
        private String name;
        private int age;
        private String email;
        ...
    }
    

    如果JSON传的是name,那么就用name的值,如果传的是fullName,那么就用fullName的值。需要注意的是,alternate只是反序列化JSON的一个备选变量名,它不会影响序列化,User对象序列化后,会使用value定义的名称为变量名。

    又想到有一个问题,在定义了value和alternate的情况下,假如JSON同时传来了name和fullName,User的name变量会接受哪个值呢? 经过测试,它会都接受。这样也是很合理的,因为Gson会对JSON中的变量一个一个地去解析,既然它可以接受name,也可以接受fullName,那么当同时传来这两个变量时,它就会分别把它们解析出来,并把值赋给User对象中的name变量。那么,name变量的值就会是后解析的那个JSON变量的值,因为它会把前一个值覆盖掉。

    六. 序列化/反序列化过程中忽略某些变量

    也许会出现这样的需求,在将某个对象序列化时,对象中的某些变量是不需要的。有可能在反序列化某个JSON字符串时,某些变量的值也是不需要的。

    方法1: 可以使用Gson提供的@Expose注解方法。使用方法如下:

    public class User {  
        @Expose()
        String name; // 参与序列化/反序列化
    
        @Expose(serialize = false, deserialize = false)
        String email; // 不参与序列化,也不参与反序列化
    
        @Expose(serialize = false)
        int age; // 只参与反序列化
    
        @Expose(deserialize = false)
        boolean isDeveloper; // 只参与序列化
    }
    

    使用这个方法,可以非常灵活地控制对象的某个/某些变量参不参与序列化/反序列化。

    然而! 要使用这个注解来控制序列化/反序列化,就不能使用默认的Gson对象,新建Gson对象的方法如下:

    GsonBuilder builder = new GsonBuilder();  
    builder.excludeFieldsWithoutExposeAnnotation();  
    Gson gson = builder.create(); 
    

    方法2: transient关键字 ,使用这个关键字,可以直接让变量不参与序列化/反序列化,如下:

    public class User {  
        String name;
        String email;
        int age;
        boolean transient isDeveloper; //不参与序列化/反序列化
    }
    

    当然,使用默认的Gson对象就可以。

    相关文章

      网友评论

          本文标题:Gson基本用法

          本文链接:https://www.haomeiwen.com/subject/aunxaqtx.html