csdn ：碼小白

原文位址：

http://blog.csdn.net/sk719887916/article/details/51958010

Android基于Retrofit2.0 +RxJava 封裝的超好用的RetrofitClient工具類（六）RetrofitClientApiService建構基礎攔截器建構Cookie管理者調用 RetrofitClient總結

RetrofitClient

基于Retrofit2.0封裝的RetrofitClient. 已加入RxJava1, Rxjav2請看 - RxJava2和Retrofit封裝的RetrofitClient2終于來了！一文。

避免重複建立Retrofit實列.
調用友善簡潔.
無需重複設定屬性的步驟.
可固定配置 Host 也可動态配置Url、請求頭、參數等.
支援檔案下載下傳和上傳.
可支援泛型擴充的ApiService
支援RxJava
支援緩存機制
支援統一錯誤結果處理

使用原生的Retrofit請求網絡，熟悉的朋友必定了解，在某個ApiServie方法多時 Retrofit設定就顯得有點累贅，今天給大家帶來對Retrofit的基本封裝。這次對Retrofit進階篇，本次封裝已加入RxJava，請在閱讀下文前請先了解RXJAVA和本人寫的Retrofit系列文章，

友情導讀：

RxJava2和Retrofit封裝的RetrofitClient2終于來了！
Retrofit 2.0

超能實踐，完美支援Https傳輸
Retrofit2.0

完美同步Cookie實作免登入
Retrofit 2.0 超能實踐（三），輕松實作檔案/圖檔上傳
基于Retrofit2.0 封裝的超好用的RetrofitClient工具類
玩轉IOC，教你徒手實作自定義的Retrofit架構

基本步驟：

建構Retrofit的接口service.

建構基礎攔截器 Interceptor.

建構Cookie管理工具CookieManger.

建構單列RetrofitClient用戶端.

RetrofitClient的使用.

ApiService

請求網絡的API接口類，這裡你可以增加你需要的請求接口，也可複用已經實作的幾個方法。

/**
 * Created by Ｔａｍｉｃ on 2016-07-08.
 */
 public interface ApiService {

  public static final String Base_URL = "http://ip.taobao.com/";
  /**
  *普通寫法
  */
 @GET("service/getIpInfo.php/")
 Observable<ResponseBody> getData(@Query("ip") String ip);

 @GET("{url}")
 Observable<ResponseBody> executeGet(
        @Path("url") String url, 
        @QueryMap Map<String, String> maps);


@POST("{url}")
Observable<ResponseBody> executePost(
        @Path("url") String url,
        @QueryMap Map<String, String> maps);

@Multipart
@POST("{url}")
Observable<ResponseBody> upLoadFile(
        @Path("url") String url,
        @Part("image\\\\"; filename=\\"image.jpg") RequestBody avatar);


@POST("{url}")
Observable<ResponseBody> uploadFiles(
        @Path("url") String url,
        @Path("headers") Map<String, String> headers,
        @Part("filename") String description,
        @PartMap()  Map<String, RequestBody> maps);
        
 @Streaming
 @GET
 Observable<ResponseBody> downloadFile(@Url String fileUrl);

}

上面新增了幾個常用的請求方法

第一個隻是普通寫法的列子, url ,請求頭，參數都是寫死的。不建議這麼做

第二，三個分别是Get 和POST請求，method Url,headers, body參數都可以動态外部傳入。

四和五是單檔案/圖檔和多檔案/圖檔上傳

最後是檔案下載下傳

如果你覺得麻煩可以用T代替，技術不到位的悠着點哈

@GET()
<T> Observable<ResponseBody> executeGet(
        @Url String url,
        @QueryMap Map<String, T> maps);

建構基礎攔截器

用來設定基礎header，這裡是通過MAP鍵值對來建構，将heder加入到Request中。

/**
 * BaseInterceptor，use set okhttp call header
 * Created by Tamic on 2016-06-30.
 */
public class BaseInterceptor implements Interceptor{

   private Map<String, String> headers;

   public BaseInterceptor(Map<String, String> headers) {
      this.headers = headers;
    }

   @Override
   public Response intercept(Chain chain) throws    IOException {

    Request.Builder builder = chain.request()
            .newBuilder();
    if (headers != null && headers.size() > 0) {
        Set<String> keys = headers.keySet();
        for (String headerKey : keys) {
            builder.addHeader(headerKey,      headers.get(headerKey)).build();
        }
    }
    return chain.proceed(builder.build());

 }
}

