google 官方推出应用开发架构指南 -买球官网平台

最近，官方推出了一份关于应用架构的最佳实践指南。这里就给大家简要介绍一下：

首先，android 开发者肯定都知道 android 中有四大组件，这些组件都有各自的生命周期并且在一定程度上是不受你控制的。在任何时候，android 操作系统都可能根据用户的行为或资源紧张等原因回收掉这些组件。

这也就引出了第一条准则：「不要在应用程序组件中保存任何应用数据或状态，并且组件间也不应该相互依赖」。

最常见的错误就是在 activity 或 fragment 中写了与 ui 和交互无关的代码。尽可能减少对它们的依赖，这能避免大量生命周期导致的问题，以提供更好的用户体验。

第二条准则：「通过 model 驱动应用 ui，并尽可能的持久化」。
这样做主要有两个原因：

• 如果系统回收了你的应用资源或其他什么意外情况，不会导致用户丢失数据。
• model 就应该是负责处理应用程序数据的组件。独立于视图和应用程序组件，保持了视图代码的简单，也让你的应用逻辑更容易管理。并且，将应用数据置于 model 类中，也更有利于测试。

官方推荐的 app 架构

在这里，官方演示了通过使用最新推出的 来构建一个应用。

想象一下，您正在打算开发一个显示用户个人信息的界面，用户数据通过 rest api 从后端获取。

首先，我们需要创建三个文件：

• user_profile.xml：定义界面。
• userprofileviewmodel.java：数据类。
• userprofilefragment.java：显示 viewmodel 中的数据并对用户的交互做出反应。

为了简单起见，我们这里就省略掉布局文件。

public class userprofileviewmodel extends viewmodel {
    private string userid;
    private user user;
    public void init(string userid) {
        this.userid = userid;
    }
    public user getuser() {
        return user;
    }
}

public class userprofilefragment extends lifecyclefragment {
    private static final string uid_key = "uid";
    private userprofileviewmodel viewmodel;
    @override
    public void onactivitycreated(@nullable bundle savedinstancestate) {
        super.onactivitycreated(savedinstancestate);
        string userid = getarguments().getstring(uid_key);
        viewmodel = viewmodelproviders.of(this).get(userprofileviewmodel.class);
        viewmodel.init(userid);
    }
    @override
    public view oncreateview(layoutinflater inflater,
                @nullable viewgroup container, @nullable bundle savedinstancestate) {
        return inflater.inflate(r.layout.user_profile, container, false);
    }
}

注意其中的 viewmodel 和 lifecyclefragment 都是 android 新引入的，可以参考进行集成。

现在，我们完成了这三个模块，该如何将它们联系起来呢？也就是当 viewmodel 中的用户字段被设置时，我们需要一种方法来通知 ui。这就是 livedata 的用武之地了。

所以，现在我们来修改一下 userprofileviewmodel：

public class userprofileviewmodel extends viewmodel {
    ...
    private livedata user;
    public livedata getuser() {
        return user;
    }
}

再在 userprofilefragment 中对其进行观察并更新我们的 ui：

@override
public void onactivitycreated(@nullable bundle savedinstancestate) {
    super.onactivitycreated(savedinstancestate);
    viewmodel.getuser().observe(this, user -> {
      // update ui
    });
}

获取数据
现在，我们联系了 viewmodel 和 fragment，但 viewmodel 又怎么来获取到数据呢？

在这个示例中，我们假定后端提供了 rest api，因此我们选用 来访问我们的后端。

首先，定义一个 webservice：

public interface webservice {
    /**
     * @get declares an http get request
     * @path("user") annotation on the userid parameter marks it as a
     * replacement for the {user} placeholder in the @get path
     */
    @get("/users/{user}")
    call getuser(@path("user") string userid);
}

不要通过 viewmodel 直接来获取数据，这里我们将工作转交给一个新的 repository 模块。

public class userrepository {
    private webservice webservice;
    // ...
    public livedata getuser(int userid) {
        // this is not an optimal implementation, we'll fix it below
        final mutablelivedata data = new mutablelivedata<>();
        webservice.getuser(userid).enqueue(new callback() {
            @override
            public void onresponse(call call, response response) {
                // error case is left out for brevity
                data.setvalue(response.body());
            }
        });
        return data;
    }
}

管理组件间的依赖关系

根据上面的代码，我们可以看到 userrepository 中有一个 webservice 的实例，不要直接在 userrepository 中 new 一个 webservice。这很容易导致代码的重复与复杂化，比如 userrepository 很可能不是唯一用到 webservice 的类，如果每个用到的类都新建一个 webservice，这显示会导致资源的浪费。
这里，我们推荐使用 来管理这些依赖关系。

现在，让我们来把 viewmodel 和 repository 连接起来吧：

