后台返回数据错误json解析总报错怎么办!这个框架解决你的烦恼!
集成步骤
- 在项目根目录下的
build.gradle文件中加入
buildscript {
......
}
allprojects {
repositories {
// JitPack 远程仓库：https://jitpack.io
maven { url 'https://jitpack.io' }
}
}- 在项目 app 模块下的
build.gradle文件中加入
android {
// 支持 JDK 1.8
compileOptions {
targetCompatibility JavaVersion.VERSION_1_8
sourceCompatibility JavaVersion.VERSION_1_8
}
}
dependencies {
// Gson 解析容错：https://github.com/getActivity/GsonFactory
implementation 'com.github.getActivity:GsonFactory:5.2'
// Json 解析框架：https://github.com/google/gson
implementation 'com.google.code.gson:gson:2.8.5'
}使用文档
- 请使用框架返回的 Gson 对象来代替项目中的 Gson 对象
// 获取单例的 Gson 对象（已处理容错）
Gson gson = GsonFactory.getSingletonGson();
- 因为框架中的 Gson 对象已经对解析规则进行了容错处理
其他 API
// 设置自定义的 Gson 对象
GsonFactory.setSingletonGson(Gson gson);
// 创建一个 Gson 构建器（已处理容错）
GsonBuilder gsonBuilder = GsonFactory.newGsonBuilder();
// 注册类型适配器
GsonFactory.registerTypeAdapterFactory(TypeAdapterFactory factory);
// 注册构造函数创建器
GsonFactory.registerInstanceCreator(Type type, InstanceCreator<?> creator);
// 设置 Json 解析容错监听
GsonFactory.setJsonCallback(new JsonCallback() {
@Override
public void onTypeException(TypeToken<?> typeToken, String fieldName, JsonToken jsonToken) {
// Log.e("GsonFactory", "类型解析异常：" + typeToken + "#" + fieldName + "，后台返回的类型为：" + jsonToken);
// 上报到 Bugly 错误列表
CrashReport.postCatchedException(new IllegalArgumentException("类型解析异常：" + typeToken + "#" + fieldName + "，后台返回的类型为：" + jsonToken));
}
});
容错介绍
目前支持容错的数据类型有：
Bean 类数组集合String（字符串）boolean / Boolean（布尔值）int / Integer（整数，属于数值类）long /Long（长整数，属于数值类）float / Float（单精度浮点数，属于数值类）double / Double（双精度浮点数，属于数值类）BigDecimal（精度更高的浮点数，属于数值类）
基本涵盖 99.99% 的开发场景，可以运行 Demo 中的单元测试用例来查看效果：
| 数据类型 | 容错的范围 | 数据示例 |
|---|---|---|
| bean | 集合、字符串、布尔值、数值 | []、""、false、0 |
| 集合 | bean、字符串、布尔值、数值 | {}、""、false、0 |
| 字符串 | bean、集合、布尔值、数值 | {}、[]、false、0 |
| 布尔值 | bean、集合、字符串、数值 | {}、[]、""、0 |
| 数值 | bean、集合、字符串、布尔值 | {}、[]、""、false |
大家可能觉得 Gson 解析容错没什么，那是因为我们对 Gson 解析失败的场景没有了解过：
类型不对：后台有数据时返回
JsonObject，没数据返回[]，Gson 会直接抛出异常措手不及：如果客户端定义的是
整数，但是后台返回浮点数，Gson 会直接抛出异常意想不到：如果客户端定义的是
布尔值，但是后台返回的是0或者1，Gson 会直接抛出异常
以上情况框架已经做了容错处理，具体处理规则如下：
如果后台返回的类型和客户端定义的类型不匹配，框架就
不解析这个字段如果客户端定义的是整数，但后台返回浮点数，框架就对数值进行
取整并赋值给字段如果客户端定义布尔值，但是后台返回整数，框架则将
非 0 的数值则赋值为 true，否则为 false
常见疑问解答
- Retrofit + RxJava 怎么替换？
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create(GsonFactory.getSingletonGson()))
.build();
- 有没有必要处理 Json 解析容错？
我觉得非常有必要，因为后台返回的数据结构是什么样我们把控不了，但是有一点是肯定的，我们都不希望它崩，因为一个接口的失败导致整个 App 崩溃退出实属不值得，但是 Gson 很敏感，动不动就崩。
- 我们后台用的是 Java，有必要处理容错吗？
如果你们的后台用的是 PHP，那我十分推荐你使用这个框架，因为 PHP 返回的数据结构很乱，这块经历过的人都懂，没经历过的人怎么说都不懂。
如果你们的后台用的是 Java，那么可以根据实际情况而定，例如我现在的公司用的就是 Java 后台，但是 Bugly 有上报一个关于 Gson 解析的 Crash，所以后台的话只能信一半。
