Android中Retrofit源碼如何使用

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)Android 中Retrofit源碼如何使用，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

廣陵網(wǎng)站建設(shè)公司成都創(chuàng)新互聯(lián),廣陵網(wǎng)站設(shè)計(jì)制作，有大型網(wǎng)站制作公司豐富經(jīng)驗(yàn)。已為廣陵上1000+提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\外貿(mào)網(wǎng)站建設(shè)要多少錢，請(qǐng)找那個(gè)售后服務(wù)好的廣陵做網(wǎng)站的公司定做！

簡(jiǎn)介

Retrofit 是 Square 推出的 HTTP 框架，主要用于 Android 和 Java。Retrofit  將網(wǎng)絡(luò)請(qǐng)求變成方法的調(diào)用，使用起來(lái)非常簡(jiǎn)潔方便。本文先簡(jiǎn)要介紹一下 Retrofit 的用法，然后具體分析其源碼執(zhí)行的流程。

基本用法

Retrofit 把HTTP API 變成 Java 的接口。下面是 Retrofit 官網(wǎng)的一個(gè)例子：

public interface GitHubService {   @GET("users/{user}/repos")   Call<List<Repo>> listRepos(@Path("user") String user); }

在 GithubService 接口中有一個(gè)方法 listRepos，這個(gè)方法用了 @GET 的方式注解，這表明這是一個(gè) GET  請(qǐng)求。在后面的括號(hào)中的users/{user}/repos 是請(qǐng)求的路徑，其中的 {user}  表示的是這一部分是動(dòng)態(tài)變化的，它的值由方法的參數(shù)傳遞過(guò)來(lái)，而這個(gè)方法的參數(shù)@Path("user") String user 即是用于替換 {user}  。另外注意這個(gè)方法的返回值是 Call<List<Repo>>?？梢钥闯?Retrofit  用注解的方式來(lái)描述一個(gè)網(wǎng)絡(luò)請(qǐng)求相關(guān)的參數(shù)。

上面才是開(kāi)始，下面要發(fā)出這個(gè)網(wǎng)絡(luò)請(qǐng)求：

Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/") .addConverterFactory(GsonConverterFactory.create()) .build();  GitHubService service = retrofit.create(GitHubService.class); Call<List<Repo>> repos = service.listRepos("octocat"); repos.enqueue(new Callback<List<Repo>>() {     @Override     public void onResponse(Call<List<Repo>> call, Response<List<Repo>> response) {                  }     @Override     public void onFailure(Call<List<Repo>> call, Throwable t) {      }  });

可以看出，先是構(gòu)建了一個(gè) Retrofit 對(duì)象，其中傳入了 baseUrl 參數(shù)，baseUrl 和上面的 GET 方法后面的路徑組合起來(lái)才是一個(gè)完整的  url。除了 baseUrl，還有一個(gè) converterFactory，它是用于把返回的 http response 轉(zhuǎn)換成 Java  對(duì)象，對(duì)應(yīng)方法的返回值Call<List<Repo>> 中的 List<Repo>>，其中 Repo  是自定義的類。有了Retrofit 對(duì)象，接著調(diào)用它的 create 方法創(chuàng)建了GitHubService  的實(shí)例，然后就可以調(diào)用這個(gè)實(shí)例的方法來(lái)請(qǐng)求網(wǎng)絡(luò)了。調(diào)用 listRepo 方法得到一個(gè) Call對(duì)象，然后可以使用enqueue 或者 execute  來(lái)執(zhí)行發(fā)起請(qǐng)求，enqueue 是是異步執(zhí)行，而 execute 是同步執(zhí)行。

Retrofit 的基本用法就是這樣，其它還有一些細(xì)節(jié)可以查看官網(wǎng)。

源碼分析

我***次接觸 Retrofit 的時(shí)候覺(jué)得這個(gè)東西挺神奇的，用法跟一般的網(wǎng)絡(luò)請(qǐng)求不一樣。下面就來(lái)看看 Retrofit 的源碼是怎么實(shí)現(xiàn)的。

Retrofit 的創(chuàng)建

從 Retrofit 的創(chuàng)建方法可以看出，使用的是 Builder 模式。Retrofit 中有如下的幾個(gè)關(guān)鍵變量：

