优雅的解决Retrofit RxAndroid关联生命周期问题

封面

Retrofit结合RxAndroid应该是史上最好用的网络请求框架了,在项目中只需要一段代码就可以完成网络请求以及回调处理,来看看google官方示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class UserActivity extends AppCompatActivity {
// 数据提供
private UserViewModel mViewModel;
// 管理subscriptions订阅的释放
private final CompositeDisposable mDisposable = new CompositeDisposable();

@Override
protected void onStart() {
super.onStart();
// 发起网络请求
mDisposable.add(mViewModel.getUserName()
.subscribeOn(Schedulers.io()) // 请求在IO线程运行
.observeOn(AndroidSchedulers.mainThread()) // 回调到Android主线程
.subscribe(userName -> mUserName.setText(userName), // 回调监听
throwable -> Log.e(TAG, "Unable to update username", throwable)));
}

@Override
protected void onStop() {
super.onStop();
// 释放请求
mDisposable.clear();
}
}

在上面的例子中,所有的请求都必须要addCompositeDisposable中,在Activity停止的时候进行释放操作。如果不释放的话会怎么样?答案是程序会崩溃。因为你的网络请求是运行在异步线程IO中去的,当线程完成后回调到主线程来,发现Activity跑路(被释放)了,回调的subscribe(...)找不到对象了,那肯定不干啊,线程也是有点小脾气的嘛。

痛点

程序员都是"很懒的",一来写代码不好看,每个请求要嵌套在add()括号中;二来要在Activity销毁的时候进行释放。

Retrofit Rxandroid Adapter

为解决Retrofit关联的ActivityFragment生命周期而设计。

一、用法

通过with(this)来关联生命周期,简化Activity.onStop()的释放操作。

1
2
3
4
5
6
7
8
9
public class UserActivity extends AppCompatActivity {
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
MyService service = retrofit.create(MyService.class); // 你的接口
service.getUser()
.with(this) // 关联生命周期
.subscribe(new YourObserver());
}
}

二、配置

1、在Retrofit初始化的实例的时候,添加RxAndroidCallAdapterFactory 作为回调适配器。

1
2
3
4
5
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://example.com/")
// 添加适配器
.addCallAdapterFactory(RxAndroidCallAdapterFactory.create())
.build();

2、改写你的接口返回值,由之前的Observable<>改为AndroidObservable<>

1
2
3
4
interface MyService {
@GET("/user")
AndroidObservable<User> getUser();
}

三、下载

1
2
3
4
5
6
allprojects {
repositories {
// ... 省略其他
maven { url 'https://jitpack.io' }
}
}
1
2
3
dependencies {
implementation 'com.github.raedev:retrofit-rxandroid-adapter:latest.version'
}

AndroidObservable

源码请查看 开源地址:https://github.com/raedev/retrofit-rxandroid-adapter