在上一篇文章《Android Retrofit + RxJava使用詳解》中,我們學習了Retrofit的一些基本用法,但在實際的項目使用中,還是會出現一些問題,今天就讓我們一起來探討一下如何對Retrofit進行封裝吧!
如果你對Retrofit還不太瞭解,可以>戳這裏<學習一下。
如果你使用的是MVP,這篇文章可能不太適合你,請移步《Android 談談我所理解的MVP》。
1.背景介紹
首先來回顧一下Retrofit的基本使用流程,直接上代碼:
/**
* 定義請求參數接口
*/
public interface RetrofitService {
/**
* 獲取快遞信息
*
* @param type 快遞類型
* @param postid 快遞單號
* @return Call<PostInfo>
*/
@GET("query")
Call<PostInfo> getPostInfo(@Query("type") String type, @Query("postid") String postid);
}
// 網絡請求
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://www.kuaidi100.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();
RetrofitService service = retrofit.create(RetrofitService.class);
Call<PostInfo> call = service.getPostInfo("yuantong", "11111111111");
call.enqueue(new Callback<PostInfo>() {
@Override
public void onResponse(Call<PostInfo> call, Response<PostInfo> response) {
Log.i("http返回:", response.body().toString() + "");
}
@Override
public void onFailure(Call<PostInfo> call, Throwable t) {
}
});
首先定義請求參數接口,返回泛型爲PostInfo的Call對象,接着初始化Retrofit,創建RetrofitService對象,調用RetrofitService中的getPostInfo方法返回Call對象,最後調用call.enqueue進行網絡請求,這樣一個簡單的Retrofit網絡請求就完成了。
But,如果網絡接口很多的話,那我們豈不是要寫很多重複的邏輯代碼,比如:
Call<PostInfo> call = service.getPostInfo("yuantong", "11111111111");
call.enqueue(new Callback<PostInfo>() {
@Override
public void onResponse(Call<PostInfo> call, Response<PostInfo> response) {
Log.i("http返回:", response.body().toString() + "");
}
@Override
public void onFailure(Call<PostInfo> call, Throwable t) {
}
});
這顯然不是我的風格,我希望的結構是這樣的:
定義兩個管理類SendMessageManager和ReceiveMessageManager,分別負責消息的發送和接收,而具體的發送和接收邏輯交由HttpChannel處理,當然也可以定義其他的消息通道進行管理(比如TCP),UI層不關心具體的消息執行邏輯,只負責發送消息和處理接收到的消息。
這樣做可以使代碼的邏輯更加清晰,比如我需要修改一個接口,直接打開SendMessageManager搜索就能馬上找到要修改的接口信息,也可以避免重複代碼的編寫,提升工作效率,接下來看下具體的實現邏輯。
2.實現邏輯
RetrofitService
RetrofitService的結構保持不變,PostInfo繼承於Bean基類BaseBean:
public interface RetrofitService {
/**
* 獲取快遞信息
* Rx方式
*
* @param type 快遞類型
* @param postid 快遞單號
* @return Observable<PostInfo>
*/
@GET("query")
Observable<PostInfo> getPostInfoRx(@Query("type") String type, @Query("postid") String postid);
}
HttpChannel
看下Http核心處理類:
public class HttpChannel {
private static HttpChannel httpChannel;
private RetrofitService retrofitService;
public static HttpChannel getInstance() {
return httpChannel == null ? httpChannel = new HttpChannel() : httpChannel;
}
private HttpChannel() {
// 初始化Retrofit
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://www.kuaidi100.com/")
.addConverterFactory(GsonConverterFactory.create()) // json解析
.addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava
.client(RetrofitUtils.getOkHttpClient()) // 打印請求參數
.build();
retrofitService = retrofit.create(RetrofitService.class);
}
/**
* 發送消息
*
* @param observable Observable<? extends BaseBean>
* @param urlOrigin 請求地址
*/
public void sendMessage(Observable<? extends BaseBean> observable, final String urlOrigin) {
observable.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Observer<BaseBean>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
}
@Override
public void onNext(BaseBean baseBean) {
Log.i("http返回:", baseBean.toString() + "");
ReceiveMessageManager.getInstance().dispatchMessage(baseBean, urlOrigin);
}
});
}
public RetrofitService getRetrofitService() {
return retrofitService;
}
}
使用了單例模式,在構造方法中初始化Retrofit和RetrofitService,提供getRetrofitService方法來獲取RetrofitService對象,定義sendMessage方法,接收observable和urlOrigin參數,其中observable爲被觀察者對象,泛型爲BaseBean或BaseBean的子類,urlOrigin爲接口地址(同@GET(“query”)中的query),在onNext方法中調用ReceiveMessageManager的dispatchMessage方法進行消息的分發。
SendMessageManager
public class SendMessageManager {
private static SendMessageManager manager;
private HttpChannel httpChannel;
private RetrofitService retrofitService;
public static SendMessageManager getInstance() {
return manager == null ? manager = new SendMessageManager() : manager;
}
private SendMessageManager() {
httpChannel = HttpChannel.getInstance();
retrofitService = httpChannel.getRetrofitService();
}
/**
* 獲取快遞信息
*
* @param type 快遞類型
* @param postid 快遞單號
*/
public void getPostInfo(String type, String postid) {
Observable<PostInfo> observable = retrofitService.getPostInfoRx(type, postid);
httpChannel.sendMessage(observable, Constant.UrlOrigin.get_post_info);
}
}
也是使用了單例模式,在構造方法中初始化HttpChannel,獲取RetrofitService對象,定義getPostInfo方法,在getPostInfo中獲取被觀察者對象,調用HttpChannel的sendMessage方法進行消息發送。
ReceiveMessageManager
public class ReceiveMessageManager {
private static ReceiveMessageManager manager;
public static ReceiveMessageManager getInstance() {
return manager == null ? manager = new ReceiveMessageManager() : manager;
}
private ReceiveMessageManager() {
}
/**
* 分發消息
*
* @param baseBean Bean基類
* @param url 請求地址
*/
public void dispatchMessage(BaseBean baseBean, String url) {
switch (url) {
case Constant.UrlOrigin.get_post_info:
PostInfo postInfo = (PostInfo) baseBean;
EventBus.getDefault().post(postInfo);
break;
default:
break;
}
}
}
啊,還是單例模式,定義dispatchMessage方法,判斷接口請求地址進行消息分發,這裏使用了EventBus通知Activity的方式,也可以替換成其他的事件訂閱框架。
MainActivity
終於到了UI層:
public class MainActivity extends AppCompatActivity {
private SendMessageManager sendMessageManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ButterKnife.bind(this);
sendMessageManager = SendMessageManager.getInstance();
}
@Override
public void onStart() {
super.onStart();
EventBus.getDefault().register(this);
}
@OnClick({R.id.btn_encap_request})
public void onViewClicked(View view) {
switch (view.getId()) {
case R.id.btn_encap_request:
// 封裝使用
encapRequest();
break;
default:
break;
}
}
/**
* 封裝使用
*/
private void encapRequest() {
sendMessageManager.getPostInfo("yuantong", "11111111111");
}
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(PostInfo postInfo) {
Log.i("接收消息:", postInfo.toString());
Toast.makeText(MainActivity.this, postInfo.toString(), Toast.LENGTH_SHORT).show();
}
@Override
public void onStop() {
super.onStop();
EventBus.getDefault().unregister(this);
}
}
調用SendMessageManager的getPostInfo方法請求接口,在onMessageEvent方法中接收請求結果並進行處理,清晰明瞭。
3.寫在最後
源碼已託管到GitHub上,歡迎Fork,覺得還不錯就Start一下吧!
歡迎同學們吐槽評論,如果你覺得本篇博客對你有用,那麼就留個言或者頂一下吧(^-^)