一、写在前面
相信各位看官对retrofit和rxjava已经耳熟能详了，最近一直在学习retrofit+rxjava的各种封装姿势，也结合自己的理解，一步一步的做起来。
骚年，如果你还没有掌握retrofit和rx两大框架，那你是真的out了！
如果你对Rxjava不熟悉，请先看扔物线的给 Android 开发者的 RxJava 详解，超详细；
如果你只是想了解retrofit的简单使用，你可以看我另外一篇博客（仅仅是简单使用），android快捷开发之Retrofit网络加载框架的简单使用，详情请查看官网：Retrofit官网。
二、基本使用
好了，就不多BB了，直接进入正题。下面是我用retrofit和rxjava步步深入的封装方法。
1、首先依赖，别忘了添加网络访问权限。
dependencies {
compile fileTree(include: ['*.jar'], dir: 'libs')
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
exclude group: 'com.android.support', module: 'support-annotations'
})
compile 'com.android.support:appcompat-v7:25.0.1'
testCompile 'junit:junit:4.12'
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'io.reactivex:rxandroid:1.2.1'
// Because RxAndroid releases are few and far between, it is recommended you also
// explicitly depend on RxJava's latest version for bug fixes and new features.
compile 'io.reactivex:rxjava:1.1.6'
compile 'com.google.code.gson:gson:2.8.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
}
2、先来一个retrofit的简单访问请求，这里采用本人开源的毕业设计【开源毕设】一款精美的家校互动APP分享——爱吖校推 [你关注的，我们才推]（持续开源更新3）附高效动态压缩Bitmap上的一个api接口做测试，返回数据格式为：也就是一个code,msg,data的方式。
3、按照retrofit的官方方式，写上一个接口，用于定义子目录和方法
/**
* 使用普通的retrofit方式获取数据
* @return
*/
@GET("ezSQL/get_user.php")
Call<BaseResponse<List<UserModel>>> getUsers();
4、然后直接访问如下
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(Consts.APP_HOST)
.addConverterFactory(GsonConverterFactory.create())
.build();
ApiService apiService = retrofit.create(ApiService.class);
apiService.getUsers().enqueue(new Callback<BaseResponse<List<UserModel>>>() {
@Override
public void onResponse(Call<BaseResponse<List<UserModel>>> call, Response<BaseResponse<List<UserModel>>> response) {
showToast("成功:" + response.body().data.toString());
Log.e(TAG, "成功:" + response.body().data.toString());
Log.e(TAG, "retCode:" + response.code() + ",msg：" + response.message());
mTextView.setText("成功:" + response.body().data.toString());
} @Override
public void onFailure(Call<BaseResponse<List<UserModel>>> call, Throwable t) {
showToast("失败:" + t.getMessage());
Log.e(TAG, "失败:" + t.getMessage());
mTextView.setText("失败:" + t.getMessage());
}
});
5、如果用rx的方式为：
/**
* 使用rx+retrofit获取数据
* <p>
* 【subscribeOn和observeOn区别】
* 1、subscribeOn用于切换之前的线程
* 2、observeOn用于切换之后的线程
* 3、observeOn之后，不可再调用subscribeOn切换线程
* <p>
* ———————— 下面是来自扔物线的额外总结 ————————————
* 1、下面提到的“操作”包括产生事件、用操作符操作事件以及最终的通过 subscriber 消费事件
* 2、只有第一subscribeOn() 起作用（所以多个 subscribeOn() 毛意义）
* 3、这个 subscribeOn() 控制从流程开始的第一个操作，直到遇到第一个 observeOn()
* 4、observeOn() 可以使用多次，每个 observeOn() 将导致一次线程切换()，这次切换开始于这次 observeOn() 的下一个操作
* 5、不论是 subscribeOn() 还是 observeOn()，每次线程切换如果不受到下一个 observeOn() 的干预，线程将不再改变，不会自动切换到其他线程
*
* @param view
*/
public void btnClick1(View view) {
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(Consts.APP_HOST)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
ApiService apiService = retrofit.create(ApiService.class);
Observable<BaseResponse<List<UserModel>>> observable = apiService.getUsersByRx();
observable
.subscribeOn(Schedulers.io()) // 网络请求切换在io线程中调用
.unsubscribeOn(Schedulers.io())// 取消网络请求放在io线程
.observeOn(AndroidSchedulers.mainThread())// 观察后放在主线程调用
.subscribe(new Subscriber<BaseResponse<List<UserModel>>>() {
@Override
public void onCompleted() { } @Override
public void onError(Throwable e) {
showToast("rx失败:" + e.getMessage());
Log.e(TAG, "rx失败:" + e.getMessage());
mTextView.setText("rx失败:" + e.getMessage());
} @Override
public void onNext(BaseResponse<List<UserModel>> listBaseResponse) {
showToast("rx成功:" + listBaseResponse.data.toString());
mTextView.setText("rx成功:" + listBaseResponse.data.toString());
Log.e(TAG, "rx成功:" + listBaseResponse.data.toString());
}
});
}
6、其中BaseResponse是我们的统一的返回格式封装，采用泛型。
package com.nanchen.retrofitrxdemoo.model; import com.google.gson.annotations.SerializedName; import java.io.Serializable; /**
* 获取json数据基类
*
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/09 17:05
*/ public class BaseResponse<T> implements Serializable{
@SerializedName("code")
public int code;
@SerializedName("msg")
public String msg;
@SerializedName("data")
public T data;
}
package com.nanchen.retrofitrxdemoo.model; import java.io.Serializable; /**
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/10 09:05
*/ public class UserModel implements Serializable {
public String username;
public String password; @Override
public String toString() {
return "UserModel{" +
"username='" + username + '\'' +
", password='" + password + '\'' +
'}';
}
}
三、开始封装
可以看到传统的retrofit，不管采用callback，还是rx方式，重复代码都太多。如果不做一个封装，那每一次网络访问都要做四步操作的话，那必须得折腾死人。如果你不嫌麻烦，那没事，你可以下班了，当我没说。
我相信大多数人都是想做一下封装的，所以我们仔细观察一下上面，的确有很多地方是可以直接封装的。比如初始化retrofit，rx的线程切换等等。
别急，我们一步一步来！
1、首先写一个util类，这里我们采用单例方式；
public class RetrofitUtil { public static final int DEFAULT_TIMEOUT = 5; private Retrofit mRetrofit;
private ApiService mApiService; private static RetrofitUtil mInstance; /**
* 私有构造方法
*/
private RetrofitUtil(){
OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS);
mRetrofit = new Retrofit.Builder()
.client(builder.build())
.baseUrl(Consts.APP_HOST)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
mApiService = mRetrofit.create(ApiService.class);
} public static RetrofitUtil getInstance(){
if (mInstance == null){
synchronized (RetrofitUtil.class){
mInstance = new RetrofitUtil();
}
}
return mInstance;
} /**
* 用于获取用户信息
* @param subscriber
*/
public void getUsers(Subscriber<BaseResponse<List<UserModel>>> subscriber){
mApiService.getUsersByRx()
.subscribeOn(Schedulers.io())
.unsubscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(subscriber);
}
}
2、可以看到有了这个Util，那我们在Activity中调用就简单了。
RetrofitUtil.getInstance().getUsers(new Subscriber<BaseResponse<List<UserModel>>>() {
@Override
public void onCompleted() { } @Override
public void onError(Throwable e) {
showToast("rx失败:" + e.getMessage());
Log.e(TAG, "rx失败:" + e.getMessage());
mTextView.setText("rx失败:" + e.getMessage());
} @Override
public void onNext(BaseResponse<List<UserModel>> listBaseResponse) {
showToast("rx成功:" + listBaseResponse.data.toString());
mTextView.setText("rx成功:" + listBaseResponse.data.toString());
Log.e(TAG, "rx成功:" + listBaseResponse.data.toString());
}
});
3、可以看到的确让整个过程简单一些了，但似乎我们的确经常关注的是返回的数据，也就是onNext方法，而onCompleted和onError两个方法则调用较少，那么我们再把这两个方法做统一处理，并且我们一般网络访问都会用到加载对话框，加强用户交互性，遇到error的时候直接显示message即可。所以我们不妨把对话框显示也封装一下。
a) 首先写一个对话框退出接口，供后面调用
package com.nanchen.retrofitrxdemoo; /**
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/12 15:00
*/ public interface ProgressCancelListener {
void onCancelProgress();
}
b) 我们这里采用Handler的方式显示和隐藏加载对话框
package com.nanchen.retrofitrxdemoo; import android.app.ProgressDialog;
import android.content.Context;
import android.content.DialogInterface;
import android.os.Handler;
import android.os.Message; /**
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/12 15:02
*/ public class ProgressDialogHandler extends Handler {
public static final int SHOW_PROGRESS_DIALOG = 1;
public static final int DISMISS_PROGRESS_DIALOG = 2; private ProgressDialog pd; private Context context;
private boolean cancelable;
private ProgressCancelListener mProgressCancelListener; public ProgressDialogHandler(Context context, ProgressCancelListener mProgressCancelListener,
boolean cancelable) {
super();
this.context = context;
this.mProgressCancelListener = mProgressCancelListener;
this.cancelable = cancelable;
} private void initProgressDialog(){
if (pd == null) {
pd = new ProgressDialog(context); pd.setCancelable(cancelable); if (cancelable) {
pd.setOnCancelListener(new DialogInterface.OnCancelListener() {
@Override
public void onCancel(DialogInterface dialogInterface) {
mProgressCancelListener.onCancelProgress();
}
});
} if (!pd.isShowing()) {
pd.show();
}
}
} private void dismissProgressDialog(){
if (pd != null) {
pd.dismiss();
pd = null;
}
} @Override
public void handleMessage(Message msg) {
switch (msg.what) {
case SHOW_PROGRESS_DIALOG:
initProgressDialog();
break;
case DISMISS_PROGRESS_DIALOG:
dismissProgressDialog();
break;
}
}
}
c) 既然我们只关注onNext数据，所以把它提取出来，做成一个接口，以便于我们在Activity或者fragment中对数据进行操作，由于我们数据类型未知，所以这里也传入一个泛型。
package com.nanchen.retrofitrxdemoo; /**
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/12 14:48
*/ public interface SubscriberOnNextListener<T> {
void onNext(T t);
}
d) 来到重头戏，我们为Subscriber写一个子类，让其实现对话框的退出方法。因为Subscriber比Observer（正常情况下都会被转换为Subscriber，详情请看源代码）会多一个onStart方法，我们可以在onStart中调用对话框显示，在onComplete方法中调用对话框的隐藏方法。
package com.nanchen.retrofitrxdemoo; import android.content.Context;
import android.widget.Toast; import java.net.ConnectException;
import java.net.SocketTimeoutException; import rx.Subscriber; /**
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/12 14:48
*/ public class ProgressSubscriber<T> extends Subscriber<T> implements ProgressCancelListener{ private SubscriberOnNextListener<T> mListener;
private Context mContext;
private ProgressDialogHandler mHandler; public ProgressSubscriber(SubscriberOnNextListener<T> listener, Context context){
this.mListener = listener;
this.mContext = context;
mHandler = new ProgressDialogHandler(context,this,true);
} private void showProgressDialog(){
if (mHandler != null) {
mHandler.obtainMessage(ProgressDialogHandler.SHOW_PROGRESS_DIALOG).sendToTarget();
}
} private void dismissProgressDialog(){
if (mHandler != null) {
mHandler.obtainMessage(ProgressDialogHandler.DISMISS_PROGRESS_DIALOG).sendToTarget();
mHandler = null;
}
} /**
* 订阅开始时调用
* 显示ProgressDialog
*/
@Override
public void onStart() {
super.onStart();
showProgressDialog();
} @Override
public void onCompleted() {
dismissProgressDialog();
Toast.makeText(DemoApplication.getAppContext(),"获取数据完成！",Toast.LENGTH_SHORT).show();
} @Override
public void onError(Throwable e) {
if (e instanceof SocketTimeoutException) {
Toast.makeText(DemoApplication.getAppContext(), "网络中断，请检查您的网络状态", Toast.LENGTH_SHORT).show();
} else if (e instanceof ConnectException) {
Toast.makeText(DemoApplication.getAppContext(), "网络中断，请检查您的网络状态", Toast.LENGTH_SHORT).show();
} else {
Toast.makeText(DemoApplication.getAppContext(), "error:" + e.getMessage(), Toast.LENGTH_SHORT).show();
}
dismissProgressDialog();
} @Override
public void onNext(T t) {
if (mListener != null){
mListener.onNext(t);
}
} @Override
public void onCancelProgress() {
if (!this.isUnsubscribed()){
this.unsubscribe();
}
}
}
e) 为了让大家可以测试代码，所以我这里把api接口换为天狗网的健康菜谱。返回格式为
f) 由于这个返回格式和我的毕设的返回格式不一样，所以，我们重写一个TngouResponse类，这里就不贴代码了。
g) 我们仔细观察上面的封装Util，发现我们的线程切换其实也是可以封装成一个单独的方法的，这样又可以降低代码的耦合了。所以完整的ProgressSubscriber类为：
package com.nanchen.retrofitrxdemoo; import android.content.Context;
import android.widget.Toast; import java.net.ConnectException;
import java.net.SocketTimeoutException; import rx.Subscriber; /**
* @author nanchen
* @fileName RetrofitRxDemoo
* @packageName com.nanchen.retrofitrxdemoo
* @date 2016/12/12 14:48
*/ public class ProgressSubscriber<T> extends Subscriber<T> implements ProgressCancelListener{ private SubscriberOnNextListener<T> mListener;
private Context mContext;
private ProgressDialogHandler mHandler; public ProgressSubscriber(SubscriberOnNextListener<T> listener, Context context){
this.mListener = listener;
this.mContext = context;
mHandler = new ProgressDialogHandler(context,this,true);
} private void showProgressDialog(){
if (mHandler != null) {
mHandler.obtainMessage(ProgressDialogHandler.SHOW_PROGRESS_DIALOG).sendToTarget();
}
} private void dismissProgressDialog(){
if (mHandler != null) {
mHandler.obtainMessage(ProgressDialogHandler.DISMISS_PROGRESS_DIALOG).sendToTarget();
mHandler = null;
}
} /**
* 订阅开始时调用
* 显示ProgressDialog
*/
@Override
public void onStart() {
super.onStart();
showProgressDialog();
} @Override
public void onCompleted() {
dismissProgressDialog();
Toast.makeText(DemoApplication.getAppContext(),"获取数据完成！",Toast.LENGTH_SHORT).show();
} @Override
public void onError(Throwable e) {
if (e instanceof SocketTimeoutException) {
Toast.makeText(DemoApplication.getAppContext(), "网络中断，请检查您的网络状态", Toast.LENGTH_SHORT).show();
} else if (e instanceof ConnectException) {
Toast.makeText(DemoApplication.getAppContext(), "网络中断，请检查您的网络状态", Toast.LENGTH_SHORT).show();
} else {
Toast.makeText(DemoApplication.getAppContext(), "error:" + e.getMessage(), Toast.LENGTH_SHORT).show();
}
dismissProgressDialog();
} @Override
public void onNext(T t) {
if (mListener != null){
mListener.onNext(t);
}
} @Override
public void onCancelProgress() {
if (!this.isUnsubscribed()){
this.unsubscribe();
}
}
}
h) 现在，我们发现在activity或fragment中调用网络数据其实就是这么简单！
SubscriberOnNextListener mListener = new SubscriberOnNextListener<TngouResponse<List<Cook>>>() { @Override public void onNext(TngouResponse<List<Cook>> listTngouResponse) { mTextView.setText(listTngouResponse.tngou.toString()); showToast(listTngouResponse.tngou.toString()); } };
RetrofitUtil.getInstance().getCookList(2,5,new ProgressSubscriber<TngouResponse<List<Cook>>>(mListener,this));
四、写在最后
本次retrofit和rxjava的简单封装就到这里了，虽然讲解质量有待提高，不过楼主依赖打算分享给大家，代码地址：https://github.com/nanchen2251/RetrofitRxUtil
另外楼主近期在开源android各种实用开源控件，希望大家多多支持：https://github.com/nanchen2251
最后的最后，楼主如果空出了足够的时间，一定会出一款retrofit的封装框架的，望大家持续关注~
