初衷
项目中与服务器端的数据交互采用的是json，服务器返回的数据格式比较统一，都是下面这种样子的
{resultCode:10000,
resultContent:"登录成功"，
obj:{...} //或者[...]
}
对于这段json的解析，我觉得有下面几种方式:
- 通过android自带的JSONObject以及JSONArray采用原生的方式一层一层的解析;
- 通过android自带的JSONObject解析到obj 然后配合Gson解析obj对应的具体内容;
- 为每一种格式的json写对应的实体类(包括json的所有字断)然后通过gson或者其他解析工具解析成对象。
通过对比发现，第一种方式对于obj结构复杂的情况会出现代码庞大的问题；第二种在解析每个json的时候会出现重复代码；第三种需要为每个json写实体类,会出现属性重复的情况如果采用继承的话会出现某些实体类中就一个属性的情况。
本文的目标就是针对第三种方式的一种封装，开发者可以只提供obj对应的实体类即可。当然更希望本文提供的是解决一类问题的思路。
想法
如果有一个类 包含3个字段，分别是:int resultCode,String resultContent,Object obj; 然后根据返回的json的需求，将obj替换成对应的具体的类,可想而知需要用到泛型(obj应该是T类型的即T obj)。
实现
按照本文最开始的json结构举例,定义一个实体类如下:
public class Results<T>{
private int resultCode;//结果码
private String resultContent;//服务器端返回的结果码说明，可以用于toast显示
private T Object;//具体的数据,可以是对象或者list
//getter setter...
}
下面到本文的主角出场了，我一般喜欢用google的Gson作为json的解析工具,本文也已gson作为示例(PS:Gson是个非常强大的工具，强烈推荐使用)。
定义一个公共方法供外部调用，也是解析的主要方法，代码如下:
public static Results fromJson(String json, Type clazz) {
Gson gson = new Gson();
Type objectType = type(Results.class, clazz);
return gson.fromJson(json, objectType);
}
下面是type方法的实现:
static ParameterizedType type(final Class raw, final Type... args){
return new ParameterizedType() {
public Type getRawType() {
return raw;
}
public Type[] getActualTypeArguments() {
return args;
}
public Type getOwnerType() {
return null;
}
};
}
简单解释一下,type方法的作用就是把Results类里面的T类型的变量obj转换成传入的Type clazz 对应的类型,里面的两个参数第一个代表包含泛型类的类，本例中就是Results了;第二个参数代表的是泛型变量对应的具体的类型，需要说明的是如果是list类型的需要通过Gson提供的方法得到正确的type值传入，如果是普通的Object类只需要传入对应类的class即可，比如User.class
ParameterizedType和Type都是java.lang.reflect包里面的类，查看源码可以发现Type是个接口，class实现了该接口。
用法
假设有个User类，包含String id,String name两个字段。
1.如果obj对应的是List<User>,则对应的son解析的用法如下:
Results<List<User>> results=Results.fromJson(json,
new TypeToken<List<User>>() {}.getType());
List<User> list2=results.getObj();
2.如果obj对应的是User,则对应的json解析的用法如下:
Results<User> results = Results.fromJson(json,User.class);
User user = results.getObj();
总结与补充
1.本文适用范围是对于json结构相同或相似的情况，当然type方法可以用于很多其他的情况(type方法很强大)。
2.使用Gson解析json需要注意字段名的对应,Gson提供了@SerializedName("obj")的注解用于解决客户端与服务器端实体类字段不一致的问题。
3.本文实现的效果是对于结构相同或者类似的json提供了更多一层的封装，使得开发者可以只提供obj对应的实体类(如果是list只需要提供list包含的类型对应的实体类)即可。
4.大家可以根据具体的需求在本文的基础上进行改造。
希望本文能为大家提供一种思路或者一种问题的解决方案,对于本文中涉及到的一些说法或者做法，如果有不同见解的或者更好的实现方式的欢迎留言交流。遇到问题的也可以留言或者联系QQ:1654088754。
网友评论