csdn ：碼小白
原文地址：
http://blog.csdn.net/sk719887916/article/details/51958010

RetrofitClient

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

避免重複創建Retrofit實列.
調用方便簡潔.
無需重複設置屬性的步驟.
可固定配置 Host 也可動態配置Url、請求頭、參數等.
支持文件下載和上傳.
可支持泛型擴展的ApiService
支持RxJava
支持緩存機制
支持統一錯誤結果處理

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

                        }
                    });

總結

本次封裝只對retrofit進行了簡單封裝，很多場景和需求還是存在缺陷，這種單列模式已不符合目前流行的Builder模式，本人已開始進行下一步的封裝工作，在這裏提前進行下預告：
筆者已進行新的框架開發novate，估計下個月就能和大家見面，敬請繼續關注！

系列導讀：

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

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

Android基於Retrofit2.0 +RxJava 封裝的超好用的RetrofitClient工具類（六）

RetrofitClient

ApiService

構建基礎攔截器

構建Cookie管理者

調用 RetrofitClient

總結

985 碩士程序員，空窗 4 個月沒有 Offer！

【入門教程】5分鐘教你快速學會集成Java springboot ~

營銷系統黑名單優化：位圖的應用解析

一文搞懂 Spring 循環依賴

我真的從測試轉成了開發......

盛大發布 | Zabbix 7.0 LTS--性能與擴展的卓越融合

nginx添加相應配置，通過瀏覽器訪問或curl時返回客戶端對應公網IP

賽博鬥地主——使用大語言模型扮演Agent智能體玩牌類遊戲。

python內置函數——sorted

[oeasy]python020在遊戲中體驗數值自由_勇闖地下城_終端文字遊戲

大學四年，我是如何學習編程的？

微信小程序開發(四) 後臺開發詳解, 二維碼生成，推送消息，微信支付

Flutter 的渲染邏輯及和 Native 通信（四）

Flutter 熱修復, 熱更新，動態化實現

程序員外包怎麼了？

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結