微信号:PiasyDev

介绍:也许,回归本源,和团队一起,解决问题,又快又好,才是最重要的. NEVER STOP Piasy

RESTful 安卓网络层解决方案(三):API model 与 Business model 分离

2016-09-09 07:44 Piasy

拆轮子系列:拆 Okio 最后我曾说过会对 Retrofit、OkHttp、Okio 三者进行一个小结,并且整理一套网络层的“微架构”,今天终于得以完成,在这里一起奉送给大家 :)

1,API model “碎片化”

当我们的服务端程序是用动态类型语言(例如 PHP)编写的时候,那我们得到的 API 响应就可能会比较杂乱了。

例如根据 id 获取用户信息的 API:


这是非好友的情况,如果是好友,情况又还不一样:


好友比非好友多了 is_friendfriend_remarkstarred 这三个字段。

而如果获取自己的信息,又还不一样:


相比于非好友,多了 phonetokenim_password 这三个字段。

一方面,服务端要践行信息隐藏的原则,不需要的数据就坚决不返回,这就造成即便返回的都是同样的东西(例如用户信息),但返回的字段组合却是多种多样的;另一方面,服务端使用动态类型,无需为每种字段组合创建一个类型,只需要返回时进行组装即可,这就进一步加剧了字段组合“碎片化”的问题。

如何解决这一问题呢?为每种组合创建一个类,还是把所有的字段都揉进一个类?

2,解决方案

上面最后提到的两种办法都有问题,但我们把它们可以结合起来。

首先,对于和 API 打交道的代码,我们把所有字段都装进一个类型,ApiUser。否则我们就需要定义三个 API 了,而这基本上是不可行的,当我们要获取一个用户的信息时,调用哪个接口,好友还是非好友?我们根本不知道是不是好友!

但紧接着,对于和上层业务打交道的代码,我们要分别定义不同的类型,SelfFriendNonFriend,绝不包含无用的信息。并且我们把 API 隐藏起来,外部不可访问,对外暴露的接口都要把 ApiUser 转换为相应的 Business model。

3,具体实现

首先,我们把所有的用户信息字段拆分为多个接口,遵循接口隔离。之所以使用接口而不是抽象类,是为了后面进行组合时可以多实现。

3.1,用户信息接口


其中 UserInfoModelFriendInfoModel 是由 SqlDelight 生成,用于进行持久化,它们都需要靠 uid 进行查询,所以都包含一个 uid 字段。RelationshipInfo 用于区分是否是好友,CredentialInfo 则包含自己的信息。

接下来的内容会涉及到 SqlDelight、AutoValue 及其扩展相关的内容,对这些不熟悉的朋友,强烈建议先看一下这篇文章:完美的安卓 model 层架构(上)

3.2,ApiUser

我们的 ApiUser 要把所有的字段都包含进来,所以要实现上面的所有接口:


尽管 UserInfoModelFriendInfoModel 都包含 uid() 接口,但它们组合到一起的时候,ApiUser 只会获得一个 uid() 接口,所以没有问题。这边我们利用 auto-value 实现 immutable,利用 auto-value-gson 实现高效的 Gson 转换。

3.3,NonFriend


NonFriend 只包含了基本的用户信息,它实现了 Parcelable,以便在 Activity/Fragment 之间进行传递。它还提供了一个从 ApiUser 转换的工厂方法。

3.4,Friend


Friend 使用组合的方式加入 FriendInfo,因为 FriendInfo 是需要单独持久化的,所以它需要是一个单独的类型。

3.5,Self


至此,API model 和 Business model 都已经定义好了,接下来我们需要把 API 的结果转化为对应的 model。

3.6,API model -> Business model


API、DB、类型转换的逻辑也并不复杂:

  1. mUserDbAccessor 负责封装数据库访问,我们先尝试从数据库读取缓存。

  2. 如果缓存命中,我们就从 mFriendDbAccessor 中尝试获取好友信息。

  3. 如果没有好友信息,那我们就认为这个用户是 NonFriend。这里我们有一个假设,所有好友都一定会保存好友信息。

  4. 如果有好友信息,那我们就组合出 Friend 返回。

  5. 调用 API 时,获取到的是 ApiUser,我们需要将其转换为 Friend/NonFriend。

  6. 我们利用 concat 把缓存和网络连接起来。

  7. 如果不需要刷新本地缓存,我们直接返回连接结果的第一个即可。

  8. 利用 is_friend,我们可以确定 ApiUser 是否为 Friend。

  9. 保存用户信息时,如果是好友,我们还需要保存 FriendInfo。

