Android小知識-剖析Retrofit中網(wǎng)絡(luò)請求的兩種方式

本平臺的文章更新會有延遲逗宜,大家可以關(guān)注微信公眾號-顧林海同波,包括年底前會更新kotlin由淺入深系列教程允懂,目前計劃在微信公眾號進(jìn)行首發(fā)厕怜,如果大家想獲取最新教程,請關(guān)注微信公眾號蕾总,謝謝!

在上一節(jié)《Android小知識-剖析Retrofit中ServiceMethod相關(guān)參數(shù)以及創(chuàng)建過程》介紹了動態(tài)代理類中三行核心代碼的第一行酣倾,通過loadServiceMethod方法獲取ServiceMethod對象,在loadServiceMethod方法中先會檢查緩存集合中是否有對應(yīng)網(wǎng)絡(luò)請求接口方法的ServiceMethod對象谤专,如果不存在就通過Builder模式創(chuàng)建躁锡,同時介紹了ServiceMethod內(nèi)部的一些成員變量,其實(shí)ServiceMethod就是對網(wǎng)絡(luò)請求接口內(nèi)部一個個方法的封裝置侍,通過解析方法內(nèi)部或方法上的注解來封裝ServiceMethod對象映之。這節(jié)來介紹三行核心代碼的剩余兩行拦焚。

  public <T> T create(final Class<T> service) {
    ...
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
              throws Throwable {
            ...
            //核心代碼1
            ServiceMethod<Object, Object> serviceMethod =
                (ServiceMethod<Object, Object>) loadServiceMethod(method);
            //核心代碼2
            OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
            //核心代碼3
            return serviceMethod.adapt(okHttpCall);
          }
        });
  }

在核心代碼2處創(chuàng)建OkHttpCall,OkHttpCall是Call的實(shí)現(xiàn)類杠输,在Retrofit中內(nèi)部是通過OkHttp來進(jìn)行網(wǎng)絡(luò)的請求赎败,這個OkHttpCall就是對OkHttp請求的封裝。

final class OkHttpCall<T> implements Call<T> {
  ....
  private @Nullable okhttp3.Call rawCall;

  OkHttpCall(ServiceMethod<T, ?> serviceMethod, @Nullable Object[] args) {
    this.serviceMethod = serviceMethod;
    this.args = args;
  }
}

在OkHttpCall中可以看到rawCall蠢甲,它是OkHttp的Call僵刮,這也驗(yàn)證之前所說的內(nèi)部會通過OkHttp來實(shí)現(xiàn)網(wǎng)絡(luò)請求,OkHttpCall構(gòu)造函數(shù)傳入兩個參數(shù)鹦牛,serviceMethod對象和args網(wǎng)絡(luò)請求參數(shù)搞糕,接著看核心代碼3。

   return serviceMethod.adapt(okHttpCall);

serviceMethod的adapt方法中會調(diào)用callAdatper的adapter方法曼追,通過適配器的adapt方法來將OkHttpCall轉(zhuǎn)換成其他平臺使用的對象窍仰,這個callAdapter是在創(chuàng)建serviceMethod時通過構(gòu)建者模式創(chuàng)建的,它代表網(wǎng)絡(luò)請求的適配器礼殊,這里使用的RxJava平臺驹吮。

回到一開始的實(shí)例代碼:

    private void initRetrofit() {
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://icould.glh/")
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .build();

        NetworkInterface networkInterface = retrofit.create(NetworkInterface.class);

        Map<String, String> params = new HashMap<>();
        params.put("newsId", "1");
        params.put("token", "yud133f");
        Call call = networkInterface.getNewsDetails(params);

        call.enqueue(new Callback() {
            @Override
            public void onResponse(Call call, Response response) {
                System.out.println(response.body());
            }

            @Override
            public void onFailure(Call call, Throwable t) {
                System.out.println("請求錯誤");
            }
        });
    }

通過networkInterface接口調(diào)用getNewsDetails是不行的,因此在Retrofit的create獲取網(wǎng)絡(luò)接口的動態(tài)代理晶伦,在執(zhí)行networkInterface的getNewDetails方法時碟狞,通過動態(tài)代理攔截,并執(zhí)行動態(tài)代理對象內(nèi)InvocationHandler中的invoke方法婚陪,將OkHttpCall轉(zhuǎn)換成RxJava平臺的適用的Call族沃,而這個OkHttpCall對象是對OkHttp網(wǎng)絡(luò)庫的封裝,最后返回OkHttpCall類型的Call對象近忙,有了這個Call對象就可以進(jìn)行同步或異步請求竭业,OkHttpCall內(nèi)提供了同步請求方法execute和異步請求方法enqueue,接著下來重點(diǎn)分析這兩個方法及舍。

