Android 之路 (3) - 對Retrofit的封裝

Retrofit · 發表 2018-10-10 19:10:03

摘要：引言上篇中實現了MVP的改造，但是我們的網路請求部分任然是比較冗餘了，本篇將對Retrofit進行封裝。正文思路對Retrofit進行封裝算是我們基礎框架的一部分，所以我們需要將這部分程式碼封裝到 library-core 中，對於封裝的實現思路如下：將R...

引言

上篇中實現了MVP的改造，但是我們的網路請求部分任然是比較冗餘了，本篇將對Retrofit進行封裝。

正文

思路

對Retrofit進行封裝算是我們基礎框架的一部分，所以我們需要將這部分程式碼封裝到 library-core 中，對於封裝的實現思路如下：

將Retrofit的建立更改為單例模式建立，增加可配置性，減少重複建立
將Service的建立也更改為單例模式

建立NetConfiger介面

既然是作為基礎框架的一部分，那麼在設計上面就需要高自由可配置，所以我們建立一個 NetConfiger 介面，用來進行 baseUrl、攔截器、超時時間、debug等的配置、然後在 Application 中進行配置，具體看以下程式碼：

**
 * 網路配置器
 * <p>在Application中使用</p>
 */
public interface NetConfiger {
/**
* 通用請求地址
*
* @return
*/
String configBaseUrl();

/**
* 攔截器
*
* @return
*/
Interceptor[] configInterceptors();

/**
* 連線超時時間
*
* @return
*/
long configConnectTimeoutMills();

/**
* 讀取超時時間
*
* @return
*/
long configReadTimeoutMills();


/**
* 是否除錯模式
*
* @return
*/
boolean configLogEnable();
}

建立BaseApi

建立BaseApi類，主要用來做Retrofit的生成和OkhttpClient的配置等，先看程式碼：

/**
 * 基類API
 */
public class BaseApi {
/**
* 網路配置項
*/
private static NetConfig mConfig = null;
/**
* mRetrofit
*/
private Retrofit mRetrofit;
/**
* mClient
*/
private OkHttpClient mClient;
/**
* 預設連線超時時間
*/
private static final long DEFAULT_CONNECT_TIMEOUT_MILLS = 40 * 1000L;
/**
* 預設讀取超時時間
*/
private static final long DEFAULT_READ_TIMEOUT_MILLS = 40 * 1000L;
/**
* 例項
**/
private static BaseApi instance;

private BaseApi() {
mRetrofit = null;
mClient = null;
}


/**
* 建立 Retrofit
*
* @return Retrofit
*/
public static synchronized Retrofit createRetrofit() {
return getInstance().getRetrofit();
}


/**
* 單例 獲取
*
* @return BaseApi
*/
private static synchronized BaseApi getInstance() {
if (instance == null)
instance = new BaseApi();
return instance;
}


/**
* 建立class
*
* @param service 服務class
* @param <C>類泛型
* @return 泛型
*/
public static <C> C get(Class<C> service) {
return getInstance().getRetrofit().create(service);
}


/**
* 註冊配置
*
* @param config
*/
public static void registerConfig(NetConfig config) {
BaseApi.mConfig = config;
//賦值為空
instance = null;
}


/**
* 獲取Retrofit
*
* @return 獲取Retrofit
*/
public Retrofit getRetrofit() {
if (mRetrofit == null) {
Retrofit.Builder builder = new Retrofit.Builder()
.baseUrl(mConfig.configBaseUrl())//配置BaseUrl
.client(getHttpClient())// 設定client
.addConverterFactory(GsonConverterFactory.create());//gson轉換器
builder.addCallAdapterFactory(RxJava2CallAdapterFactory.create());
mRetrofit = builder.build();
}
return mRetrofit;
}


/**
* 獲取httpclient
*
* @return OkHttpClient
*/
private OkHttpClient getHttpClient() {
if (mClient == null) {
OkHttpClient.Builder builder = new OkHttpClient.Builder();

// 連線超時時間
builder.connectTimeout(mConfig.configConnectTimeoutMills() != 0
? mConfig.configConnectTimeoutMills()
: DEFAULT_CONNECT_TIMEOUT_MILLS, TimeUnit.MILLISECONDS);
// 讀取超時時間
builder.readTimeout(mConfig.configReadTimeoutMills() != 0
? mConfig.configReadTimeoutMills() : DEFAULT_READ_TIMEOUT_MILLS, TimeUnit.MILLISECONDS);

// 攔截器
Interceptor[] interceptors = mConfig.configInterceptors();
if (interceptors != null && interceptors.length > 0) {
for (Interceptor interceptor : interceptors) {
builder.addInterceptor(interceptor);
}
}
if (mConfig.configLogEnable()) {//配置列印
HttpLoggingInterceptor logInterceptor = new HttpLoggingInterceptor();
logInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
builder.addInterceptor(logInterceptor);
}

mClient = builder.build();
}
return mClient;
}
}