public class userprofileviewmodel extends viewmodel {
    private livedata user;
    private userrepository userrepo;
    @inject // userrepository parameter is provided by dagger 2
    public userprofileviewmodel(userrepository userrepo) {
        this.userrepo = userrepo;
    }
    public void init(string userid) {
        if (this.user != null) {
            // viewmodel is created per fragment so
            // we know the userid won't change
            return;
        }
        user = userrepo.getuser(userid);
    }
    public livedata getuser() {
        return this.user;
    }
}

缓存数据

在实际项目中，repository 往往不会只有一个数据源。因此，我们这里在其中再加入缓存：

@singleton  // informs dagger that this class should be constructed once
public class userrepository {
    private webservice webservice;
    // simple in memory cache, details omitted for brevity
    private usercache usercache;
    public livedata getuser(string userid) {
        livedata cached = usercache.get(userid);
        if (cached != null) {
            return cached;
        }
        final mutablelivedata data = new mutablelivedata<>();
        usercache.put(userid, data);
        // this is still suboptimal but better than before.
        // a complete implementation must also handle the error cases.
        webservice.getuser(userid).enqueue(new callback() {
            @override
            public void onresponse(call call, response response) {
                data.setvalue(response.body());
            }
        });
        return data;
    }
}

持久化数据

现在当用户旋转屏幕或暂时离开应用再回来时，数据是直接可见的，因为是直接从缓存中获取的数据。但要是用户长时间关闭应用，并且 android 还彻底杀死了进程呢？

我们目前的实现中，会再次从网络中获取数据。这可不是一个好的用户体验。这时就需要数据持久化了。继续引入一个新组件 。

现在，让我们来看看怎么使用 room 吧。: )

首先，在 user 类上面加上 @entity，将 user 声明为你数据库中的一张表。

@entity
class user {
  @primarykey
  private int id;
  private string name;
  private string lastname;
  // getters and setters for fields
}

再创建数据库类并继承 roomdatabase：

@database(entities = {user.class}, version = 1)
public abstract class mydatabase extends roomdatabase {
}

注意 mydatabase 是一个抽象类，room 会自动添加实现的。

现在我们需要一种方法来将用户数据插入到数据库：

@dao
public interface userdao {
    @insert(onconflict = replace)
    void save(user user);
    @query("select * from user where id = :userid")
    livedata load(string userid);
}

再在数据库类中加入 dao：

@database(entities = {user.class}, version = 1)
public abstract class mydatabase extends roomdatabase {
    public abstract userdao userdao();
}

注意上面的 load 方法返回的是 livedata，room 会知道什么时候数据库发生了变化并自动通知所有的观察者。这也就是 livedata 和 room 搭配的妙用。

现在继续修改 userrepository：

@singleton
public class userrepository {
    private final webservice webservice;
    private final userdao userdao;
    private final executor executor;
    @inject
    public userrepository(webservice webservice, userdao userdao, executor executor) {
        this.webservice = webservice;
        this.userdao = userdao;
        this.executor = executor;
    }
    public livedata getuser(string userid) {
        refreshuser(userid);
        // return a livedata directly from the database.
        return userdao.load(userid);
    }
    private void refreshuser(final string userid) {
        executor.execute(() -> {
            // running in a background thread
            // check if user was fetched recently
            boolean userexists = userdao.hasuser(fresh_timeout);
            if (!userexists) {
                // refresh the data
                response response = webservice.getuser(userid).execute();
                // todo check for error etc.
                // update the database.the livedata will automatically refresh so
                // we don't need to do anything else here besides updating the database
                userdao.save(response.body());
            }
        });
    }
}

可以看到，即使我们更改了 userrepository 中的数据源，我们也完全不需要修改 viewmodel 和 fragment，这就是抽象的好处。同时还非常适合测试，我们可以在测试 userprofileviewmodel 时提供测试用的 userrepository。

在上面的例子中，有心的大家可能发现了我们没有处理网络错误和正在加载状态。但在实际开发中其实是很重要的。这里，我们就实现一个工具类来根据不同的网络状况选择不同的数据源。

首先，实现一个 resource 类：

//a generic class that describes a data with a status
public class resource {
    @nonnull public final status status;
    @nullable public final t data;
    @nullable public final string message;
    private resource(@nonnull status status, @nullable t data, @nullable string message) {
        this.status = status;
        this.data = data;
        this.message = message;
    }
    public static  resource success(@nonnull t data) {
        return new resource<>(success, data, null);
    }
    public static  resource error(string msg, @nullable t data) {
        return new resource<>(error, data, msg);
    }
    public static  resource loading(@nullable t data) {
        return new resource<>(loading, data, null);
    }
}

因为，从网络加载数据和从磁盘加载是很相似的，所以再新建一个 networkboundresource 类，方便多处复用。下面是 networkboundresource 的决策树：