在Retrofit同步請求流程中未辆,首先需要對網(wǎng)絡(luò)請求接口中方法以及參數(shù)進(jìn)行解析,通過ParameterHandler進(jìn)行解析锯玛,然后根據(jù)ServiceMethod對象創(chuàng)建OkHttp的Request對象咐柜,ServiceMethod對象內(nèi)部包含了網(wǎng)絡(luò)請求的所有信息,它是對網(wǎng)絡(luò)接口方法的封裝攘残,有了Request對象后就可以通過OkHttp這個庫來進(jìn)行網(wǎng)絡(luò)請求拙友,最后解析服務(wù)端給客戶端返回的數(shù)據(jù),通過converter數(shù)據(jù)轉(zhuǎn)換器來完成數(shù)據(jù)的轉(zhuǎn)換歼郭。

OkHttpCall的同步請求execute方法:

    @Override public Response<T> execute() throws IOException {
        okhttp3.Call call;

        synchronized (this) {
            if (executed) throw new IllegalStateException("Already executed.");
            executed = true;

            if (creationFailure != null) {
                if (creationFailure instanceof IOException) {
                    throw (IOException) creationFailure;
                } else if (creationFailure instanceof RuntimeException) {
                    throw (RuntimeException) creationFailure;
                } else {
                    throw (Error) creationFailure;
                }
            }

            call = rawCall;
            if (call == null) {
                try {
                    call = rawCall = createRawCall();
                } catch (IOException | RuntimeException | Error e) {
                    throwIfFatal(e); //  Do not assign a fatal error to creationFailure.
                    creationFailure = e;
                    throw e;
                }
            }
        }

        if (canceled) {
            call.cancel();
        }

        return parseResponse(call.execute());
    }

下面貼出execute局部代碼遗契,方便分析。

    @Override public Response<T> execute() throws IOException {
        okhttp3.Call call;

        synchronized (this) {
            if (executed) throw new IllegalStateException("Already executed.");
            executed = true;

            if (creationFailure != null) {
                if (creationFailure instanceof IOException) {
                    throw (IOException) creationFailure;
                } else if (creationFailure instanceof RuntimeException) {
                    throw (RuntimeException) creationFailure;
                } else {
                    throw (Error) creationFailure;
                }
            }

            ...
        }

       ...
    }

上面代碼中一開始創(chuàng)建了一個OkHttp的call對象病曾,下面是一個同步代碼塊牍蜂,通過判斷executed是否執(zhí)行過通過請求漾根,如果執(zhí)行過就會拋出異常,接著判斷creationFailure鲫竞,不為null時辐怕,判斷異常類型并拋出異常,execute方法的前段部分就是對異常的判斷从绘。

    @Override public Response<T> execute() throws IOException {
        okhttp3.Call call;
        synchronized (this) {
            ...
            call = rawCall;
            if (call == null) {
                try {
                    call = rawCall = createRawCall();
                } catch (IOException | RuntimeException | Error e) {
                    throwIfFatal(e); //  Do not assign a fatal error to creationFailure.
                    creationFailure = e;
                    throw e;
                }
            }
        }
        ...
    }

當(dāng)沒有任何異常時寄疏,將rawCall也就是OkHttp的原生call賦值給局部變量call,當(dāng)call為null時僵井,通過createRawCall方法創(chuàng)建OkHttp的Call對象以及Request陕截。

進(jìn)入createRawCall方法:

  private okhttp3.Call createRawCall() throws IOException {
    okhttp3.Call call = serviceMethod.toCall(args);
    if (call == null) {
      throw new NullPointerException("Call.Factory returned null.");
    }
    return call;
  }

內(nèi)部通過serviceMethod的toCall方法將傳入的請求參數(shù)轉(zhuǎn)換成Call對象。

