给 Java 和 Android 构建一个简单的响应式Local Cache
一. 为什么要建立这个库
首先，Local Cache 不是相似于 Redis、Couchbase、Memcached 这样的分布式 Cache。Local Cache 适用于在单机环境下，对访问频率高、更新次数少的数据进行存放。所以，Local Cache 不适合存放大量的数据。java
Local Cache 特别适合于 App，也适合在 Java 的某些场景下使用。react
咱们的 App 使用 Retrofit 做为网络框架，而且大量使用 RxJava，所以我考虑建立一个 RxCache 来缓存一些必要的数据。git
RxCache 地址：github.com/fengzhizi71…github
二. 如何构建 RxCache
2.1 RxCache 的基本方法
对于 Local Cache，最重要是须要有如下的这些方法：算法
<T> Record<T> get(String key, Type type);
<T> void save(String key, T value);
<T> void save(String key, T value, long expireTime);
boolean containsKey(String key);
Set<String> getAllKeys();
void remove(String key);
void clear();
复制代码
其中，有一个 save() 方法包含了失效时间的参数expireTime，这对于 Local Cache 是比较重要的一个方法，超过这个时间，这个数据将会失效。spring
既然是 RxCache，对于获取数据确定须要相似这样的方法：json
<T> Observable<Record<T>> load2Observable(final String key, final Type type) ;
<T> Flowable<Record<T>> load2Flowable(final String key, final Type type);
<T> Single<Record<T>> load2Single(final String key, final Type type);
<T> Maybe<Record<T>> load2Maybe(final String key, final Type type);
复制代码
也须要一些 Transformer 的方法，将 RxJava 的被观察者进行转换。在 RxCache 中，包含了一些默认的 Transformer 策略，特别是使用 Retrofit 和 RxJava 时，能够考虑结合这些策略来缓存数据。缓存
以 CacheFirstStrategy 为例：网络
/** * 缓存优先的策略，缓存取不到时取接口的数据。 * Created by tony on 2018/9/30. */
public class CacheFirstStrategy implements ObservableStrategy, FlowableStrategy, MaybeStrategy {
@Override
public <T> Publisher<Record<T>> execute(RxCache rxCache, String key, Flowable<T> source, Type type) {
Flowable<Record<T>> cache = rxCache.<T>load2Flowable(key, type);
Flowable<Record<T>> remote = source
.map(new Function<T, Record<T>>() {
@Override
public Record<T> apply(@NonNull T t) throws Exception {
rxCache.save(key, t);
return new Record<>(Source.CLOUD, key, t);
}
});
return cache.switchIfEmpty(remote);
}
@Override
public <T> Maybe<Record<T>> execute(RxCache rxCache, String key, Maybe<T> source, Type type) {
Maybe<Record<T>> cache = rxCache.<T>load2Maybe(key, type);
Maybe<Record<T>> remote = source
.map(new Function<T, Record<T>>() {
@Override
public Record<T> apply(@NonNull T t) throws Exception {
rxCache.save(key, t);
return new Record<>(Source.CLOUD, key, t);
}
});
return cache.switchIfEmpty(remote);
}
@Override
public <T> Observable<Record<T>> execute(RxCache rxCache, String key, Observable<T> source, Type type) {
Observable<Record<T>> cache = rxCache.<T>load2Observable(key, type);
Observable<Record<T>> remote = source
.map(new Function<T, Record<T>>() {
@Override
public Record<T> apply(@NonNull T t) throws Exception {
rxCache.save(key, t);
return new Record<>(Source.CLOUD, key, t);
}
});
return cache.switchIfEmpty(remote);
}
}
复制代码
2.2 Memory
RxCache 包含了两级缓存： Memory 和 Persistence 。架构
Memory：
package com.safframework.rxcache.memory;
import com.safframework.rxcache.domain.Record;
import java.util.Set;
/** * Created by tony on 2018/9/29. */
public interface Memory {
<T> Record<T> getIfPresent(String key);
<T> void put(String key, T value);
<T> void put(String key, T value, long expireTime);
Set<String> keySet();
boolean containsKey(String key);
void evict(String key);
void evictAll();
}
复制代码
它的默认实现 DefaultMemoryImpl 使用 ConcurrentHashMap 来缓存数据。
在 extra 模块还有 Guava Cache、Caffeine 的实现。它们都是成熟的 Local Cache，若是不想使用 DefaultMemoryImpl ，彻底可使用 extra 模块成熟的替代方案。
2.3 Persistence
Persistence 的接口跟 Memory 很相似：
package com.safframework.rxcache.persistence;
import com.safframework.rxcache.domain.Record;
import java.lang.reflect.Type;
import java.util.List;
/** * Created by tony on 2018/9/28. */
public interface Persistence {
<T> Record<T> retrieve(String key, Type type);
<T> void save(String key, T value);
<T> void save(String key, T value, long expireTime);
List<String> allKeys();
boolean containsKey(String key);
void evict(String key);
void evictAll();
}
复制代码
因为，考虑到持久层可能包括 Disk、DB。因而单独抽象了一个 Disk 接口继承 Persistence。
在 Disk 的实现类 DiskImpl 中，它的构造方法注入了 Converter 接口：
public class DiskImpl implements Disk {
private File cacheDirectory;
private Converter converter;
public DiskImpl(File cacheDirectory,Converter converter) {
this.cacheDirectory = cacheDirectory;
this.converter = converter;
}
......
}
复制代码
Converter 接口用于对象储存到文件的序列化和反序列化，目前支持 Gson 和 FastJSON。
Converter 的抽象实现类 AbstractConverter 的构造方法注入了 Encryptor 接口：
public abstract class AbstractConverter implements Converter {
private Encryptor encryptor;
public AbstractConverter() {
}
public AbstractConverter(Encryptor encryptor) {
this.encryptor = encryptor;
}
......
}
复制代码
Encryptor 接口用于将存储到 Disk 上的数据进行加密和解密，目前 RxCache 支持 AES128 和 DES 两种加密方式。不使用 Encryptor 接口，则存储到 Disk 上的数据是明文，也就是一串json字符串。
三. 支持 Java
在 example 模块下，包括了一些常见 Java 使用的例子。
例如，最简单的使用：
import com.safframework.rxcache.RxCache;
import com.safframework.rxcache.domain.Record;
import domain.User;
import io.reactivex.Observable;
import io.reactivex.functions.Consumer;
/** * Created by tony on 2018/9/29. */
public class Test {
public static void main(String[] args) {
RxCache.config(new RxCache.Builder());
RxCache rxCache = RxCache.getRxCache();
User u = new User();
u.name = "tony";
u.password = "123456";
rxCache.save("test",u);
Observable<Record<User>> observable = rxCache.load2Observable("test", User.class);
observable.subscribe(new Consumer<Record<User>>() {
@Override
public void accept(Record<User> record) throws Exception {
User user = record.getData();
System.out.println(user.name);
System.out.println(user.password);
}
});
}
}
复制代码
带 ExpireTime 的缓存测试：
import com.safframework.rxcache.RxCache;
import com.safframework.rxcache.domain.Record;
import domain.User;
/** * Created by tony on 2018/10/5. */
public class TestWithExpireTime {
public static void main(String[] args) {
RxCache.config(new RxCache.Builder());
RxCache rxCache = RxCache.getRxCache();
User u = new User();
u.name = "tony";
u.password = "123456";
rxCache.save("test",u,2000);
try {
Thread.sleep(2500);
} catch (InterruptedException e) {
e.printStackTrace();
}
Record<User> record = rxCache.get("test", User.class);
if (record==null) {
System.out.println("record is null");
}
}
}
复制代码
跟 Spring 整合而且 Memory 的实现使用 GuavaCacheImpl：
import com.safframework.rxcache.RxCache;
import com.safframework.rxcache.extra.memory.GuavaCacheImpl;
import com.safframework.rxcache.memory.Memory;
import org.springframework.beans.factory.annotation.Configurable;
import org.springframework.context.annotation.Bean;
/** * Created by tony on 2018/10/5. */
@Configurable
public class ConfigWithGuava {
@Bean
public Memory guavaCache(){
return new GuavaCacheImpl(100);
}
@Bean
public RxCache.Builder rxCacheBuilder(){
return new RxCache.Builder().memory(guavaCache());
}
@Bean
public RxCache rxCache() {
RxCache.config(rxCacheBuilder());
return RxCache.getRxCache();
}
}
复制代码
测试一下刚才的整合：
import com.safframework.rxcache.RxCache;
import com.safframework.rxcache.domain.Record;
import domain.User;
import io.reactivex.Observable;
import io.reactivex.functions.Consumer;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
/** * Created by tony on 2018/10/5. */
public class TestWithGuava {
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(ConfigWithGuava.class);
RxCache rxCache = ctx.getBean(RxCache.class);
User u = new User();
u.name = "tony";
u.password = "123456";
rxCache.save("test",u);
Observable<Record<User>> observable = rxCache.load2Observable("test", User.class);
observable.subscribe(new Consumer<Record<User>>() {
@Override
public void accept(Record<User> record) throws Exception {
User user = record.getData();
System.out.println(user.name);
System.out.println(user.password);
}
});
}
}
复制代码
四. 支持 Android
为了更好地支持 Android，我还单首创建了一个项目 RxCache4a: github.com/fengzhizi71…
它包含了一个基于 LruCache 的 Memory 实现，以及一个基于 MMKV(腾讯开源的key -value存储框架) 的 Persistence 实现。
咱们目前 App 采用了以下的 MVVM 架构来传输数据：
将来，但愿可以经过 RxCache 来整合 Repository 这一层。
五. 总结
目前，RxCache 完成了大致的框架，初步可用，接下来打算增长一些 Annotation，方便其使用。
RxCache 系列的相关文章：
- ReentrantReadWriteLock读写锁及其在 RxCache 中的使用
- 堆外内存及其在 RxCache 中的使用
- Retrofit 风格的 RxCache及其多种缓存替换算法
- RxCache 整合 Android 的持久层框架 greenDAO、Room
Java与Android技术栈：每周更新推送原创技术文章，欢迎扫描下方的公众号二维码并关注，期待与您的共同成长和进步。
相关文章
- 1. 一个angular4.0响应式表单应用~~~
- 2. docker - dockerfile构建一个简单的springboot应用镜像
- 3. 【Godot】五分钟做一个简单的响应式Godot GUI
- 4. 建立一个简单的Spring应用
- 5. 一个简单的 Cache 淘汰策略
- 6. 基于Vue2.0+Vue-router构建一个简单的单页应用
- 7. 一个简单的接口，被调用并同步给出响应的方法
- 8. Local Cache
- 9. vue-cli构建一个简单的单页应用
- 10. 一个简单的Java应用程序
- 更多相关文章...
- • Eclipse Java 构建路径 - Eclipse 教程
- • Maven 构建 Java 项目 - Maven教程
- • TiDB 在摩拜单车在线数据业务的应用和实践
- • 适用于PHP初学者的学习线路和建议
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. Duang!超快Wi-Fi来袭
- 2. 机器学习-补充03 神经网络之**函数(Activation Function)
- 3. git上开源maven项目部署 多module maven项目（多module maven+redis+tomcat+mysql）后台部署流程学习记录
- 4. ecliple-tomcat部署maven项目方式之一
- 5. eclipse新导入的项目经常可以看到“XX cannot be resolved to a type”的报错信息
- 6. Spark RDD的依赖于DAG的工作原理
- 7. VMware安装CentOS-8教程详解
- 8. YDOOK：Java 项目 Spring 项目导入基本四大 jar 包 导入依赖，怎样在 IDEA 的项目结构中导入 jar 包 导入依赖
- 9. 简单方法使得putty（windows10上）可以免密登录树莓派
- 10. idea怎么用本地maven
欢迎关注本站公众号,获取更多信息
