Gson的进阶使用

正确熟练的使用Gson这个开源库能够有效的提高开发的效率,它可以快捷的将json串转化成Map<>,List<>或实体类,并支持反向操作

基本操作
// 序列化
String string = new Gson().toJson(user);
// 反序列化
User user = new Gson().fromeJson(string, User.class);
泛型的反序列化
// 序列化
String string = new Gson().toJson(userList);
// 反序列化
List userList = new Gson().
    fromeJson(string, new TypeToken>(){}.getType());

TypeToken的源码,可以对Java的泛型有更深刻的理解

复杂嵌套json串需要注意的问题

有些json串的嵌套很复杂,对象中某个字段为列表,列表中又有多个对象。在处理这种json串的时候要注意的是,分步操作,每一步操作后打印json串看一下

// 错误的json串格式,没有双引号
[{rec_id=797, type=4, data=杭州, remark=}]

// 正确的json串格式是有双引号的,这样才能保证被正确的解析
[{"rec_id":"797","type":"4","data":"杭州","remark":""}]

// 实际上如果上面的remark字段不为空,这两种都可以被解析
// 但一旦有字段为空,没有双引号的那种就会抛出异常

在提取json串中的某一个对象的时候,若想单独转换成一个json串,应该使用下面的方式

Map map = gson.fromJson(json, Map.class);

// 这种写法是错误的,转换完会是上面那种错误的json格式
String newjson = map.get("data").toString();

// 这种转换方式才是正确的,以为通过map取得的也是一个对象
// 需要反序列化一次才能得到json串,而不是直接toString()
String newjson = gson.toJson(map.get("data"));
变量名的对应

很多情况下Java中的成员变量是通过驼峰式命名的,例如userName,passWord。而json的串可能是通过数据库生成,数据库中字段的命名方式为user_name,pass_word。这两种命名方式在某些开源框架中是可以实现相互转换的,虽然Gson不支持自动转换,但可以通过下面的方式来映射Java中的成员变量名和json串中的key

@SerializedName("user_name")
private String userName;
如果Java的成员变量没有对应的json串中的key,则这个变量会被赋值为null,所以在成员变量的类型定义的时候,应避免使用基本数据类型,而使用对应的包装器类型去替代
控制变量是否序列化

和对应变量名的方法差不多,也是通过注解的方式来控制的,一个是@Expose注解,还有一个是@Since注解

  • @Expose注解有两个变量:serializedeserialize,默认值都是true

    public class User {
          @Expose
          private String userName;
          @Expose(serialize = false)
          private int age;
          @Expose(serialize = false, deserialize = false)
          private boolean admin;
    }
    

    这时序列化只会输出userName字段,反序列化只会给userName和age字段赋值
    需要注意的是,要想使@Expose这个注解生效,需要使用如下方法来构建Gson对象

     Gson gson = new GsonBuilder()
                      .excludeFieldsWithoutExposeAnnotation().create();
    
  • @Since注解主要用于进行版本的控制

    public class User {
         @Since(1.0)
         private String userName;
         @Since(1.1)
         private int age;
         @Since(1.1)
         private boolean admin;
    }
    
    Gson gson = new GsonBuilder().setVersion(1.0).create();
    

    在构建Gson对象的时候使用GsonBuilder的方式,指定一个版本号,成员变量的版本号高于指定的版本号的时候,在转换的时候将会被忽略,例如上述例子,只有userName字段会被序列化和反序列化

重写适配器

当一个json串的字段的值为"",且这个字段对应的成员变量的类型为int,由于空字符串无法转化成int类型,所以就会报错,这个时候多数情况下我们是希望其转化成0的,或者是某一个默认值,所以我们可以通过重写适配器的方式,来达到我们想要达到的效果,仅以重写int类型的适配器为例

public class IntegerDefaultAdapter 
        implements JsonSerializer, JsonDeserializer {
    @Override
    public Integer deserialize(JsonElement json, 
          Type typeOfT, JsonDeserializationContext context)
            throws JsonParseException {
        try {
            // 此处可自定义规则
            if (json.getAsString().equals("") || 
                json.getAsString().equals("null")) {
                return 0;
            }
        } catch (Exception ignore) {
            // catch error
        }
        try {
            return json.getAsInt();
        } catch (NumberFormatException e) {
            throw new JsonSyntaxException(e);
        }
    }

    @Override
    public JsonElement serialize(Integer src, Type typeOfSrc, 
          JsonSerializationContext context) {
        return new JsonPrimitive(src);
    }
}

// 构造Gson对象的方式
Gson gson = new GsonBuilder()
      .registerTypeAdapter(Integer.class, new IntegerDefaultAdapter())
      .create();

如果要写其他类型的适配器,只需要更改上面的Integer为对应的类型即可

你可能感兴趣的:(Gson的进阶使用)