進(jìn)入serviceMethod的toCall方法:

  okhttp3.Call toCall(@Nullable Object... args) throws IOException {
    RequestBuilder requestBuilder = new RequestBuilder(httpMethod, baseUrl, relativeUrl, headers,
        contentType, hasBody, isFormEncoded, isMultipart);

    @SuppressWarnings("unchecked") // It is an error to invoke a method with the wrong arg types.
    ParameterHandler<Object>[] handlers = (ParameterHandler<Object>[]) parameterHandlers;

    ...

    for (int p = 0; p < argumentCount; p++) {
      handlers[p].apply(requestBuilder, args[p]);
    }

    return callFactory.newCall(requestBuilder.build());
  }

RequestBuilder內(nèi)部保存著網(wǎng)絡(luò)請求的相關(guān)參數(shù)驹沿,接著在for循環(huán)中通過ParameterHandler對參數(shù)進(jìn)行解析艘策,最后通過callFactory的newCall創(chuàng)建OkHttp的Call對象,newCall內(nèi)部傳入的是Request對象,通過requestBuilder.build()創(chuàng)建Request對象十籍,到這里將OkHttp的Call對象返回給execute方法內(nèi)部的成員變量call以及OkHttpCall的成員變量rawCall外盯。

    @Override public Response<T> execute() throws IOException {
        okhttp3.Call call;
        ...
        if (canceled) {
            call.cancel();
        }
        return parseResponse(call.execute());
    }

有了OkHttp的Call之后,就通過call.execute()進(jìn)行阻塞式的同步請求婴栽,并將返回的Response傳入parseResponse方法中。

進(jìn)入parseResponse方法:

    Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
        ...
        try {
            T body = serviceMethod.toResponse(catchingBody);
            return Response.success(body, rawResponse);
        } catch (RuntimeException e) {
            ...
        }
    }

只看核心代碼,通過調(diào)用serviceMethod的toResponse方法返回body合砂,進(jìn)入toResponse方法,看它到底做了哪些操作源织。

  R toResponse(ResponseBody body) throws IOException {
    return responseConverter.convert(body);
  }

原來是調(diào)用了數(shù)據(jù)轉(zhuǎn)換器將OkHttp返回的Response轉(zhuǎn)換成Java對象翩伪,這里我們使用的Gson,也就是通過Gson將服務(wù)器返回的數(shù)據(jù)轉(zhuǎn)換成我們需要的Java對象谈息,最后通過Response的success方法將返回的Java對象封裝成Response缘屹。

  Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
   ...
   return Response.success(body, rawResponse);
}

進(jìn)入Response的success方法:

  public static <T> Response<T> success(@Nullable T body, okhttp3.Response rawResponse) {
    ...
    return new Response<>(rawResponse, body, null);
  }

返回創(chuàng)建好的Response,將body也就是我們的Java對象傳過去侠仇。

Response的構(gòu)造函數(shù):

  private Response(okhttp3.Response rawResponse, @Nullable T body,
      @Nullable ResponseBody errorBody) {
    this.rawResponse = rawResponse;
    this.body = body;
    this.errorBody = errorBody;
  }

到這里大家應(yīng)該很熟悉了轻姿,我們利用Retrofit進(jìn)行網(wǎng)絡(luò)的同步或異步請求,最終會返回一個Response對象并通過response.body來獲取結(jié)果逻炊,這個body就是通過轉(zhuǎn)換器轉(zhuǎn)換好的Java對象互亮。

接下來分析異步請求:

        call.enqueue(new Callback() {
            @Override
            public void onResponse(Call call, Response response) {
                System.out.println(response.body());
            }

            @Override
            public void onFailure(Call call, Throwable t) {
                System.out.println("請求錯誤");
            }
        });

執(zhí)行異步請求的流程和同步類似,只不過異步請求的結(jié)果是通過回調(diào)來傳遞的余素,異步是通過enqueue方法來執(zhí)行的豹休,而這個Call的實(shí)現(xiàn)類是OkHttpCall,進(jìn)入OkHttpCall的enqueue方法桨吊。

OkHttpCall的enqueue方法(上半部分):

    @Override public void enqueue(final Callback<T> callback) {
        ...
        okhttp3.Call call;
        ...
        synchronized (this) {
            if (executed) throw new IllegalStateException("Already executed.");
            executed = true;

            call = rawCall;
            failure = creationFailure;
            if (call == null && failure == null) {
                try {
                    call = rawCall = createRawCall();
                } catch (Throwable t) {
                    throwIfFatal(t);
                    failure = creationFailure = t;
                }
            }
        }
        ...
    }

