Gson解析给我满带来了很多方便,但其实,Gson可以更方便,接下来就介绍Gson的两个特殊功能,这两个功能也是在深入使用Gson解析中必须掌握的。它们分别是:自定义类型适配器和自定义参数适配器。
1 自定义类型适配器。
在第一章节中讲到Gson对String类型的解析如下:
public static final TypeAdapter<String> STRING = new TypeAdapter<String>() {
@Override
public String read(JsonReader in) throws IOException {
JsonToken peek = in.peek();
if (peek == JsonToken.NULL) {//如果为null,直接返回
in.nextNull();
return null;
}
/* coerce booleans to strings for backwards compatibility */
if (peek == JsonToken.BOOLEAN) {//如果是bool型,则转成String
return Boolean.toString(in.nextBoolean());
}
return in.nextString();
}
@Override
public void write(JsonWriter out, String value) throws IOException {
out.value(value);
}
};
针对如上解析。如待解析数据如下:
{
"name":"zhangsan",
"addr":"beijing",
"no":18888888888,
"others":""}
其对应的model如下:
public class StringModel {
String name;
String addr;
String no;
String others;
}
在正常情况下,others这个字段会被解析成一个长度为0的字符串,但是很多情况下,为了规范Android端数据解析,如果服务端返回""、null、NULL等数据时,🤝解析为null。在这种情况下,就需要自定义TypeAdapter,来规范字符串的解析过程。
针对如上需求,自定义的TypeAdapter如下:
public class StringTypeAdapter extends TypeAdapter<String> {
@Override
public String read(JsonReader in) throws IOException {
JsonToken peek = in.peek();
if (peek == JsonToken.NULL) {//如果为null,直接返回
in.nextNull();
return null;
}
/* coerce booleans to strings for backwards compatibility */
if (peek == JsonToken.BOOLEAN) {//如果是bool型,则转成String
return Boolean.toString(in.nextBoolean());
}
String result = in.nextString();
if (TextUtils.isEmpty(result)) {
return null;
}
return result;
}
@Override
public void write(JsonWriter out, String value) throws IOException {
out.value(value);
}
}
自定义TypeAdapter的使用如下:
String jsonString = "{\n" +
"\"name\":\"zhangsan\",\n" +
"\"addr\":\"beijing\",\n" +
"\"no\":18888888888}";
Gson gson = new GsonBuilder().registerTypeAdapter(String.class, new StringTypeAdapter()).create();
StringModel stringModel = gson.fromJson(jsonString, StringModel.class);
Gson的构建方式发生了变化,采用了GsonBuilder来生成的方式。registerTypeAdapter()专门用来注册自定义的TypeAdapter,StringTypeAdapter只是类型自定义适配器的一个简单的例子,利用TypeAdapter,还可以实现很多高级的功能。关于类型自定义适配器就介绍到这。下面介绍一下Gson的第二个特殊功能自定义参数适配器。
2 自定义参数适配器
自定义参数适配器比自定义类型适配器的粒度更细,它能够精确到具体的参数。对某个待解析(待生成)的参数实现自定义配置。
还是以上面的数据为例:
{
"name":"zhangsan",
"addr":"beijing",
"birth":18978787,
"no":18888888888,
"others":null}
添加了一个birth字段。这个字段是long型数据。但是在客户端使用这个数据的时候,希望他是Date类型。在正常情况下,Gson是无法做到从long型转换成Date类型的。(注意:简单数据类型之间的转换,Gson是默认支持的)所以,在这种情况下自定义参数适配器就产生了。自定义参数适配器主要用到了JsonSerializer 和JsonDeserializer。下面以上面的为例,自定义JsonDeserializer如下:
public class DateDeserializer implements JsonDeserializer<Date> {
@Override
public Date deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
JsonObject jsonObject = json.getAsJsonObject();
long time = jsonObject.get("birth").getAsLong();
return new Date(time);
}
}
待解析model如下:
public class StringModel {
String name;
String addr;
@JsonAdapter(DateDeserializer.class)
Date birth;
String no;
String others;
}
这样就实现了参数的自定义解析,如果只是想StringModel这一个类的birth属性实现自定义解析,如上实现已经足够了,如果想实现所有model中的birth属性都能采用相同的自定义解析方式,那么就需要将DateDeserializer注册到GsonBuilder中。实现方式如下:
Gson gson = new GsonBuilder()
.registerTypeAdapter(String.class, new StringTypeAdapter())
.registerTypeAdapter(Date.class,new DateDeserializer())
.create();
参数的自定义生成过程与之相反,这里就不一一介绍了。