建構Cookie管理者

用來管理cookie, 儲存cookie的store這裡不再重複說明，具體列子請見:

public class NovateCookieManger implements CookieJar {

private static final String TAG = "NovateCookieManger";
private static Context mContext;
private static PersistentCookieStore cookieStore;

/**
 * Mandatory constructor for the NovateCookieManger
 */
public NovateCookieManger(Context context) {
    mContext = context;
    if (cookieStore == null) {
        cookieStore = new PersistentCookieStore(mContext);
    }
}

@Override
public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
    if (cookies != null && cookies.size() > 0) {
        for (Cookie item : cookies) {
            cookieStore.add(url, item);
        }
    }
}

@Override
public List<Cookie> loadForRequest(HttpUrl url) {
    List<Cookie> cookies = cookieStore.get(url);
    return cookies;
}
}

#建構RetrofitClient用戶端.

今天重要的環節來了，RetrofitClient主要負責建立具體Retrofit，和排程分發請求。設定格式工廠。添加cookie同步，建構OkHttpClient，添加BaseUrl,對加密證書https我沒做加入，希望讀者參考我的本系列文章自行加入，因為我不喜歡升伸手黨。

/**
 * RetrofitClient
 * Created by Tamic on 2016-06-15.
 */
public class RetrofitClient {

private static final int DEFAULT_TIMEOUT = 5;

private ApiService apiService;

private OkHttpClient okHttpClient;

public static String baseUrl = ApiService.Base_URL;

private static Context mContext;

private static RetrofitClient sNewInstance;
private static class SingletonHolder {
    private static RetrofitClient INSTANCE = new RetrofitClient(
            mContext);
}

public static RetrofitClient getInstance(Context context) {
    if (context != null) {
        Log.v("RetrofitClient", DevUtil.isDebug() + "");
        mContext = context;
    }
    return SingletonHolder.INSTANCE;
}


public static RetrofitClient getInstance(Context context, String url) {
    if (context != null) {
        mContext = context;
    }
    sNewInstance = new RetrofitClient(context, url);
    return sNewInstance;
}

private RetrofitClient(Context context) {

    this(context, null);
}

private RetrofitClient(Context context, String url) {

    if (TextUtils.isEmpty(url)) {
        url = baseUrl;
    }
    okHttpClient = new OkHttpClient.Builder()
            .addNetworkInterceptor(
                    new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.HEADERS))
            .cookieJar(new NovateCookieManger(context))
            .addInterceptor(new BaseInterceptor(mContext))
            .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
            .build();
    Retrofit retrofit = new Retrofit.Builder()
            .client(okHttpClient)
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
            .baseUrl(url)
            .build();
    apiService = retrofit.create(ApiService.class);
}