可以發(fā)現(xiàn)enqueue的上半部分與上面介紹同步請求時是一樣的威根,創(chuàng)建OkHttp的Call窑眯,并檢查相關(guān)異常,如果call為null医窿,就通過createRawCall方法創(chuàng)建OkHttp的Call以及請求所需要的Request磅甩。

OkHttpCall的enqueue方法(下半部分):

    @Override public void enqueue(final Callback<T> callback) {
        ...
        call.enqueue(new okhttp3.Callback() {
            @Override public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse) {
                Response<T> response;
                try {
                    response = parseResponse(rawResponse);
                } catch (Throwable e) {
                    callFailure(e);
                    return;
                }

                try {
                    callback.onResponse(OkHttpCall.this, response);
                } catch (Throwable t) {
                    t.printStackTrace();
                }
            }
            ...
        });
    }

上面這段代碼不用我講,大家也應(yīng)該知道就是通過OkHttp的Call的enqueue方法進(jìn)行異步請求姥卢,關(guān)于OkHttp相關(guān)知識可以閱讀之前寫的OkHttp分析的相關(guān)系列教程卷要,在OkHttp的Call的enqueue方法的回調(diào)方法onResponse方法中,將返回的Response通過parseResponse方法轉(zhuǎn)換成Java對象并返回Retrofit的Response對象独榴,通過前面?zhèn)魅氲腃allback對象將Response回調(diào)給客戶端僧叉。

到這里關(guān)于Retrofit網(wǎng)絡(luò)請求框架的封裝就講解完畢了!


838794-506ddad529df4cd4.webp.jpg
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末棺榔,一起剝皮案震驚了整個濱河市瓶堕,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌症歇,老刑警劉巖郎笆,帶你破解...
    沈念sama閱讀 222,681評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異忘晤,居然都是意外死亡宛蚓,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評論 3 399
  • 文/潘曉璐 我一進(jìn)店門设塔,熙熙樓的掌柜王于貴愁眉苦臉地迎上來凄吏,“玉大人,你說我怎么就攤上這事闰蛔『鄹郑” “怎么了?”我有些...
    開封第一講書人閱讀 169,421評論 0 362
  • 文/不壞的土叔 我叫張陵序六,是天一觀的道長任连。 經(jīng)常有香客問我,道長难咕,這世上最難降的妖魔是什么课梳? 我笑而不...
    開封第一講書人閱讀 60,114評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮余佃,結(jié)果婚禮上暮刃,老公的妹妹穿的比我還像新娘。我一直安慰自己爆土,他們只是感情好椭懊,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,116評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般氧猬。 火紅的嫁衣襯著肌膚如雪背犯。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,713評論 1 312
  • 那天盅抚,我揣著相機(jī)與錄音漠魏,去河邊找鬼。 笑死妄均,一個胖子當(dāng)著我的面吹牛柱锹,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播丰包,決...
    沈念sama閱讀 41,170評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼禁熏,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了邑彪?” 一聲冷哼從身側(cè)響起瞧毙,我...
    開封第一講書人閱讀 40,116評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎寄症,沒想到半個月后宙彪,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,651評論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡瘸爽,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,714評論 3 342
  • 正文 我和宋清朗相戀三年您访,在試婚紗的時候發(fā)現(xiàn)自己被綠了铅忿。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片剪决。...
    茶點(diǎn)故事閱讀 40,865評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖檀训,靈堂內(nèi)的尸體忽然破棺而出柑潦,到底是詐尸還是另有隱情,我是刑警寧澤峻凫,帶...
    沈念sama閱讀 36,527評論 5 351
  • 正文 年R本政府宣布渗鬼,位于F島的核電站,受9級特大地震影響荧琼,放射性物質(zhì)發(fā)生泄漏譬胎。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,211評論 3 336
  • 文/蒙蒙 一命锄、第九天 我趴在偏房一處隱蔽的房頂上張望堰乔。 院中可真熱鬧,春花似錦脐恩、人聲如沸镐侯。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,699評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽苟翻。三九已至韵卤,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間崇猫,已是汗流浹背沈条。 一陣腳步聲響...
    開封第一講書人閱讀 33,814評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留诅炉,地道東北人拍鲤。 一個月前我還...
    沈念sama閱讀 49,299評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像汞扎,于是被迫代替她去往敵國和親季稳。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,870評論 2 361

推薦閱讀更多精彩內(nèi)容