4,单元测试


这边我们测例其实并没有做到覆盖所有情形,稍微偷了一下懒,但我们有信心,经过这样的测试,代码已经可靠了。万一真的出了错误,到时候再加上相应的测例,小概率事件到时再说嘛 :)

这里测试代码比较类似,只展示“刷新本地缓存、缓存命中、对方是好友的情形”:


  1. 我们准备好要返回的 ApiUser、FriendInfo、Friend、NonFriend 信息。

  2. 尽管让 mUserDbAccessor 返回 Friend 语法上没问题,但逻辑上是不会发生的,所以我们还是返回 NonFriend。

  3. 因为我们刷新了本地缓存,而且缓存命中、API 返回数据了,所以我们最终会收到两个 Friend。

  4. 我们对 mFriendDbAccessor 和 mUserDbAccessor 都进行了一次查询操作。

  5. 我们对 API 进行了一次调用。

  6. 我们对 mFriendDbAccessor 和 mUserDbAccessor 都进行了一次保存操作。

5,总结

网络层微架构的内容,本来是只打算写一篇文章的。但是后来发现内容太长,而且没有明确加上单元测试的内容,所以最终把单元测试内容完整加上,拆分为了三篇内容。希望大家能意识到测试代码的重要性:

既然无论手工还是测例,总归是要测试的,那我们何不稍微多花一点工夫,编写单元测试呢?

这套微架构主要包含三部分内容:

而每一部分都包含了尽可能详尽的单元测试,目前看来是最好水平了,已经使出了洪荒之力 😄

希望大家喜欢,欢迎留言讨论!

Bonus:拆轮子与 model 层架构推荐

前段时间拆轮子系列的前三篇,分别对 RetrofitOkHttpOkio 源码进行了分析和源码导读,发布之后大家反馈还不错,其中拆 OkHttp 篇成功登上开发者头条榜首。没有看过的朋友建议大家可以看一看:

此外,之前整理的安卓 model 层架构,有幸还在 GDG 进行了一次分享,大家反响也还不错,在这里也推荐大家看一看:

  • 完美的安卓 model 层架构(上)

    • http://mp.weixin.qq.com/s?__biz=MzA4MjU5NTY0NA==&mid=2653418653&idx=1&sn=e723665f73936a32f315771d78ac9d6a&scene=1&srcid=0904fROaGjG4263JIpKSmggO#rd

  • 完美的安卓 model 层架构(下)

    • http://mp.weixin.qq.com/s?__biz=MzA4MjU5NTY0NA==&mid=2653418696&idx=1&sn=16a75cebf5b58c97f962934e9883d142&scene=1&srcid=0904eXWlXAflrHDHy7J2litp#rd

  • 08/07 北京 GDG Android Meetup 活动回顾,讲义,照片

    • http://mp.weixin.qq.com/s?__biz=MzA5MDg3MjczMg==&mid=2652003543&idx=1&sn=849c06ac198cbfe9cdcfae90b2a17021&scene=1&srcid=0902QGgAZZKCpZbNNPD66mnu#rd

 
Piasy 更多文章 Reactive-Streams API(一):概览 RESTful 安卓网络层解决方案(二):空 JSON 和 API Error 解析 RESTful 安卓网络层解决方案(一):概览与认证实现方案 调度器 Scheduler(四,完结):实现 GUI 系统的 Scheduler RxJava 复杂场景(一):高级缓存
猜您喜欢 编程工作坊的回顾与分享 学习React Native必看的几个开源项目(第一波) 关于RESTful规范API接口设计的7点实用建议 IBM宣布在云端部署新型高级Watson API接口 尊享专属,IBM Bluemix微课堂第三讲“API平台解决方案-APIC”