public void getData(Subscriber<ResponseBody> subscriber, String ip) {
    apiService.getData(ip)
            .subscribeOn(Schedulers.io())
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

public void get(String url, Map headers, Map parameters, Subscriber<ResponseBody> subscriber) {
    apiService.executeGet(url, headers, parameters)
            .subscribeOn(Schedulers.io())
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

public void post(String url, Map headers, Map parameters, Subscriber<ResponseBody> subscriber) {
    apiService.executePost(url, headers, parameters)
            .subscribeOn(Schedulers.io())
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

}

大家發現上面的指定生産線程和消費線程的步驟有點麻煩，每個api都得進行指定線程，那麼可以利用rxJava的轉換器寫一個

Transformer

Observable.Transformer schedulersTransformer() {
  return new Observable.Transformer() {


  @Override
  public Object call(Object observable) {
   return ((Observable)  observable).subscribeOn(Schedulers.io())
   .unsubscribeOn(Schedulers.io())
   .observeOn(AndroidSchedulers.mainThread());
   }
   };
}

那麼api可以這樣優化了：

public Subscription getData(Subscriber<IpResult> subscriber, String ip) {
   return apiService.getData(ip)
   .compose(schedulersTransformer())
   .subscribe(subscriber);
  }

調用 RetrofitClient

RetrofitClient.getInstance(MainActivity.this).createBaseApi().getData(new BaseSubscriber<IpResult>(MainActivity.this) {

                @Override
                public void onError(ResponeThrowable e) {
                    Log.e("Lyk", e.code + " "+ e.message);
                    Toast.makeText(MainActivity.this, e.message, Toast.LENGTH_LONG).show();

                }

                @Override
                public void onNext(IpResult responseBody) {
                    Toast.makeText(MainActivity.this, responseBody.toString(), Toast.LENGTH_LONG).show();
                }
            }, "21.22.11.33");

代碼很簡潔，在用到的地方擷取單列直接調用你需要的方法，在RxSubscriber回調中處理你的業務邏輯即可，無需考慮是否在主線程，其他調用方法同上。

很多時候BaseApiService無法滿足需求時，Retrofit增加了擴充接口

create

來建立你的API，接着調用execute就可以和RxJava關聯

//create  you APiService
 MyApiService service = RetrofitClient.getInstance(MainActivity.this).create(MyApiService.class);

            // execute and add observable
            RetrofitClient.getInstance(MainActivity.this, "http://lbs.sougu.net.cn/").execute(
                    service.getSougu(), new BaseSubscriber<SouguBean>(MainActivity.this) {

                        @Override
                        public void onError(ResponeThrowable e) {
                            Log.e("Tamic", e.getMessage());
                            Toast.makeText(MainActivity.this, e.getMessage(), Toast.LENGTH_LONG).show();

                        }
                        @Override
                        public void onNext(SouguBean souguBean) {

                            Toast.makeText(MainActivity.this, souguBean.toString(), Toast.LENGTH_LONG).show();

                        }
                    });

Android基于Retrofit2.0 +RxJava 封裝的超好用的RetrofitClient工具類（六）RetrofitClientApiService建構基礎攔截器建構Cookie管理者調用 RetrofitClient總結

總結

本次封裝隻對retrofit進行了簡單封裝，很多場景和需求還是存在缺陷，這種單列模式已不符合目前流行的Builder模式，本人已開始進行下一步的封裝工作，在這裡提前進行下預告：

筆者已進行新的架構開發novate，估計下個月就能和大家見面，敬請繼續關注！

系列導讀：

Retrofit 2.0(一) 超能實踐，完美支援Https傳輸
Retrofit2.0（二）完美同步Cookie實作免登入
Retrofit 2.0 超能實踐（三），輕松實作檔案/圖檔上傳
Retrofit 2.0 超能實踐（四），完成大檔案斷點下載下傳
基于Retrofit2.0+RxJava 封裝的超好用的RetrofitClient工具類（六）
玩轉IOC，教你徒手實作自定義的Retrofit架構（七）
Retrofit，Okhttp對每個Request統一動态添加header和參數（五）
Rxjava和Retrofit 需要掌握的幾個實用技巧,緩存問題和統一對有無網絡處理問題（八）
Novate：對Retrofit2.0的又一次完美改進加強！（九）

源碼 GitHub :https://github.com/NeglectedByBoss/RetrofitClient

作者：Tamic 更多原創關注開發者技術前線

Android基于Retrofit2.0 +RxJava 封裝的超好用的RetrofitClient工具類（六）RetrofitClientApiService建構基礎攔截器建構Cookie管理者調用 RetrofitClient總結

Android基于Retrofit2.0 +RxJava 封裝的超好用的RetrofitClient工具類（六）RetrofitClientApiService建構基礎攔截器建構Cookie管理者調用 RetrofitClient總結

RetrofitClient

ApiService

建構基礎攔截器

建構Cookie管理者

調用 RetrofitClient

總結

繼續閱讀

阿裡巴巴分布式服務架構Dubbo介紹引言SOA化服務架構DubboDubbo的主要特點

Dubbo：來自于阿裡巴巴的分布式服務架構 Dubbo：來自于阿裡巴巴的分布式服務架構

Android MVP架構MVCMVP

mvp初探

Android常用工具類簡介目錄

android常用工具類轉載自：http://www.trinea.cn/android/android-common-utils/Android常用工具類

Android常用工具類ToastUtilsSizeUtilsLogUtilsRetrofitManagerAnimUtil

Android Studio 0.8.0解決 Failure [INSTALL_FAILED_OLDER_SDK] 問題

Android – ListView 中添加按鈕，動态删除添加ItemView的操作

Kotlin的ListView與RecyclerView的簡單應用

關于公司的那些坑：Android Studio篇

android SQLite事務和kotlin協程

無法正常編譯錯誤Compilation failed to complete

關于Gradle配置的小結

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Android APK檔案反編譯Android APK檔案反編譯