api 设计：

// resulttype: type for the resource data
// requesttype: type for the api response
public abstract class networkboundresource {
    // called to save the result of the api response into the database
    @workerthread
    protected abstract void savecallresult(@nonnull requesttype item);
    // called with the data in the database to decide whether it should be
    // fetched from the network.
    @mainthread
    protected abstract boolean shouldfetch(@nullable resulttype data);
    // called to get the cached data from the database
    @nonnull @mainthread
    protected abstract livedata loadfromdb();
    // called to create the api call.
    @nonnull @mainthread
    protected abstract livedata> createcall();
    // called when the fetch fails. the child class may want to reset components
    // like rate limiter.
    @mainthread
    protected void onfetchfailed() {
    }
    // returns a livedata that represents the resource
    public final livedata> getaslivedata() {
        return result;
    }
}

注意上面使用了 apiresponse 作为网络请求， apiresponse 是对于 retrofit2.call 的简单包装，用于将其响应转换为 livedata。

下面是具体的实现：

public abstract class networkboundresource {
    private final mediatorlivedata> result = new mediatorlivedata<>();
    @mainthread
    networkboundresource() {
        result.setvalue(resource.loading(null));
        livedata dbsource = loadfromdb();
        result.addsource(dbsource, data -> {
            result.removesource(dbsource);
            if (shouldfetch(data)) {
                fetchfromnetwork(dbsource);
            } else {
                result.addsource(dbsource,
                        newdata -> result.setvalue(resource.success(newdata)));
            }
        });
    }
    private void fetchfromnetwork(final livedata dbsource) {
        livedata> apiresponse = createcall();
        // we re-attach dbsource as a new source,
        // it will dispatch its latest value quickly
        result.addsource(dbsource,
                newdata -> result.setvalue(resource.loading(newdata)));
        result.addsource(apiresponse, response -> {
            result.removesource(apiresponse);
            result.removesource(dbsource);
            //noinspection constantconditions
            if (response.issuccessful()) {
                saveresultandreinit(response);
            } else {
                onfetchfailed();
                result.addsource(dbsource,
                        newdata -> result.setvalue(
                                resource.error(response.errormessage, newdata)));
            }
        });
    }
    @mainthread
    private void saveresultandreinit(apiresponse response) {
        new asynctask() {
            @override
            protected void doinbackground(void... voids) {
                savecallresult(response.body);
                return null;
            }
            @override
            protected void onpostexecute(void avoid) {
                // we specially request a new live data,
                // otherwise we will get immediately last cached value,
                // which may not be updated with latest results received from network.
                result.addsource(loadfromdb(),
                        newdata -> result.setvalue(resource.success(newdata)));
            }
        }.execute();
    }
}

现在，我们就能使用 networkboundresource 来根据不同的情况获取数据了：

class userrepository {
    webservice webservice;
    userdao userdao;
    public livedata> loaduser(final string userid) {
        return new networkboundresource() {
            @override
            protected void savecallresult(@nonnull user item) {
                userdao.insert(item);
            }
            @override
            protected boolean shouldfetch(@nullable user data) {
                return ratelimiter.canfetch(userid) && (data == null || !isfresh(data));
            }
            @nonnull @override
            protected livedata loadfromdb() {
                return userdao.load(userid);
            }
            @nonnull @override
            protected livedata> createcall() {
                return webservice.getuser(userid);
            }
        }.getaslivedata();
    }
}

到这里，我们的代码就全部完成了。最后的架构看起来就像这样：

最后的最后，给出一些指导原则

下面的原则虽然不是强制性的，但根据我们的经验遵循它们能使您的代码更健壮、可测试和可维护的。

• 所有您在 manifest 中定义的组件 - activity, service, broadcast receiver… 都不是数据源。因为每个组件的生命周期都相当短，并取决于当前用户与设备的交互和系统的运行状况。简单来说，这些组件都不应当作为应用的数据源。
• 在您应用的各个模块之间建立明确的责任边界。比如，不要将与数据缓存无关的代码放在同一个类中。
• 每个模块尽可能少的暴露内部实现。从过去的经验来看，千万不要为了一时的方便而直接将大量的内部实现暴露出去。这会让你在以后承担很重的技术债务（很难更换新技术）。
• 在您定义模块间交互时，请考虑如何使每个模块尽量隔离，通过设计良好的 api 来进行交互。
• 您应用的核心应该是能让它脱颖而出的某些东西。不要浪费时间重复造轮子或一次次编写同样的模板代码。相反，应当集中精力在使您的应用独一无二，而将一些重复的工作交给这里介绍的 android architecture components 或其他优秀的库。
• 尽可能持久化数据，以便您的应用在脱机模式下依然可用。虽然您可能享受着快捷的网络，但您的用户可能不会。

来自: