# J2Cache **Repository Path**: llsydn_admin_admin/J2Cache ## Basic Information - **Project Name**: J2Cache - **Description**: Java 两级缓存框架，可以让应用支持两级缓存框架 ehcache(Caffeine) + redis 。避免完全使用独立缓存系统所带来的网络IO开销问题 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: http://www.oschina.net/p/j2cache - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1758 - **Created**: 2024-08-20 - **Last Updated**: 2024-08-21 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

J2Cache

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

JavaDoc [https://apidoc.gitee.com/ld/J2Cache/](https://apidoc.gitee.com/ld/J2Cache/) J2Cache 是 OSChina 目前正在使用的两级缓存框架（要求至少 Java 8）。第一级缓存使用内存(同时支持 Ehcache 2.x、Ehcache 3.x 和 Caffeine)，第二级缓存使用 Redis(推荐)/Memcached 。 由于大量的缓存读取会导致 L2 的网络成为整个系统的瓶颈，因此 L1 的目标是降低对 L2 的读取次数。 该缓存框架主要用于集群环境中。单机也可使用，用于避免应用重启导致的缓存冷启动后对后端业务的冲击。 J2Cache 相关文章： - [J2Cache 和普通缓存框架有何不同，它解决了什么问题？](https://my.oschina.net/javayou/blog/1931381) - [J2Cache 两级缓存中的 Region 到底是什么东西？](https://my.oschina.net/javayou/blog/3031773) - [如何让 J2Cache 在多种编程语言环境中使用](https://my.oschina.net/javayou/blog/2247729) - [J2Cache 中使用 Lettuce 替代 Jedis 管理 Redis 连接](https://my.oschina.net/javayou/blog/2247710) - [如何通过 J2Cache 实现分布式 session 存储](https://my.oschina.net/javayou/blog/2117109) - [J2Cache 没有 Redis 也可以实现多节点的缓存同步](https://my.oschina.net/javayou/blog/1865908) - [微服务的架构里应该使用 J2Cache 两级缓存框架](https://my.oschina.net/javayou/blog/1827480) - [J2Cache 和 JetCache 框架有何不同？](https://my.oschina.net/javayou/blog/2988523) - [J2Cache 线上异常问题排查记录](https://my.oschina.net/keking/blog/3058409) J2Cache 已经有 Python 语言版本了，详情请看 [https://gitee.com/ld/Py3Cache](https://gitee.com/ld/Py3Cache) J2Cache 从 1.3.0 版本开始支持 JGroups 和 Redis Pub/Sub 两种方式进行缓存事件的通知。在某些云平台上可能无法使用 JGroups 组播方式，可以采用 Redis 发布订阅的方式。详情请看 j2cache.properties 配置文件的说明。 视频介绍：http://v.youku.com/v_show/id_XNzAzMTY5MjUy.html J2Cache 的两级缓存结构 L1： 进程内缓存(caffeine\ehcache) L2： Redis/Memcached 集中式缓存 ## 数据读取 1. 读取顺序 -> L1 -> L2 -> DB 2. 数据更新 1 从数据库中读取最新数据，依次更新 L1 -> L2 ，发送广播清除某个缓存信息 2 接收到广播（手工清除缓存 & 一级缓存自动失效），从 L1 中清除指定的缓存信息 ## J2Cache 配置 配置文件位于 core/resources 目录下，包含三个文件： * j2cache.properties J2Cache 核心配置文件，可配置两级的缓存，Redis 服务器、连接池以及缓存广播的方式 * caffeine.properties 如果一级缓存选用 Caffeine ，那么该文件用来配置缓存信息 * ehcache.xml Ehcache 的配置文件，配置说明请参考 Ehcache 文档 * ehcache3.xml Ehcache3 的配置文件，配置说明请参考 Ehcache 文档 * network.xml JGroups 网络配置，如果使用 JGroups 组播的话需要这个文件，一般无需修改 实际使用过程需要将所需的配置文件复制到应用类路径中，如 WEB-INF/classes 目录。 J2Cache 运行时所需 jar 包请查看 core/pom.xml ## 测试方法 1. 安装 Redis 2. `git clone https://gitee.com/ld/J2Cache` 3. 修改 `core/resource/j2cache.properties` 配置使用已安装的 Redis 服务器 4. 在命令行中执行 `mvn package -DskipTests=true` 进行项目编译 5. 打开多个命令行窗口，同时运行 `runtest.sh` 6. 在 > 提示符后输入 help 查看命令，并进行测试 ## 示例代码 详细的使用方法请看 [J2CacheCmd.java](https://gitee.com/ld/J2Cache/blob/master/core/src/net/oschina/j2cache/J2CacheCmd.java) 与spring cache 集成 [SpringCache 集成 J2Cache 配置案例](./modules/springcache/j2cache-springcache.md) ## 使用方法 J2Cache 默认使用 [Caffeine](https://www.oschina.net/p/ben-manes-caffeine) 作为一级缓存，使用 Redis 作为二级缓存。你还可以选择 Ehcache2 和 Ehcache3 作为一级缓存。 **准备工作** 1. 安装 Redis 2. 新建一个基于 Maven 的 Java 项目 **一. 引用 Maven** ```xml net.oschina.j2cache j2cache-core xxxxx ``` 中央仓库地址：[>>飞机](https://mvnrepository.com/artifact/net.oschina.j2cache/j2cache-core) **二. 准备配置** 拷贝 `j2cache.properties` 和 `caffeine.properties` 到你项目的源码目录，并确保这些文件会被编译到项目的 classpath 中。如果你选择了 ehcache 作为一级缓存，需要拷贝 `ehcache.xml` 或者 `ehcache3.xml` 到源码目录（后者对应的是 Ehcache 3.x 版本），这些配置文件的模板可以从 [https://gitee.com/ld/J2Cache/tree/master/core/resources](https://gitee.com/ld/J2Cache/tree/master/core/resources) 这里获取。 使用你喜欢的文本编辑器打开 `j2cache.properties` 并找到 `redis.hosts` 项，将其信息改成你的 Redis 服务器所在的地址和端口。 我们建议缓存在使用之前都需要预先设定好缓存大小及有效时间，使用文本编辑器打开 caffeine.properties 进行缓存配置，配置方法请参考文件中的注释内容。 例如：default = 1000,30m #定义缓存名 default ，对象大小 1000，缓存数据有效时间 30 分钟。 你可以定义多个不同名称的缓存。 **三. 编写代码** Test.java ```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](https://gitee.com/ld/J2Cache/blob/master/core/src/net/oschina/j2cache/CacheChannel.java) 接口的方法。 *请注意 cache.close() 方法只需在程序退出时调用。* **四. 动态构建 J2Cache 实例** ```java J2CacheConfig config = new J2CacheConfig(); //填充 config 变量所需的配置信息 J2CacheBuilder builder = J2CacheBuilder.init(config); CacheChannel channel = builder.getChannel(); //进行缓存的操作 channel.close(); ``` **五. 集群测试** 为了方便测试集群模式下 J2Cache 的运行，我们提供了一个命令行小程序，请参考此页面前面的 [“测试方法”](#%E6%B5%8B%E8%AF%95%E6%96%B9%E6%B3%95)。 ## 常见问题 1. **J2Cache 的使用场景是什么？** 首先你的应用是运行在集群环境，使用 J2Cache 可以有效降低节点间的数据传输量；其次单节点使用 J2Cache 可以避免应用重启后对后端业务系统的冲击 2. **为什么不能在程序中设置缓存的有效期** 在程序中定义缓存数据的有效期会导致缓存不可控，一旦数据出问题无从查起，因此 J2Cache 的所有缓存的有效期都必须在 `一级缓存` 的配置中预设好再使用 3. **如何使用 JGroups 组播方式（无法在云主机中使用）** 首先修改 `j2cache.properties` 中的 `j2cache.broadcast` 值为 `jgroups`，然后在 maven 中引入 ```xml org.jgroups jgroups 3.6.13.Final ``` 4. **如何使用 ehcache 作为一级缓存** 首先修改 `j2cache.properties` 中的 `j2cache.L1.provider_class` 为 ehcache 或者 ehcache3，然后拷贝 ehcache.xml 或者 ehcache3.xml 到类路径，并配置好缓存，需要在项目中引入对 ehcache 的支持： ```xml net.sf.ehcache ehcache 2.10.4 org.ehcache ehcache 3.4.0 ``` 5. **如何使用 RabbitMQ 作为消息通知** 首先修改 `j2cache.properties` 中的 `j2cache.broadcast` 为 rabbitmq，然后在 j2cache.properties 中配置 rabbitmq.xxx 相关信息。 需要在项目中引入对 rabbitmq 的支持： ```xml com.rabbitmq amqp-client 5.3.0 ``` 6. **如何使用 RocketMQ 作为消息通知** 首先修改 `j2cache.properties` 中的 `j2cache.broadcast` 为 rocketmq，然后在 j2cache.properties 中配置 rocketmq.xxx 相关信息。 需要在项目中引入对 rabbitmq 的支持： ```xml org.apache.rocketmq rocketmq-client 4.3.0 provided ``` 7. **如何使用 memcached 作为二级缓存** 首先修改 `j2cache.properties` 中的 `j2cache.L2.provider_class` 为 memcached，然后在 j2cache.properties 中配置 memcached.xxx 相关信息。 需要在项目中引入对 memcached 的支持： ```xml com.googlecode.xmemcached xmemcached 2.4.5 ``` 8. **为什么 J2Cache 初始化时，连接本机的 Redis 非常慢，要 5 秒以上？** 如果出现这种情况，请在系统 hosts 里配置机器名和IP地址的对应关系，例如： ``` 127.0.0.1 localhost 127.0.0.1 winter-notebook.local ::1 localhost ::1 winter-notebook.local ``` 9. **使用何种 Redis 的存储模式最佳？ generic 还是 hash ?** 我们推荐使用 generic 存储模式，这也是 J2Cache 默认的存储模式，hash 模式最大的问题是无法单独对 key 进行 expire 设置。 ## 哪些项目在用 J2Cache ？ * www.oschina.net * https://gitee.com/jfinal/jfinal * https://gitee.com/fuhai/jboot * https://gitee.com/tywo45/t-io * https://gitee.com/nutz/nutzboot * https://gitee.com/qingfengtaizi/wxmp * https://gitee.com/xchao/j-im * https://gitee.com/fuyang_lipengjun/platform * https://gitee.com/xcOschina/freeter-admin * https://gitee.com/thinkgem/jeesite4 * https://gitee.com/noear/weed3 * https://gitee.com/zuihou111/zuihou-admin-cloud * https://gitee.com/lframework/xingyun 更多项目收集中，如果你的项目用了，请告诉我 ## TODO ## 1. 应用重启，从 Redis 获取数据后，一级缓存的有效期大于预设值 2. 多节点强一致性？ 3. 欢迎大家给 J2Cache 提建议