//用于緩存解析出來(lái)的方法  private final Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();    //請(qǐng)求網(wǎng)絡(luò)的OKHttp的工廠，默認(rèn)是 OkHttpClient  private final okhttp3.Call.Factory callFactory;    //baseurl  private final HttpUrl baseUrl;    //請(qǐng)求網(wǎng)絡(luò)得到的response的轉(zhuǎn)換器的集合 默認(rèn)會(huì)加入 BuiltInConverters       private final List<Converter.Factory> converterFactories;    //把Call對(duì)象轉(zhuǎn)換成其它類型  private final List<CallAdapter.Factory> adapterFactories;    //用于執(zhí)行回調(diào) Android中默認(rèn)是 MainThreadExecutor  private final Executor callbackExecutor;    //是否需要立即解析接口中的方法  private final boolean validateEagerly;

再看一下Retrofit 中的內(nèi)部類 Builder 的 builder 方法：

public Retrofit build() {   if (baseUrl == null) {     throw new IllegalStateException("Base URL required.");   }    okhttp3.Call.Factory callFactory = this.callFactory;   if (callFactory == null) {     //默認(rèn)創(chuàng)建一個(gè) OkHttpClient     callFactory = new OkHttpClient();   }    Executor callbackExecutor = this.callbackExecutor;   if (callbackExecutor == null) {      //Android 中返回的是 MainThreadExecutor     callbackExecutor = platform.defaultCallbackExecutor();   }    // Make a defensive copy of the adapters and add the default Call adapter.   List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);   adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));    // Make a defensive copy of the converters.   List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);    return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,       callbackExecutor, validateEagerly); }

在創(chuàng)建 Retrofit 的時(shí)候，如果沒(méi)有指定 OkHttpClient，會(huì)創(chuàng)建一個(gè)默認(rèn)的。如果沒(méi)有指定  callbackExecutor，會(huì)返回平臺(tái)默認(rèn)的，在 Android 中是 MainThreadExecutor，并利用這個(gè)構(gòu)建一個(gè)  CallAdapter加入 adapterFactories。

create 方法

有了 Retrofit 對(duì)象后，便可以通過(guò) create 方法創(chuàng)建網(wǎng)絡(luò)請(qǐng)求接口類的實(shí)例，代碼如下：

public <T> T create(final Class<T> service) { Utils.validateServiceInterface(service); if (validateEagerly) {   //提前解析方法   eagerlyValidateMethods(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, Object... args)           throws Throwable {         // If the method is a method from Object then defer to normal invocation.如果是Object中的方法，直接調(diào)用         if (method.getDeclaringClass() == Object.class) {           return method.invoke(this, args);         }         //為了兼容 Java8 平臺(tái)，Android 中不會(huì)執(zhí)行         if (platform.isDefaultMethod(method)) {           return platform.invokeDefaultMethod(method, service, proxy, args);         }         //下面是重點(diǎn)，解析方法         ServiceMethod serviceMethod = loadServiceMethod(method);         OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);         return serviceMethod.callAdapter.adapt(okHttpCall);       } });

create 方法接受一個(gè) Class 對(duì)象，也就是我們編寫的接口，里面含有通過(guò)注解標(biāo)識(shí)的請(qǐng)求網(wǎng)絡(luò)的方法。注意 return 語(yǔ)句部分，這里調(diào)用了  Proxy.newProxyInstance  方法，這個(gè)很重要，因?yàn)橛昧藙?dòng)態(tài)代理模式。關(guān)于動(dòng)態(tài)代理模式，可以參考這篇文章：http://www.codekk.com/blogs/d...。簡(jiǎn)單的描述就是，Proxy.newProxyInstance  根據(jù)傳進(jìn)來(lái)的 Class 對(duì)象生成了一個(gè)實(shí)例 A，也就是代理類。每當(dāng)這個(gè)代理類 A 執(zhí)行某個(gè)方法時(shí)，總是會(huì)調(diào)用  InvocationHandler(Proxy.newProxyInstance 中的第三個(gè)參數(shù)) 的invoke  方法，在這個(gè)方法中可以執(zhí)行一些操作(這里是解析方法的注解參數(shù)等)，通過(guò)這個(gè)方法真正的執(zhí)行我們編寫的接口中的網(wǎng)絡(luò)請(qǐng)求。

方法解析和類型轉(zhuǎn)換

下面具體看一下在 invoke 中解析網(wǎng)絡(luò)請(qǐng)求方法的幾行。首先是 ServiceMethod serviceMethod =  loadServiceMethod(method);，其中 loadServiceMethod 代碼如下：

ServiceMethod loadServiceMethod(Method method) {     ServiceMethod result;     synchronized (serviceMethodCache) {       result = serviceMethodCache.get(method);       if (result == null) {         result = new ServiceMethod.Builder(this, method).build();         serviceMethodCache.put(method, result);       }     }     return result; }

可以看出，這里是先到緩存中找，緩存中沒(méi)有再去創(chuàng)建。這里創(chuàng)建了 ServiceMethod 對(duì)象。ServiceMethod 用于把接口方法的調(diào)用轉(zhuǎn)換成一個(gè)  HTTP 請(qǐng)求。其實(shí)，在 ServiceMethod 中，會(huì)解析接口中方法的注解、參數(shù)等，它還有個(gè) toRequest 方法，用于生成一個(gè) Request  對(duì)象。這個(gè) Request 對(duì)象就是 OkHttp 中的 Request，代表了一條網(wǎng)絡(luò)請(qǐng)求(Retrofit 實(shí)際上把真正請(qǐng)求網(wǎng)絡(luò)的操作交給了 OkHttp  執(zhí)行)。下面是創(chuàng)建 ServiceMethod 的部分代碼：

public ServiceMethod build() {   //獲取 callAdapter   callAdapter = createCallAdapter();   responseType = callAdapter.responseType();   if (responseType == Response.class || responseType == okhttp3.Response.class) {     throw methodError("'"         + Utils.getRawType(responseType).getName()         + "' is not a valid response body type. Did you mean ResponseBody?");   }   //獲取 responseConverter    responseConverter = createResponseConverter();    for (Annotation annotation : methodAnnotations) {     //解析注解     parseMethodAnnotation(annotation);     //省略了一些代碼     ...   } }

在得到 ServiceMethod 對(duì)象后，把它連同方法調(diào)用的相關(guān)參數(shù)傳給了 OkHttpCall 對(duì)象，也就是這行代碼： OkHttpCall  okHttpCall = new OkHttpCall<>(serviceMethod, args);。 下面介紹  OkHttpCall，OkHttpCall繼承于 Call 接口。Call 是Retrofit  的基礎(chǔ)接口，代表發(fā)送網(wǎng)絡(luò)請(qǐng)求與響應(yīng)調(diào)用，它包含下面幾個(gè)接口方法：

  • Response<T> execute() throws IOException; //同步執(zhí)行請(qǐng)求

  • void enqueue(Callback<T> callback); //異步執(zhí)行請(qǐng)求，callback 用于回調(diào)

  • boolean isExecuted(); //是否執(zhí)行過(guò)

  • void cancel(); //取消請(qǐng)求

  • boolean isCanceled(); //是否取消了

  • Call<T> clone(); //克隆一條請(qǐng)求

  • Request request(); //獲取原始的request

OkHttpCall 是 Call 的一個(gè)實(shí)現(xiàn)類，它里面封裝了 OkHttp 中的原生 Call，在這個(gè)類里面實(shí)現(xiàn)了 execute 以及 enqueue  等方法，其實(shí)是調(diào)用了 OkHttp 中原生 Call 的對(duì)應(yīng)方法。

接下來(lái)把 OkHttpCall 傳給 serviceMethod.callAdapter 對(duì)象，這里的callAdapter又是什么?在上面創(chuàng)建  ServiceMethod 的代碼中有一行代碼： callAdapter = createCallAdapter()，這里創(chuàng)建了  calladapter，在這個(gè)代碼內(nèi)部是根據(jù)方法的返回類型以及注解去尋找對(duì)應(yīng)的 CallAdapter，去哪里尋找?去 Retrofit 對(duì)象的  adapterFactories 集合中找。當(dāng)我們創(chuàng)建 Retrofit 的時(shí)候，可以調(diào)用 addCallAdapter 向 adapterFactories  中添加 CallAdapter。在前面的基本用法里面，我們并沒(méi)有添加任何 CallAdapter，但adapterFactories 中默認(rèn)會(huì)添加一個(gè)  ExecutorCallAdapterFactory，調(diào)用其 get 方法便可獲得 CallAdapter 對(duì)象。

那么 CallAdapter 是干嘛的呢?上面調(diào)用了adapt 方法，它是為了把一個(gè) Call 轉(zhuǎn)換成另一種類型，比如當(dāng) Retrofit 和  RxJava 結(jié)合使用的時(shí)候，接口中方法可以返回 Observable<T>，這里相當(dāng)于適配器模式。默認(rèn)情況下得到的是一個(gè) Call  對(duì)象，它是ExecutorCallbackCall，代碼如下：

public CallAdapter<Call<?>> get(Type returnType, Annotation[] annotations, Retrofit retrofit) { if (getRawType(returnType) != Call.class) {   return null; } final Type responseType = Utils.getCallResponseType(returnType); return new CallAdapter<Call<?>>() {   @Override public Type responseType() {     return responseType;   }    @Override public <R> Call<R> adapt(Call<R> call) {     return new ExecutorCallbackCall<>(callbackExecutor, call);   } }; }

這個(gè) ExecutorCallbackCall 接受一個(gè) callbackExecutor(Android 中默認(rèn)為  MainThreadExecutor，把返回的數(shù)據(jù)傳回主線程) 和一個(gè) call，也就是 OkhttpCall?？聪?ExecutorCallbackCall  部分代碼：

static final class ExecutorCallbackCall<T> implements Call<T> { final Executor callbackExecutor; final Call<T> delegate;  ExecutorCallbackCall(Executor callbackExecutor, Call<T> delegate) {   this.callbackExecutor = callbackExecutor;   this.delegate = delegate; }  @Override public void enqueue(final Callback<T> callback) {   if (callback == null) throw new NullPointerException("callback == null");    delegate.enqueue(new Callback<T>() {     @Override public void onResponse(Call<T> call, final Response<T> response) {       callbackExecutor.execute(new Runnable() {         @Override public void run() {           if (delegate.isCanceled()) {             // Emulate OkHttp's behavior of throwing/delivering an IOException on cancellation.             callback.onFailure(ExecutorCallbackCall.this, new IOException("Canceled"));           } else {             callback.onResponse(ExecutorCallbackCall.this, response);           }         }       });     }      @Override public void onFailure(Call<T> call, final Throwable t) {       callbackExecutor.execute(new Runnable() {         @Override public void run() {           callback.onFailure(ExecutorCallbackCall.this, t);         }       });     }   }); }

在 enqueue 方法中，調(diào)用了 OkHttpCall 的 enqueue，所以這里相當(dāng)于靜態(tài)的代理模式。OkHttpCall 中的 enqueue  其實(shí)又調(diào)用了原生的 OkHttp 中的 enqueue，這里才真正發(fā)出了網(wǎng)絡(luò)請(qǐng)求，部分代碼如下：

@Override public void enqueue(final Callback<T> callback) {     if (callback == null) throw new NullPointerException("callback == null");     //真正請(qǐng)求網(wǎng)絡(luò)的 call     okhttp3.Call call;     Throwable failure;      synchronized (this) {       if (executed) throw new IllegalStateException("Already executed.");       executed = true;       //省略了部分發(fā)代碼       ...       call = rawCall;       //enqueue 異步執(zhí)行     call.enqueue(new okhttp3.Callback() {       @Override public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse)           throws IOException {         Response<T> response;         try {         //解析數(shù)據(jù) 會(huì)用到 conveterFactory，把 response 轉(zhuǎn)換為對(duì)應(yīng) Java 類型           response = parseResponse(rawResponse);         } catch (Throwable e) {           callFailure(e);           return;         }         callSuccess(response);       }        @Override public void onFailure(okhttp3.Call call, IOException e) {         try {           callback.onFailure(OkHttpCall.this, e);         } catch (Throwable t) {           t.printStackTrace();         }       }    private void callFailure(Throwable e) {     try {       callback.onFailure(OkHttpCall.this, e);     } catch (Throwable t) {       t.printStackTrace();     }   }    private void callSuccess(Response<T> response) {     try {       callback.onResponse(OkHttpCall.this, response);     } catch (Throwable t) {       t.printStackTrace();     }   }  }); }

OkHttp 獲取數(shù)據(jù)后，解析數(shù)據(jù)并回調(diào)callback響應(yīng)的方法，一次網(wǎng)絡(luò)請(qǐng)求便完成了。

上述就是小編為大家分享的Android 中Retrofit源碼如何使用了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。

分享標(biāo)題：Android中Retrofit源碼如何使用
本文鏈接：http://bm7419.com/article30/jjsopo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供云服務(wù)器、響應(yīng)式網(wǎng)站、靜態(tài)網(wǎng)站、用戶體驗(yàn)、網(wǎng)站策劃、網(wǎng)站營(yíng)銷

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)

網(wǎng)站托管運(yùn)營(yíng)