Retrofit使用教程:Retrofit中GSON解析同字段不同类型的json数据

前言

本文主要是对在项目中处理json的实际应用。

直接上代码

解析数据的时候有可能会遇到同字段不同数据类型的问题,以下面数据为例:

// 返回成功的数据
{
    "retMsg": "success",
    "retData": {
        "city": "杭州",
        "phone": "13282191888",
        "prefix": "1328219",
        "province": "浙江",
        "supplier": "联通"
    },
    "errNum": 0
}

// 返回失败的数据
{
    "errNum": -1,
    "retMsg": "[132821918888]\u6b64\u53f7\u7801\u4e0d\u662f\u5408\u6cd5\u7684\u624b\u673a\u53f7!",
    "retData": []
}

从返回的数据可以看出retData的类型变成了两种(对象和数组),如果只定义成对象当返回失败的时候GSON无法解析并抛出异常。因为我这里GSON是组合Retrofit使用的,当解析失败异常会回调到Subscriber中的以下方法里:

public void onError(Throwable e) {}

在这个onError方法里,我们无法获取到其它有用的数据。比如说我们想获取错误信息提示给用户,但在这里是没有办法的。

  • 解决这个问题的方法有两种:
  • 使用反序列化解析数据
  • 把数据通过异常抛出,并做处理
  • 反序列化有一些局限性,这里的retMsg定义的是未知的泛型并不能很好的解决。所以以下的方法我使用抛出异常数据。
一、初始化Retrofit时使用自定义拦截器。
Retrofit mAdapter = new Retrofit.Builder()
        .baseUrl(SERVER)
        // 增加自定义解析
        .addConverterFactory(GsonDConverterFactory.create())
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
        .client(getBuilder().build())
        .build();
二、自定义responseBody对返回的数据解析。
public final class GsonDConverterFactory extends Converter.Factory {

    public static GsonDConverterFactory create() {
        return create(new Gson());
    }

    public static GsonDConverterFactory create(Gson gson) {
        return new GsonDConverterFactory(gson);
    }

    private final Gson gson;

    private GsonDConverterFactory(Gson gson) {
        if (gson == null) throw new NullPointerException("gson == null");
        this.gson = gson;
    }

    @Override public Converter < ResponseBody,
    ?>responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
        return new GsonResponseBodyConverter < >(gson, type);
    }

    @Override public Converter < ?,
    RequestBody > requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
        TypeAdapter < ?>adapter = gson.getAdapter(TypeToken.get(type));
        return new GsonRequestBodyConverter < >(gson, adapter);
    }
}
三、根据code值选择不同的类解析数据。

在convert方法里,先不指定具体泛型解析出返回的数据。通过code值判断本次请求:成功就返回type类型的解析数据,失败就使用我们提前定义好的HttpErrResult对象进行解析,并通过ResultException把错误信息返回回去。

final class GsonResponseBodyConverter < T > implements Converter < ResponseBody,
T > {
    private final Gson gson;
    private final Type type;

    GsonResponseBodyConverter(Gson gson, Type type) {
        this.gson = gson;
        this.type = type;
    }

    /**
     * 针对数据返回成功、错误不同类型字段处理
     */
    @Override public T convert(ResponseBody value) throws IOException {
        String response = value.string();
        try {
            // 这里的type实际类型是 HttpResult<PhoneBean>  PhoneBean就是retData要获取的对象。
            HttpResult result = gson.fromJson(response, HttpResult.class);
            int code = result.getErrNum();
            if (code == 0) {
                return gson.fromJson(response, type);
            } else {
                Log.d("HttpManager", "返回err==:" + response);
                HttpErrResult errResponse = gson.fromJson(response, HttpErrResult.class);
                if (code == -1) {
                    throw new ResultException(errResponse.getRetMsg(), code);
                } else {
                    throw new ResultException(errResponse.getErrMsg(), code);
                }
            }
        } finally {
            value.close();
        }
    }
}
四、自定义Retrofit的Subscriber方法解析失败与成功信息。

我们之前的异常会回调到onError方法里,通过判断是否是ResultException异常,取出异常信息回调给Presenter处理。

public abstract class HttpResultCallBack < M > extends Subscriber < HttpResult < M >> {

    /**
     * 请求返回
     */
    public abstract void onResponse(M m, int status);
    public abstract void onErr(String msg, int status);

    /**
     * 请求完成
     */
    @Override public void onCompleted() {}

    @Override public void onError(Throwable e) {
        if (e != null) {
            if (e instanceof ResultException) {
                ResultException err = (ResultException) e;
                onErr(err.getErrMsg(), GlobalVar.RESULT_UNLOGIN);
            } else {
                onErr("网络异常,请检查网络", GlobalVar.RESULT_UNLOGIN);
                Log.d("HttpManager", "解析失败==:" + e.getMessage());
            }
        }
        onCompleted();
    }

    /**
     * Http请求失败
     */
    private void onHttpFail(String msg, int status) {
        onErr(msg, status);
    }

    @Override public void onNext(HttpResult < M > result) {
        String jsonResponse = new Gson().toJson(result);
        Log.d("HttpManager", "返回ok==:" + jsonResponse);
        if (result.getErrNum() == GlobalVar.RESULT_OK) {
            onResponse(result.getRetData(), GlobalVar.RESULT_OK);
        } else {
            onHttpFail(result.getErrMsg(), GlobalVar.RESULT_UNLOGIN);
        }
    }
}

github源码下载

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,287评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,346评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,277评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,132评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,147评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,106评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,019评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,862评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,301评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,521评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,682评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,405评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,996评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,651评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,803评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,674评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,563评论 2 352

推荐阅读更多精彩内容