Google官方MVP+Rxjava项目详解
全面分析Google官方架构Google官方MVP+Rxjava项目
欢迎follow我的github：https://github.com/CameloeAnthony
1 前言
说起架构系列，不得不提到Google官方的架构google官方示例架构项目android-architecture 。
之前写了两篇关注度都比较高的文章Google官方架构MVP解析与实战，Google官方MVP+Dagger2架构详解 。分别对应了分支todo-mvp/以及分支todo-mvp-dagger/ 。本篇文章将分析todo-mvp-rxjava/分支，在todo-mvp/分支的基础上，通过使用Rxjava来实现并发和数据层的处理。
本篇文章只是在官方架构的基础上进行讲解，希望对你提供帮助和指导，而不是完全的说明必须这么做！
目前分析了这三个分支
2 比对
需要注意的是,上图中的所有分支基于第一个todo-mvp/分支的。也就是说本篇文章中的项目并没有引入Dagger2作为依赖注入的工具，也没有引入databinding，clean等。希望通过本篇文章的了解之后，读者完全可以自行组织自己的架构和组织方式来构建自己的app。
这里对todo-mvp/分支和todo-mvp-rxjava/分支进行比对，使用比对工具Beyond Compare。
比对效果
Beyond Compare也是代码上传svn，git等的时候文件和文件夹比对的一大利器，是程序猿开发必不可少的优秀工具。
3 项目依赖
这里需要注意的是todo-mvp-rxjava/添加的依赖有：
RxJava
RxAndroid
SqlBrite
这里并不会对Rxjava和RxAndroid进行深入讲解。后面的博客希望能给大家分享一下Rxjava和RxAndroid的使用心得。
4 分析
4.1 整体组织目录
项目结构的组织方式是按照功能进行分模块的，当然根据个人情况，也可以按照ui，model，view，presenter这种情况进行组织目录划分。
google官方MVP+Rxjava架构目录视图
4.2 整体MVP构建
至于MVP的构建方式，在文章Google官方架构MVP解析与实战中已经进行了分析，这里不再赘述直接提取结论。（下面的文中会对所有点再次提及）
**1 **官方MVP实例，通过协议类XXXContract来对View和Presenter的接口进行内部继承。是对BaseView和BasePresenter的进一步封装，所以我们实现的View和Presenter也只需要继承XXXContract中的对应内部接口就行。
**2 **activity的作用主要是创建View（这里是相应的fragment），以及创建presenter，并把view传递给presenter（完成presenter对view实例关联操作）
**3 **在presenter的实现类的构造函数中，通过view的setPresenter，让view获得了presenter实例。这样view中就可以对Presenter中的方法进行操作了。（完成view对presenter实例关联操作）
**4 **在presenter的实现类中，可以对Model数据进行操作。实例中，数据的获取、存储、数据状态变化都是model层的任务，presenter会根据需要调用该层的数据处理逻辑并在需要时将回调传入。这样model、presenter、view都只处理各自的任务，此种实现确实是单一职责最好的诠释。
本篇文章我们主要针对todo-mvp-rxjava项目中的添加和修改待办事项页面做讲解。（这是同一个界面的不同状态）
待办事项项目的添加和编辑task界面
待办事项项目的添加和编辑task对应的代码位置
4.3 添加和修改待办事项页面 -代码细节分析
4.3.1 BaseView 和BasePresenter
注意：下方展示的所有对比代码左右分别代表todo-mvp/和todo-mvp-rxjava/项目，不再提示。
BaseView没有改变，BasePresenter变成了subscribe和unsubscribe方法。很自然的我们会想到Rxjava的Subscription的订阅和取消订阅。这里的subscribe也就对应了之前的todo-mvp/项目中的start方法，一般用于初始化和加载数据。
4.3.2使用CompositeSubscription
通过下面这两张图说明一下使用方式：
AddEditTaskPresenter中的subscribe和unsubscribe方法的实现
AddEditTaskFragment中对AddEditTaskPresenter的调用
这里使用CompositeSubscription在presenter实现类AddEditTaskPresenter中来持有所有的Subscriptions。这里分别是在onResume和onPause中实现订阅和取消,你也可以在Activity/Fragment的基类里创建一个CompositeSubscription对象，在子类中使用它，然后在onDestroy()或者onDestroyView()里取消所有的订阅。
4.3.3 协议类AddEditTaskContract
官方MVP实例，通过协议类XXXContract来对View和Presenter的接口进行内部继承。是对BaseView和BasePresenter的进一步封装，所以我们实现的View和Presenter也只需要继承XXXContract中的对应内部接口就行。
由于当前页面包含编辑和添加两个状态，这里分别作出标示。来看看AddEditTaskContract类。
AddEditTaskContract类
4.3.4 Activity类AddEditTaskActivity
这里可以从下面的代码清晰的看到AddEditTaskActivity 完成的是Fragment的创建，presenter的初始化。
/**
* 展示添加或者编辑界面
*/
public class AddEditTaskActivity extends AppCompatActivity {
public static final int REQUEST_ADD_TASK = 1;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.addtask_act);
// 设置Toobar
Toolbar toolbar = (Toolbar) findViewById(R.id.toolbar);
setSupportActionBar(toolbar);
ActionBar actionBar = getSupportActionBar();
actionBar.setDisplayHomeAsUpEnabled(true);
actionBar.setDisplayShowHomeEnabled(true);
//AddEditTaskFragment实例
AddEditTaskFragment addEditTaskFragment =
(AddEditTaskFragment) getSupportFragmentManager().findFragmentById(R.id.contentFrame);
//获取不同的状态，分别对应了添加和编辑界面
String taskId = null;
if (addEditTaskFragment == null) {
addEditTaskFragment = AddEditTaskFragment.newInstance();
if (getIntent().hasExtra(AddEditTaskFragment.ARGUMENT_EDIT_TASK_ID)) {
taskId = getIntent().getStringExtra(
AddEditTaskFragment.ARGUMENT_EDIT_TASK_ID);
actionBar.setTitle(R.string.edit_task);
} else {
actionBar.setTitle(R.string.add_task);
}
ActivityUtils.addFragmentToActivity(getSupportFragmentManager(),
addEditTaskFragment, R.id.contentFrame);
}
//添加MVP中View的实现类AddEditTaskFragment,创建Presenter
new AddEditTaskPresenter(
taskId, //每一个Task的id标示
//依赖注入，提供TasksRepository类
Injection.provideTasksRepository(getApplicationContext()),
addEditTaskFragment,//AddEditTaskFragment实例
Injection.provideSchedulerProvider());//提供Scheduler，用于Rxjava调度
}
@Override
public boolean onSupportNavigateUp() {
onBackPressed();
return true;
}
@VisibleForTesting
public IdlingResource getCountingIdlingResource() {
return EspressoIdlingResource.getIdlingResource();
}
}
4.3.5 AddEditTaskFragment类
在presenter的实现类的构造函数中，通过view的setPresenter，让view获得了presenter实例。这样view中就可以对Presenter中的方法进行操作了。（完成view对presenter实例关联操作）
AddEditTaskFragment是AddEditTaskContract.View的实现类。也就对应完成了显示空信息，显示task等view的操作。
/**
* AddEditTaskFragment是AddEditTaskContract.View的实现类,可以输入标题和描述信息
*/
public class AddEditTaskFragment extends Fragment implements AddEditTaskContract.View {
public static final String ARGUMENT_EDIT_TASK_ID = "EDIT_TASK_ID";
private AddEditTaskContract.Presenter mPresenter;
private TextView mTitle;
private TextView mDescription;
public static AddEditTaskFragment newInstance() {
return new AddEditTaskFragment();
}
@Override
public void onResume() {
super.onResume();
mPresenter.subscribe();
}
@Override
public void onPause() {
super.onPause();
mPresenter.unsubscribe();
}
@Override
public void setPresenter(@NonNull AddEditTaskContract.Presenter presenter) {
mPresenter = checkNotNull(presenter);
}
@Override
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
FloatingActionButton fab =
(FloatingActionButton) getActivity().findViewById(R.id.fab_edit_task_done);
fab.setImageResource(R.drawable.ic_done);
fab.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
mPresenter.saveTask(mTitle.getText().toString(),
mDescription.getText().toString());
}
});
}
@Nullable
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View root = inflater.inflate(R.layout.addtask_frag, container, false);
mTitle = (TextView) root.findViewById(R.id.add_task_title);
mDescription = (TextView) root.findViewById(R.id.add_task_description);
setHasOptionsMenu(true);
setRetainInstance(true);
return root;
}
@Override
public void showEmptyTaskError() {
Snackbar.make(mTitle, getString(R.string.empty_task_message), Snackbar.LENGTH_LONG).show();
}
@Override
public void showTasksList() {
getActivity().setResult(Activity.RESULT_OK);
getActivity().finish();
}
@Override
public void setTitle(String title) {
mTitle.setText(title);
}
@Override
public void setDescription(String description) {
mDescription.setText(description);
}
@Override
public boolean isActive() {
return isAdded();
}
}
这里的关注重点除了上面提到的订阅和取消订阅方法。还应当有presenter实例的获取。通过setPresenter方法。
4.3.6AddEditTaskPresenter
在presenter的实现类中，可以对Model数据进行操作。实例中，数据的获取、存储、数据状态变化都是model层的任务，presenter会根据需要调用该层的数据处理逻辑并在需要时将回调传入。这样model、presenter、view都只处理各自的任务，此种实现确实是单一职责最好的诠释。
/**
* AddEditTaskPresenter监听用户的UI操作，获取数据，更新界面
* 需要实现的方法有除了{@link BasePresenter} 中的{@link #subscribe()},{@link #unsubscribe()}
* 还有{@link AddEditTaskContract}中的{@link #saveTask(String, String)} ()},{@link #populateTask()},
*/
public class AddEditTaskPresenter implements AddEditTaskContract.Presenter {
@NonNull
private final TasksDataSource mTasksRepository;//数据model来源
@NonNull
private final AddEditTaskContract.View mAddTaskView;//MVP中的view
@NonNull
private final BaseSchedulerProvider mSchedulerProvider;//提供Scheduler用于Rxjava线程调度
@Nullable
private String mTaskId;//task 的id
@NonNull
private CompositeSubscription mSubscriptions;//CompositeSubscription持有所有的Subscriptions
/**
* 创建添加和编辑task的对应presenter
*
* @param taskId 需要编辑的task的id，如果为新建task为空
* @param tasksRepository 是所有task数据的入口
* @param addTaskView 添加/编辑 界面
*/
public AddEditTaskPresenter(@Nullable String taskId,
@NonNull TasksDataSource tasksRepository,
@NonNull AddEditTaskContract.View addTaskView,
@NonNull BaseSchedulerProvider schedulerProvider) {
mTaskId = taskId;
mTasksRepository = checkNotNull(tasksRepository, "tasksRepository cannot be null!");
mAddTaskView = checkNotNull(addTaskView, "addTaskView cannot be null!");
mSchedulerProvider = checkNotNull(schedulerProvider, "schedulerProvider cannot be null!");
mSubscriptions = new CompositeSubscription();
mAddTaskView.setPresenter(this);
}
@Override
public void subscribe() {
if (mTaskId != null) {
populateTask();
}
}
@Override
public void unsubscribe() {
mSubscriptions.clear();
}
@Override
public void saveTask(String title, String description) {
Task newTask = mTaskId == null ?
new Task(title, description) :
new Task(title, description, mTaskId);
saveTask(newTask);
}
/**
* 直接通过TasksRepository保存task
* @param task
*/
private void saveTask(@NonNull Task task) {
if (task.isEmpty()) {
mAddTaskView.showEmptyTaskError();
} else {
mTasksRepository.saveTask(task);
mAddTaskView.showTasksList();
}
}
/**
* 根据id获取task
*/
@Override
public void populateTask() {
if (mTaskId == null) {
throw new RuntimeException("populateTask() was called but task is new.");
}
Subscription subscription = mTasksRepository
.getTask(mTaskId) //获取task
.subscribeOn(mSchedulerProvider.computation())
.observeOn(mSchedulerProvider.ui())
.subscribe(new Observer<Task>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
if (mAddTaskView.isActive()) {
mAddTaskView.showEmptyTaskError(); //调用页面出错
}
}
@Override
public void onNext(Task task) {
if (mAddTaskView.isActive()) {
mAddTaskView.setTitle(task.getTitle()); //页面正确显示task
mAddTaskView.setDescription(task.getDescription());
}
}
});
mSubscriptions.add(subscription);
}
}
这里我在上面的代码中添加了备注，希望尽可能的讲解清楚。这里的代码逻辑是非常的清楚地，下面再捋一捋：
1
AddEditTaskPresenter的构造函数异常重要，这里获取了AddEditTaskContract.view的实例对象和TaskDataSource的实例对象，分别对应了MVP中得到View和Model。
2
subscribe方法和unSubscribe方法分别对应了订阅和取消订阅状态，这在前面的AddEditTaskFragment的onResume和onPause方法中进行了实现。这里分别完成了获取task和取消订阅两个功能。
3 在这里调用了上面提到的
setPresenter方法，view持有presenter实例的操作。
4 通过
mSubscriptions.add(subscription);将这里获取task的subscription添加到了CompositeSubscription中。
5 通过
mTasksRepository.saveTask(task);和mTasksRepository.getTask(mTaskId)完成了task的存储和获取功能，所有model层的操作都交给了TasksRepository,model层的操作将下面详细讲解。
6 我们在
onError和onNext中分别完成了错误和正确页面的逻辑处理。
4.4 model层设计代码分析
Rxjava完成了数据层和presenter层的交互，这里回到上面的代码，可以看到通过model层的操作都交给了TasksRepository对象。
model层的操作都交给了`TasksRepository`对象
接下来到data包中就是所有model层的操作。
data包中就是所有model层的操作
这里就不在展示分析所有代码。TasksLocalDataSource代表本地数据，TasksRemoteDataSource代表远程数据。Task为实体类对象，TasksRepository为整个数据的核心漱口。这里直接展示TasksRepository中的getTask方法。
/**
* Gets tasks from local data source (sqlite) unless the table is new or empty. In that case it
* uses the network data source. This is done to simplify the sample.
*/
@Override
public Observable<Task> getTask(@NonNull final String taskId) {
checkNotNull(taskId);
final Task cachedTask = getTaskWithId(taskId);
// Respond immediately with cache if available
if (cachedTask != null) {
return Observable.just(cachedTask);
}
// Load from server/persisted if needed.
// Do in memory cache update to keep the app UI up to date
if (mCachedTasks == null) {
mCachedTasks = new LinkedHashMap<>();
}
// Is the task in the local data source? If not, query the network.
Observable<Task> localTask = getTaskWithIdFromLocalRepository(taskId);
Observable<Task> remoteTask = mTasksRemoteDataSource
.getTask(taskId)
.doOnNext(new Action1<Task>() {
@Override
public void call(Task task) {
mTasksLocalDataSource.saveTask(task);
mCachedTasks.put(task.getId(), task);
}
});
return Observable.concat(localTask, remoteTask).first()
.map(new Func1<Task, Task>() {
@Override
public Task call(Task task) {
if (task == null) {
throw new NoSuchElementException("No task found with taskId " + taskId);
}
return task;
}
});
}
1 需要注意的是这里TasksLocalDataSource使用SqlBrite查询数据库并且返回流式数据。
2 关于model层Respository的了解，可以看我之前的这篇文章。浅析MVP中model层设计
3 SqlBrite是对 Android 系统的 SQLiteOpenHelper 的封装，对SQL操作引入了响应式语义 （Rx）（用来在 RxJava 中使用）。详情可以点击Rxjava+数据库？来用用SqlBrite和SqlDelight吧！ 。
