深入XSnow源码:CacheAndRemoteStrategy如何用RxJava优雅编排缓存与远程数据流?
深入XSnow源码:CacheAndRemoteStrategy如何用RxJava优雅编排缓存与远程数据流?
XSnow 是一个基于 RxJava2 + Retrofit2 打造的 Android 基础框架,涵盖网络、上传、下载、缓存、事件总线、权限管理、数据库、图片加载等项目中必用功能,且每个模块充分解耦。本文深入其缓存子系统的核心策略 CacheAndRemoteStrategy(缓存+网络双通道策略),看看它如何用 RxJava 的 Observable.concat 优雅编排"本地缓存"与"网络请求"两条数据流,实现首屏秒开 + 数据刷新的经典体验。
为什么需要"缓存 + 网络"双通道策略
打开 App 页面时,用户有两层期望:
- 📌 立即看到内容:从本地缓存读取上一次的数据,首屏不用等待;
- ⚡ 内容保持最新:网络数据返回后,刷新为服务端最新内容。
这意味着一次请求需要回调两次——第一次给缓存数据,第二次给网络数据。这正是 CACHE_AND_REMOTE 模式的设计目标。
XSnow 在 http 包下的 strategy 目录 中共提供五种缓存策略,由 CacheMode.java 枚举统一映射:
| 策略类 | CacheMode 枚举 | 行为 |
|---|---|---|
| OnlyRemoteStrategy | ONLY_REMOTE |
仅取网络,但数据仍会写入缓存 |
| OnlyCacheStrategy | ONLY_CACHE |
只读本地缓存 |
| FirstRemoteStrategy | FIRST_REMOTE |
网络优先,失败后回退缓存 |
| FirstCacheStrategy | FIRST_CACHE |
缓存优先,无缓存才走网络(只回调一次) |
| CacheAndRemoteStrategy | CACHE_AND_REMOTE |
先缓存后网络,回调两次 |
五种策略共用的地基:CacheStrategy 抽象基类
CacheStrategy.java 是所有策略的抽象基类,它把"取缓存"和"取网络"封装成两个可复用的数据流构建方法:
loadCache:通过ApiCache.get(key)从磁盘读取 JSON,filter过滤空值,map用 Gson 反序列化为业务对象,并包装成CacheResult(isCache = true);loadRemote:把网络接口返回的Observable<T>用map包装成CacheResult(isCache = false),同时在 IO 线程异步回写新数据到磁盘缓存,为下一次冷启动备好数据。
这里的关键设计是 CacheResult.java——一个带 isCache 标志的统一包装类,上层回调只需判断 cacheResult.isCache(),就能知道这次数据来自缓存还是网络,无需关心数据是怎么来的。
核心拆解:execute() 里的三行魔法
打开 CacheAndRemoteStrategy.java,整个 execute() 方法只有寥寥数行:
Observable<CacheResult<T>> cache = loadCache(apiCache, cacheKey, type);
final Observable<CacheResult<T>> remote = loadRemote(apiCache, cacheKey, source);
return Observable.concat(cache, remote).filter(tCacheResult ->
tCacheResult != null && tCacheResult.getCacheData() != null);
逐行解读这三行:
- 两条流独立构建:
cache和remote此时只是"蓝图",RxJava 的惰性机制保证订阅前不执行任何 IO; Observable.concat串行编排:这是整个策略的灵魂。concat 保证先订阅缓存流,待其onComplete之后才订阅网络流,天然实现了"缓存先到、网络随后"的时序,无需任何手动同步代码;filter统一兜底:空结果在此被静默滤掉——没有缓存时loadCache不发出任何值,网络流照常工作,代码不需要额外的"有无缓存"分支。
💡 对比着看更有收获:FirstCacheStrategy.java 与它几乎一模一样,唯一的差别是末尾多了一个 .firstElement().toObservable()——取到第一个有效值就提前结束流,因此只回调一次。有无 firstElement 这一个算子之差,就决定了"回调两次"与"回调一次"的语义差异,这就是 RxJava 组合算子表达业务语义的魅力。
横向对比:不同"编排方式"如何对应不同语义
五种策略的差异,本质只是对 Observable 的不同组合方式:
| 策略 | 编排方式 | 回调次数 |
|---|---|---|
OnlyRemote / OnlyCache |
直接返回单条流,无需拼接 | 0~1 次 |
FirstRemote |
concatDelayError(remote, cache) + onErrorReturn + firstElement,网络失败降级为 null 后仍可落到缓存流 |
0~1 次 |
FirstCache |
concat(cache, remote) + firstElement |
0~1 次 |
CacheAndRemote |
concat(cache, remote) + filter,不加 firstElement |
0~2 次 |
可以看到,框架没有写一行流程控制代码,全部语义都由算子组合表达,新增策略也只需继承基类、重写 execute() 即可,扩展成本极低。
调用链路:一次请求如何走到策略
结合 demo 中的 NetTestActivity.java,完整链路如下:
ViseHttp.GET("getAuthor")
.tag("request_get_6")
.setLocalCache(true)
.cacheMode(CacheMode.CACHE_AND_REMOTE)
.request(new ACallback<CacheResult<AuthorModel>>() {
@Override
public void onSuccess(CacheResult<AuthorModel> cacheResult) {
if (cacheResult.isCache()) {
// 第一次回调:缓存数据 → 首屏立即渲染
} else {
// 第二次回调:网络数据 → 刷新为最新内容
}
}
});
- 链式配置开启本地缓存并指定
CACHE_AND_REMOTE模式(见 BaseHttpRequest.java 的setLocalCache/cacheMode); - GetRequest.cacheExecute 用
compose把缓存管道"嫁接"到网络 Observable 上; - ApiCache.transformer 内部通过
loadStrategy(cacheMode)按类名反射实例化策略——这就是 CacheMode 枚举里每个值都绑定一个策略类名的原因; - 若使用回调风格,ApiCallbackSubscriber 会把两个
CacheResult依次透传给onSuccess,界面先渲染缓存、再刷新网络结果。
小结
- 🎯 策略 = 算子的组合方式:
concat定时序、firstElement定回调次数、filter做空值兜底、onErrorReturn做降级; - 🎯
CacheResult统一包装两条数据源,isCache标志让上层对数据来源一目了然; - 🎯 接口(
ICacheStrategy)+ 抽象基类 + 枚举反射的三层设计,使新增一种缓存策略只需三个步骤:建类、继承、加枚举项。
理解 CacheAndRemoteStrategy 后,再回头看其他四个策略,你会发现它们不过是同一套编排积木的不同拼法——这正是 XSnow 这套缓存子系统值得细品之处。