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)部的一些成員變量,其實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的實現(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,這也驗證之前所說的內(nèi)部會通過OkHttp來實現(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平臺。

回到一開始的實例代碼:

    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,接著下來重點分析這兩個方法。

在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的實現(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)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容