Retrofit·自定义Convert对网络请求结果的统一处理

  1. 本文中采用的API来自http://gank.io/api
  2. 转载请注明出处
  3. 源码点击下载
  4. 本文中所采用的组合为Retrofit+RxJava2.x(用法和依赖与RxJava1.x都有一些差别)
  5. 纯属原创,如有雷同,绝逼巧合,表打脸...

正文

本文中所有Http请求结果之后,返回的结构统一都是

{"error": false, "results": [...]}
或者
{"error": false,"results": {...}}

既然我们有了相同的返回格式,那么我们可能就需要在获得数据之后进行一个统一的预处理。

对于预处理的方式有两种 :

  • 第一种是根据API接口创建bean,再创建业务请求接口,通过Retrofit获取到数据后再进行转换,由于格式是一致的,所以从获取数据到转换获得真正想要的数据这些步骤都是一致的,因此可以进行封装,网络上大多都是如此.

    比如:
    RxJava 与 Retrofit 结合的最佳实践

    再比如:
    RxJava结合Retrofit对网络请求结果的统一处理 PS:没有仔细看,不过也是差不多的...

  • 第二种就是自定义Convert,直接拿到results中的数据,也可以是直接抛出Error,由Subscriber中的onError中集中处理,具体异常处理请参考:Retrofit自定义GsonConverter处理所有请求错误情况,本文只介绍如何获取我们想要的数据 PS:没错我也没仔细看,不过大致也是没问题的~~~

那么接下来我们进入正餐,没错上面大多都是屁话...

1. 首先通过第一种方式引申一下Retrofit的网络请求流程(大神可略过)

假设数据格式如下:
{
  "error": false, 
  "results": [
    "2017-01-12", 
    "2017-01-11", 
    "2017-01-10", 
    "2017-01-09", 
    "2017-01-06",]
}
1. 由数据获得的bean如下:
public class GankHttpResult {
    private boolean error;
    private List results;
}
2. 业务请求接口如下:
public interface APIService {
    //http://gank.io/api/day/history 获取时间段
    @GET("day/history")
    Observable getHistory();
}
3. 获得Retrofit实例
public APIManager() {
        // 实例化Retrofit
        //"error": false,
        //"results": []
        mRetrofitGank = new Retrofit.Builder()
                .baseUrl("http://gank.io/api/")
                //将Json结果并解析成DAO
                .addConverterFactory(GsonConverterFactory.create())
                //Service接口默认返回Call 要想返回Observable,需得加上这一句
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build();
}
4. 获得APIService实例接口
public static APIService getApiService() {
        return getInstance().mRetrofitGank.create(APIService.class);
}
5. 调用APIService的方法,获取Observable然后通过一系列变换处理,得到我们想要的结果
APIManager.getApiService().getHistory()
                .subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new DisposableObserver>() {
                    @Override
                    public void onNext(List value) {
                        for (int i = 0; i < value.size(); i++) {
                            Log.v("shan", "" + value.get(i));
                        }
                    }

                    @Override
                    public void onError(Throwable e) {
                        Log.v("shan", ""+e.getMessage());
                    }

                    @Override
                    public void onComplete() {

                    }
                });

2. 具体分析

在步骤3中addConverterFactory(GsonConverterFactory.create())这句代码是为了用Gson把服务端返回的json数据解析成实体的 PS:这一句来自于Retrofit自定义GsonConverter处理所有请求错误情况,除此之外这句代码还具备者的功能为将我们的代码转换成Http请求体,请求加密什么的可以在这处理吧 PS:是我说的,有错请私聊~~~

既然要统一处理接口数据,那么就是在GsonConverterFactory中处理.
在GsonConverterFactory中的涉及两个类 :

  • GsonResponseBodyConverter // 处理ResponseBody
  • GsonRequestBodyConverter // 处理RequestBody

统一处理接口数据就是在GsonResponseBodyConverter的convert方法中处理,具体如下:

    /**
     * 思路:获取我们想要的数据转换成Reader,之后与源码结果一致
     * PS:如果接口数据更规范的话一下代码还可以再精简
     */
    @Override
    public T convert(ResponseBody value) throws IOException {
        try {
            //GankHttpResult result = JSON.parseObject(value.string(), GankHttpResult.class);
            //GankHttpResult result = gson.fromJson(value.string(), GankHttpResult.class);
            //Log.v("shan",""+result.getResults());

            JSONObject object = new JSONObject(value.string());
            
            ByteArrayInputStream inputStream ;
            if (object.toString().contains("results\":[")) {//原谅我,fastJson和gson都试过了,都不行,只能写死了
                JSONArray results = object.getJSONArray("results");
                inputStream = new ByteArrayInputStream(results.toString().getBytes());
            } else if (object.toString().contains("results\":{")) {

                JSONObject results = object.getJSONObject("results");
                //将字符串转换成输入流
                inputStream = new ByteArrayInputStream(results.toString().getBytes());
            } else {
                //随便抛个异常的,请自动忽略
                throw new JSONException("Port Exception");
            }
            //字节流转换成字符流
            Reader reader = new InputStreamReader(inputStream);
            
            //这个也不清楚是做什么的,只是仿照源代码,想要什么直接给什么
            JsonReader jsonReader = gson.newJsonReader(reader);
            //返回APIService接口中每个请求所定义的返回结果
            return adapter.read(jsonReader);
        } catch (JSONException e) {
            e.printStackTrace();
        } finally {
            value.close();
        }
        return null;
    }
总结:也就是说全文精华也就是以上这些代码,其余的全是屁话...
具体步骤:请将GsonConverterFactory/GsonResponseBodyConverter/GsonRequestBodyConverter这三个类原封不动的复制粘贴(可修改类名),修改GsonResponseBodyConverter中的convert方法...

你可能感兴趣的:(Retrofit·自定义Convert对网络请求结果的统一处理)