Gson使用
在Android中使用Gson,先在Compile中加入编译包
compile 'com.google.code.gson:gson 2.8.0'
可以去Gson的github官网查看最新版本
gson两个主要的方法,一个是gson.toJson()
,一个是gson.FromJson()
,两个方法都是简洁易懂。
从对象变成Json字符串
Gson gson = new Gson();
Object obj = new Object();
String jsonString = gson.toJson(obj);
从Json字符串转变为Obj对象
String input;
Gson gson = new Gson();
Object obj = gson.from(input,Object.class);
1. json字段调整
有时候json中的field不能完全和自己的class对应上,这时候就需要修改字段。但是有时候,前端后端不同语言写的,风格就是有差异,就在字段前面使用:
@SerializedName("email_address")
publicString emailAddress;
这样即使在字符串中得到的是加下划线的,依然能够对应到Bean中。注意:from和to都将是注解中的名字。
有这样一种情况,有的系统是这种,有的系统是那种,要能够全部兼容,那么Gson也提供了一种注解:
@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;
有备用的,在序列化时会按照emailAddress来,在反序列化时会优先从value中找,找不到再从alternate中找。
2. Gson解析list
(1)如果想解析为数组
Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
(2)如果想解析为List,因为java为伪泛型,如下可以做:
Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
List<String> stringList = gson.fromJson(jsonArray, new TypeToken<List<String>>() {}.getType());
3、Gson有五种方法:
Gson.toJson(Object);
Gson.fromJson(Reader,Class);
Gson.fromJson(String,Class);
Gson.fromJson(Reader,Type);
Gson.fromJson(String,Type);
这样就能在读文件啥的流的过程中进行Gson解析了,不过在Rxjava和retrofit的框架中已经用上了Gson的流操作,不用自己麻烦了。
4、Gson Builder用法
Gson gson = new GsonBuilder()
//各种配置
.create();
比如:
添加.serializeNulls()
将所有没有值的field赋上null
添加.excludeFieldsWithoutExposeAnnotation()
,只有field前面有@Expose
注解的才会被序列化
添加.excludeFieldsWithModifiers(Modifier.FINAL, Modifier.STATIC, Modifier.PRIVATE)
排除掉final,static,private字段
5、Adapter
贴上一个现成的Gson配置
public static final Gson GSON_DEFAULT = new GsonBuilder()
.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE)
.registerTypeAdapter(User.class, new UserTypeAdapter())
.registerTypeAdapterFactory(new CustomTypeAdapterFactory())
.enableComplexMapKeySerialization()
.create();
其中
.registerTypeAdapter(User.class, new UserTypeAdapter())
对个别calss作操作,UserTypeAdapter()
类内部进行该类的序列化与反序列化的定制,通过内部覆写read
和write
方法,达到定制的要求。
6、GsonAdapterFactory
CustomTypeAdapterFactory
就是自己的adapterFactory
。
如果用户有很多的类需要定义,为了避免在gson的配置中显示太多的registerTypeAdapter
,gson就采用了将所有adapter集中在一个factory类中的方法。
然后在Factory的creat方法中完成操作。