java properties存储-基于内存和Redis的两级Java缓存框架

关注后回复“进群”，拉你进程序员交流群

Java 两级缓存框架，可以让应用支持两级缓存框架 ehcache(Caffeine) + redis 。避免完全使用独立缓存系统所带来的网络IO开销问题

基于内存和 Redis 的两级 Java 缓存框架

J2Cache 第一级缓存使用内存(同时支持 Ehcache 2.x、Ehcache 3.x 和 Caffeine)，第二级缓存使用 Redis(推荐)/Memcached 。由于大量的缓存读取会导致 L2 的网络成为整个系统的瓶颈，因此 L1 的目标是降低对 L2 的读取次数。该缓存框架主要用于集群环境中。单机也可使用，用于避免应用重启导致的缓存冷启动后对后端业务的冲击。

J2Cache 的两级缓存结构

L1：进程内缓存(caffeine\ehcache)

L2：Redis/Memcached 集中式缓存

数据读取

读取顺序 -> L1 -> L2 -> DB

数据更新

1 从数据库中读取最新数据，依次更新 L1 -> L2 ，发送广播清除某个缓存信息

2 接收到广播（手工清除缓存 & 一级缓存自动失效），从 L1 中清除指定的缓存信息

J2Cache 配置

配置文件位于 core/resources 目录下，包含三个文件：

实际使用过程需要将所需的配置文件复制到应用类路径中，如 WEB-INF/classes 目录。

J2Cache 运行时所需 jar 包请查看 core/pom.xml

测试方法

安装 Redis

git clone

修改core/resource/j2cache.properties配置使用已安装的 Redis 服务器

在命令行中执行mvn package -DskipTests=true进行项目编译

打开多个命令行窗口，同时运行runtest.sh

在 > 提示符后输入 help 查看命令，并进行测试

使用方法

J2Cache 默认使用 Caffeine 作为一级缓存，使用 Redis 作为二级缓存。你还可以选择 Ehcache2 和 Ehcache3 作为一级缓存。

准备工作

安装 Redis

新建一个基于 Maven 的 Java 项目

一. 引用 Maven

<dependency>
  <groupId>net.oschina.j2cachegroupId>  
  <artifactId>j2cache-coreartifactId>  
  <version>xxxxxversion>  
dependency>

中央仓库地址：>>飞机

二. 准备配置

拷贝j2cache.properties和caffeine.properties到你项目的源码目录，并确保这些文件会被编译到项目的 classpath 中。如果你选择了 ehcache 作为一级缓存，需要拷贝ehcache.xml或者ehcache3.xml到源码目录（后者对应的是 Ehcache 3.x 版本），这些配置文件的模板可以从 这里获取。

使用你喜欢的文本编辑器打开j2cache.properties并找到redis.hosts项，将其信息改成你的 Redis 服务器所在的地址和端口。

我们建议缓存在使用之前都需要预先设定好缓存大小及有效时间，使用文本编辑器打开 caffeine.properties 进行缓存配置，配置方法请参考文件中的注释内容。

例如：default = 1000,30m #定义缓存名 default ，对象大小 1000，缓存数据有效时间 30 分钟。你可以定义多个不同名称的缓存。

三. 编写代码

Test.java

public static void main(String[] args) {
    CacheChannel cache = J2Cache.getChannel();

    //缓存操作
    cache.set("default", "1", "Hello J2Cache");
    System.out.println(cache.get("default", "1"));
    cache.evict("default", "1");
    System.out.println(cache.get("default", "1"));

    cache.close();
}

编译并运行查看结果，更多的用法请参考 CacheChannel.java 接口的方法。

请注意 cache.close() 方法只需在程序退出时调用。

四. 动态构建 J2Cache 实例

J2CacheConfig config = new J2CacheConfig();
//填充 config 变量所需的配置信息
J2CacheBuilder builder = J2CacheBuilder.init(config);
CacheChannel channel = builder.getChannel();
//进行缓存的操作
channel.close();

五. 集群测试

为了方便测试集群模式下 J2Cache 的运行java properties存储，我们提供了一个命令行小程序，请参考此页面前面的 “测试方法”。

常见问题

J2Cache 的使用场景是什么？

首先你的应用是运行在集群环境java properties存储，使用 J2Cache 可以有效降低节点间的数据传输量；其次单节点使用 J2Cache 可以避免应用重启后对后端业务系统的冲击

为什么不能在程序中设置缓存的有效期

在程序中定义缓存数据的有效期会导致缓存不可控，一旦数据出问题无从查起，因此 J2Cache 的所有缓存的有效期都必须在一级缓存的配置中预设好再使用

如何使用 JGroups 组播方式（无法在云主机中使用）

首先修改j2cache.properties中的j2cache.broadcast值为jgroups，然后在 maven 中引入

<dependency>
    <groupId>org.jgroupsgroupId>
    <artifactId>jgroupsartifactId>
    <version>3.6.13.Finalversion>
dependency>

如何使用 ehcache 作为一级缓存

首先修改j2cache.properties中的j2cache.L1.provider_class为 ehcache 或者 ehcache3，然后拷贝 ehcache.xml 或者 ehcache3.xml 到类路径，并配置好缓存，需要在项目中引入对 ehcache 的支持：

<dependency>
    <groupId>net.sf.ehcachegroupId>
    <artifactId>ehcacheartifactId>
    <version>2.10.4version>
dependency>

<dependency>
    <groupId>org.ehcachegroupId>
    <artifactId>ehcacheartifactId>
    <version>3.4.0version>
dependency>

如何使用 RabbitMQ 作为消息通知

首先修改j2cache.properties中的j2cache.broadcast为 rabbitmq，然后在 j2cache.properties 中配置 rabbitmq.xxx 相关信息。

需要在项目中引入对 rabbitmq 的支持：

<dependency>
    <groupId>com.rabbitmqgroupId>
    <artifactId>amqp-clientartifactId>
    <version>5.3.0version>
dependency>

如何使用 RocketMQ 作为消息通知

首先修改j2cache.properties中的j2cache.broadcast为 rocketmq，然后在 j2cache.properties 中配置 rocketmq.xxx 相关信息。

需要在项目中引入对 rabbitmq 的支持：

<dependency>
    <groupId>org.apache.rocketmqgroupId>
    <artifactId>rocketmq-clientartifactId>
    <version>4.3.0version>
    <scope>providedscope>
dependency>

如何使用 memcached 作为二级缓存

首先修改j2cache.properties中的j2cache.L2.provider_class为 memcached，然后在 j2cache.properties 中配置 memcached.xxx 相关信息。

需要在项目中引入对 memcached 的支持：

<dependency>
    <groupId>com.googlecode.xmemcachedgroupId>
    <artifactId>xmemcachedartifactId>
    <version>2.4.5version>
dependency>

为什么 J2Cache 初始化时，连接本机的 Redis 非常慢，要 5 秒以上？

如果出现这种情况，请在系统 hosts 里配置机器名和IP地址的对应关系，例如：

127.0.0.1       localhost
127.0.0.1       winter-notebook.local
::1             localhost
::1             winter-notebook.local

使用何种 Redis 的存储模式最佳？generic 还是 hash ?

我们推荐使用 generic 存储模式，这也是 J2Cache 默认的存储模式，hash 模式最大的问题是无法单独对 key 进行 expire 设置。

项目地址

github地址：