Google 官方应用架构的最佳实践指南
虽然说 Android 的架构选择一直都很自由，MVP、MVC、MVVM 各有拥趸。但 Google 最近还是推出了一份关于应用架构的实践指南，并给出了相当详尽的步骤和一些指导建议。希望大家都能看一看，学习一下，打造更加优秀易用的 APP，也为 Android 生态的改善做一点贡献。: )
最近，官方推出了一份关于应用架构的最佳实践指南。这里就给大家简要介绍一下：
首先，Android 开发者肯定都知道 Android 中有四大组件，这些组件都有各自的生命周期并且在一定程度上是不受你控制的。在任何时候，Android 操作系统都可能根据用户的行为或资源紧张等原因回收掉这些组件。
这也就引出了第一条准则：「不要在应用程序组件中保存任何应用数据或状态，并且组件间也不应该相互依赖」。
最常见的错误就是在 Activity 或 Fragment 中写了与 UI 和交互无关的代码。尽可能减少对它们的依赖，这能避免大量生命周期导致的问题，以提供更好的用户体验。
第二条准则：「通过 model 驱动应用 UI，并尽可能的持久化」。
这样做主要有两个原因：
如果系统回收了你的应用资源或其他什么意外情况，不会导致用户丢失数据。
Model 就应该是负责处理应用程序数据的组件。独立于视图和应用程序组件，保持了视图代码的简单，也让你的应用逻辑更容易管理。并且，将应用数据置于 model 类中，也更有利于测试。
官方推荐的 App 架构
在这里，官方演示了通过使用最新推出的 Architecture Components 来构建一个应用。
想象一下，您正在打算开发一个显示用户个人信息的界面，用户数据通过 REST API 从后端获取。
首先，我们需要创建三个文件：
user_profile.xml：定义界面。
UserProfileViewModel.java：数据类。
UserProfileFragment.java：显示 ViewModel 中的数据并对用户的交互做出反应。
为了简单起见，我们这里就省略掉布局文件。
1.public class UserProfileViewModel extends ViewModel {
2.private String userId;
3.private User user;
4.public void init(String userId) {
5.this.userId = userId;
6.}
7.public User getUser() {
8.return user;
9.}
10.}
1.public class UserProfileFragment extends LifecycleFragment {
2.private static final String UID_KEY = "uid";
3.private UserProfileViewModel viewModel;
4.@Override
5.public void onActivityCreated(@Nullable Bundle savedInstanceState) {
6.super.onActivityCreated(savedInstanceState);
7.String userId = getArguments().getString(UID_KEY);
8.viewModel = ViewModelProviders.of(this).get(UserProfileViewModel.class);
9viewModel.init(userId);
10.}
11.@Override
12.public View onCreateView(LayoutInflater inflater,
13.@Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
14.return inflater.inflate(R.layout.user_profile, container, false);
15.}
16.}
注意其中的 ViewModel 和 LifecycleFragment 都是 Android 新引入的，可以参考官方说明进行集成。
现在，我们完成了这三个模块，该如何将它们联系起来呢？也就是当 ViewModel 中的用户字段被设置时，我们需要一种方法来通知 UI。这就是 LiveData 的用武之地了。
LiveData 是一个可被观察的数据持有者（用到了观察者模式）。其能够允许 Activity, Fragment 等应用程序组件对其进行观察，并且不会在它们之间创建强依赖。LiveData 还能够自动响应各组件的声明周期事件，防止内存泄漏，从而使应用程序不会消耗更多的内存。
注意：LiveData 和 RxJava 或 Agera 的区别主要在于 LiveData 自动帮助处理了生命周期事件，避免了内存泄漏。
所以，现在我们来修改一下 UserProfileViewModel：
1.public class UserProfileViewModel extends ViewModel {
2....
3.private LiveData
4.public LiveData
5.return user;
6.}
7.}
再在 UserProfileFragment 中对其进行观察并更新我们的 UI：
1.@Override
2.public void onActivityCreated(@Nullable Bundle savedInstanceState) {
3.super.onActivityCreated(savedInstanceState);
4.viewModel.getUser().observe(this, user -> {
5.// update UI
6.});
7.}
获取数据
现在，我们联系了 ViewModel 和 Fragment，但 ViewModel 又怎么来获取到数据呢？
在这个示例中，我们假定后端提供了 REST API，因此我们选用 Retrofit 来访问我们的后端。
首先，定义一个 Webservice：
1.public interface Webservice {
2./**
3.* @GET declares an HTTP GET request
4.* @Path("user") annotation on the userId parameter marks it as a
5.* replacement for the {user} placeholder in the @GET path
6.*/
7.@GET("/users/{user}")
8.Call
9.}
不要通过 ViewModel 直接来获取数据，这里我们将工作转交给一个新的 Repository 模块。
Repository 模块负责数据处理，为应用的其他部分提供干净可靠的 API。你可以将其考虑为不同数据源（Web，缓存或数据库）与应用之间的中间层。
1.public class UserRepository {
2.private Webservice webservice;
3.// ...
4.public LiveData
5.// This is not an optimal implementation, we'll fix it below
6.final MutableLiveData
7.webservice.getUser(userId).enqueue(new Callback
8.@Override
9.public void onResponse(Call
10.// error case is left out for brevity
11.data.setValue(response.body());
12.}
13.});
14.return data;
15.}
16.}
管理组件间的依赖关系
根据上面的代码，我们可以看到 UserRepository 中有一个 Webservice 的实例，不要直接在 UserRepository 中 new 一个 Webservice。这很容易导致代码的重复与复杂化，比如 UserRepository 很可能不是唯一用到 Webservice 的类，如果每个用到的类都新建一个 Webservice，这显示会导致资源的浪费。
这里，我们推荐使用 Dagger 2 来管理这些依赖关系。
现在，让我们来把 ViewModel 和 Repository 连接起来吧：
1.public class UserProfileViewModel extends ViewModel {
2.private LiveData
3.private UserRepository userRepo;
4.@Inject // UserRepository parameter is provided by Dagger 2
5.public UserProfileViewModel(UserRepository userRepo) {
6.this.userRepo = userRepo;
7.}
8.public void init(String userId) {
9.if (this.user != null) {
10.// ViewModel is created per Fragment so
11.// we know the userId won't change
12.return;
13.}
14.user = userRepo.getUser(userId);
15.}
16.public LiveData
17.return this.user;
18.}
19.}
缓存数据
在实际项目中，Repository 往往不会只有一个数据源。因此，我们这里在其中再加入缓存：
1.@Singleton // informs Dagger that this class should be constructed once
2.public class UserRepository {
3.private Webservice webservice;
4.// simple in memory cache, details omitted for brevity
5.private UserCache userCache;
6.public LiveData
7.LiveData
8.if (cached != null) {
9.return cached;
10.}
11.final MutableLiveData
12.userCache.put(userId, data);
13.// this is still suboptimal but better than before.
14.// a complete implementation must also handle the error cases.
15.webservice.getUser(userId).enqueue(new Callback
16.@Override
17.public void onResponse(Call
18.data.setValue(response.body());
19.}
20.});
21.return data;
22.}
23.}
持久化数据
现在当用户旋转屏幕或暂时离开应用再回来时，数据是直接可见的，因为是直接从缓存中获取的数据。但要是用户长时间关闭应用，并且 Android 还彻底杀死了进程呢？
我们目前的实现中，会再次从网络中获取数据。这可不是一个好的用户体验。这时就需要数据持久化了。继续引入一个新组件 Room。
Room 能帮助我们方便的实现本地数据持久化，抽象出了很多常用的数据库操作，并且在编译时会验证每个查询，从而损坏的 SQL 查询只会导致编译时错误，而不是运行时崩溃。还能和上面介绍的 LiveData 完美合作，并帮开发者处理了很多线程问题。
现在，让我们来看看怎么使用 Room 吧。: )
首先，在 User 类上面加上 @Entity，将 User 声明为你数据库中的一张表。
1.@Entity
2.class User {
3.@PrimaryKey
4.private int id;
5.private String name;
6.private String lastName;
7.// getters and setters for fields
8.}
再创建数据库类并继承 RoomDatabase：
1.@Database(entities = {User.class}, version = 1)
2.public abstract class MyDatabase extends RoomDatabase {
3.}
注意 MyDatabase 是一个抽象类，Room 会自动添加实现的。
现在我们需要一种方法来将用户数据插入到数据库：
1.@Dao
2.public interface UserDao {
3.@Insert(onConflict = REPLACE)
4.void save(User user);
5.@Query("SELECT * FROM user WHERE id = :userId")
6.LiveData
7.}
再在数据库类中加入 DAO：
1.@Database(entities = {User.class}, version = 1)
2.public abstract class MyDatabase extends RoomDatabase {
3.public abstract UserDao userDao();
4.}
注意上面的 load 方法返回的是 LiveData，Room 会知道什么时候数据库发生了变化并自动通知所有的观察者。这也就是 LiveData 和 Room 搭配的妙用。
现在继续修改 UserRepository：
1.@Singleton
2.public class UserRepository {
3.private final Webservice webservice;
4.private final UserDao userDao;
5.private final Executor executor;
6.@Inject
7.public UserRepository(Webservice webservice, UserDao userDao, Executor executor) {
8.this.webservice = webservice;
9.this.userDao = userDao;
10.this.executor = executor;
11.}
12.public LiveData
13.refreshUser(userId);
14.// return a LiveData directly from the database.
15.return userDao.load(userId);
16.}
17.private void refreshUser(final String userId) {
18.executor.execute(() -> {
19.// running in a background thread
20.// check if user was fetched recently
21.boolean userExists = userDao.hasUser(FRESH_TIMEOUT);
22.if (!userExists) {
23.// refresh the data
24.Response response = webservice.getUser(userId).execute();
25.// TODO check for error etc.
26.// Update the database.The LiveData will automatically refresh so
27.// we don't need to do anything else here besides updating the database
28.userDao.save(response.body());
29.}
30.});
31.}
32.}
可以看到，即使我们更改了 UserRepository 中的数据源，我们也完全不需要修改 ViewModel 和 Fragment，这就是抽象的好处。同时还非常适合测试，我们可以在测试 UserProfileViewModel 时提供测试用的 UserRepository。
下面部分的内容在原文中是作为附录，但我个人觉得也很重要，所以擅自挪上来，一起为大家介绍了。: )
在上面的例子中，有心的大家可能发现了我们没有处理网络错误和正在加载状态。但在实际开发中其实是很重要的。这里，我们就实现一个工具类来根据不同的网络状况选择不同的数据源。
首先，实现一个 Resource 类：
1.//a generic class that describes a data with a status
2.public class Resource
3.@NonNull public final Status status;
4.@Nullable public final T data;
5.@Nullable public final String message;
6.private Resource(@NonNull Status status, @Nullable T data, @Nullable String message) {
7.this.status = status;
8.this.data = data;
9.this.message = message;
10.}
11.public static
12.return new Resource<>(SUCCESS, data, null);
13.}
14.public static
15.return new Resource<>(ERROR, data, msg);
16.}
17.public static
18.return new Resource<>(LOADING, data, null);
19.}
20.}
因为，从网络加载数据和从磁盘加载是很相似的，所以再新建一个 NetworkBoundResource 类，方便多处复用。下面是 NetworkBoundResource 的决策树：
API 设计：
1.// ResultType: Type for the Resource data
2.// RequestType: Type for the API response
3.public abstract class NetworkBoundResource
4.// Called to save the result of the API response into the database
5.@WorkerThread
6.protected abstract void saveCallResult(@NonNull RequestType item);
7.// Called with the data in the database to decide whether it should be
8.// fetched from the network.
9.@MainThread
10.protected abstract boolean shouldFetch(@Nullable ResultType data);
11.// Called to get the cached data from the database
12.@NonNull @MainThread
13.protected abstract LiveData
14.// Called to create the API call.
15.@NonNull @MainThread
16.protected abstract LiveData
17.// Called when the fetch fails. The child class may want to reset components
18.// like rate limiter.
19.@MainThread
20.protected void onFetchFailed() {
21.}
22.// returns a LiveData that represents the resource
23.public final LiveData
24.return result;
25.}
26.}
注意上面使用了 ApiResponse 作为网络请求， ApiResponse 是对于 Retrofit2.Call 的简单包装，用于将其响应转换为 LiveData。
下面是具体的实现：
1.public abstract class NetworkBoundResource
2.private final MediatorLiveData
3.@MainThread
4.NetworkBoundResource() {
5.result.setValue(Resource.loading(null));
6.LiveData
7.result.addSource(dbSource, data -> {
8.result.removeSource(dbSource);
9.if (shouldFetch(data)) {
10.fetchFromNetwork(dbSource);
11.} else {
12.result.addSource(dbSource,
13.newData -> result.setValue(Resource.success(newData)));
14.}
15.});
16.}
17.private void fetchFromNetwork(final LiveData
18.LiveData
19.// we re-attach dbSource as a new source,
20.// it will dispatch its latest value quickly
21.result.addSource(dbSource,
22.newData -> result.setValue(Resource.loading(newData)));
23.result.addSource(apiResponse, response -> {
24.result.removeSource(apiResponse);
25.result.removeSource(dbSource);
26.//noinspection ConstantConditions
27.if (response.isSuccessful()) {
28.saveResultAndReInit(response);
29.} else {
30.onFetchFailed();
31.result.addSource(dbSource,
32.newData -> result.setValue(
33.Resource.error(response.errorMessage, newData)));
34.}
35.});
36.}
37.@MainThread
38.private void saveResultAndReInit(ApiResponse
39.new AsyncTask
40.@Override
41.protected Void doInBackground(Void... voids) {
42.saveCallResult(response.body);
43.return null;
44.}
45.@Override
46.protected void onPostExecute(Void aVoid) {
47.// we specially request a new live data,
48.// otherwise we will get immediately last cached value,
49.// which may not be updated with latest results received from network.
50.result.addSource(loadFromDb(),
51.newData -> result.setValue(Resource.success(newData)));
52.}
53.}.execute();
54.}
55.}
现在，我们就能使用 NetworkBoundResource 来根据不同的情况获取数据了：
1.class UserRepository {
2.Webservice webservice;
3.UserDao userDao;
4.public LiveData
5.return new NetworkBoundResource
6.@Override
7.protected void saveCallResult(@NonNull User item) {
8.userDao.insert(item);
9.}
10.@Override
11.protected boolean shouldFetch(@Nullable User data) {
12.return rateLimiter.canFetch(userId) && (data == null || !isFresh(data));
13.}
14.@NonNull @Override
15.protected LiveData
16.return userDao.load(userId);
17.}
18.@NonNull @Override
19.protected LiveData
20.return webservice.getUser(userId);
21.}
22.}.getAsLiveData();
23.}
24.}
到这里，我们的代码就全部完成了。最后的架构看起来就像这样：
最后的最后，给出一些指导原则
下面的原则虽然不是强制性的，但根据我们的经验遵循它们能使您的代码更健壮、可测试和可维护的。
所有您在 manifest 中定义的组件 - activity, service, broadcast receiver… 都不是数据源。因为每个组件的生命周期都相当短，并取决于当前用户与设备的交互和系统的运行状况。简单来说，这些组件都不应当作为应用的数据源。
在您应用的各个模块之间建立明确的责任边界。比如，不要将与数据缓存无关的代码放在同一个类中。
每个模块尽可能少的暴露内部实现。从过去的经验来看，千万不要为了一时的方便而直接将大量的内部实现暴露出去。这会让你在以后承担很重的技术债务（很难更换新技术）。
在您定义模块间交互时，请考虑如何使每个模块尽量隔离，通过设计良好的 API 来进行交互。
您应用的核心应该是能让它脱颖而出的某些东西。不要浪费时间重复造轮子或一次次编写同样的模板代码。相反，应当集中精力在使您的应用独一无二，而将一些重复的工作交给这里介绍的 Android Architecture Components 或其他优秀的库。
尽可能持久化数据，以便您的应用在脱机模式下依然可用。虽然您可能享受着快捷的网络，但您的用户可能不会。