具體方法說明如下：

registerConfig(NetConfig config)

進行網路的相關配置，在Application中進行呼叫

getHttpClient()

獲取和配置OkHttpClient

連線超時時間

讀取超時時間

自定義攔截器

請求日誌攔截器

getRetrofit()

獲取Retrofit例項

配置BaseUrl

配置client

配置轉換器

其他略....

註冊相關配置

新建Application類在 AndroidManifest 中引用，並呼叫BaseApi的registerConfig，傳入registerConfig的例項進行相關配置，具體程式碼如下：

public class DevApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
BaseApi.registerConfig(new NetConfig() {
@Override
public String configBaseUrl() {
return "http://olrt5mymy.bkt.clouddn.com/";
}

@Override
public Interceptor[] configInterceptors() {
return new Interceptor[0];
}

@Override
public long configConnectTimeoutMills() {
return 45 * 1000;
}

@Override
public long configReadTimeoutMills() {
return 45 * 1000;
}

@Override
public boolean configLogEnable() {
return true;
}
});
}
}

建立ServiceBuild類

在app的biz層中建立ServiceBuild類，主要是用來獲取service的例項。

/**
 * 服務獲取類
 */
public class ServiceBuild {
/**
* 使用者服務
*/
private static UserService mUserService;

/**
* 獲取使用者服務
*/
public static synchronized UserService getUserService() {
if (null == mUserService) {
mUserService = BaseApi.createRetrofit().create(UserService.class);
}
return mUserService;
}
}

更改Presenter程式碼

將LoginPresenter中建立Retrofit的程式碼和建立service的程式碼都去掉，換成呼叫ServiceBuild。

/**
 * 登陸Presenter
 */
public class LoginPresenter extends LoginContract.Presenter {

private String TAG = "LoginPresenter";

public LoginPresenter(LoginContract.View view) {
super(view);
}

@Override
public void login(String userName, String password) {
// 開始請求
Subscriber subscriber = ServiceBuild.getUserService()
.login(userName, password)
.subscribeOn(Schedulers.io())//執行在io執行緒
.observeOn(AndroidSchedulers.mainThread())//回撥在主執行緒
.subscribeWith(new ResourceSubscriber<LoginDto>() {
@Override
public void onNext(LoginDto loginDto) {
//結果回撥
Log.e(TAG, "onNext: " + loginDto);
if (loginDto.getCode() == 200) {
view.loginSuccess(loginDto);
} else {
view.loginFailure(loginDto.getMessage());
}

}

@Override
public void onError(Throwable t) {
Log.e(TAG, "onError: ");
view.loginFailure("登陸失敗：" + t.getMessage());
}

@Override
public void onComplete() {
Log.e(TAG, "onComplete: ");
}
});
}
}

移除了大部分程式碼，Presenter看上去更加的簡潔和優雅，接下來就執行起來看看效果吧。

檢視效果

執行起來看看效果吧。

效果

效果和上章一致。

HttpLoggingInterceptor

HttpLoggingInterceptor 的作用可以說是非常的強大，使用這個攔截器，可以列印請求一切過程，包括請求頭、請求體、請求引數、響應頭等，對於介面對接中快速定位問題有很大的幫助，具體看看截圖：

HttpLoggingInterceptor效果圖

結束

總結

分離了Retrofit的建立，減少了程式碼的冗餘，利用介面來做配置項，靈活性大大提升。
獨立了Service的建立，以後直接通過ServiceBuild的get方法進行獲取。
雖然增加了一部分的程式碼，但是隨著業務的增加，實則減少程式碼量。
大多數的Service都可以放到ServiceBuild中進行建立，方便統一管理。

問題

RxJava執行緒轉換還能進一步的封裝。
RxJava沒有取消訂閱。
訂閱的時候重寫的方法過於冗餘，可以去除，做統一的訂閱結果管理。

最後

本系列的課程還遠著呢，就關於這個登陸都還能再寫兩篇文章，敬請期待。

ofollow,noindex">原始碼-tag:0.3