tio-boot 整合ehcache

头像
李通
     帕劳
    阅读 9 分钟

    tio-boot官网

    使用 java-db 整合 ehcache

    Ehcache 是一个广泛使用的开源的缓存黄金，它可以提高应用程序的性能和扩展性。
    java-db 对 ehcache 进行了支持,使其的 java-db 中更易使用

    整合 ehcache

    添加依赖

    需要用到 java-db
    https://central.sonatype.com/artifact/com.litongjava/java-db

    <dependency>
  <groupId>com.litongjava</groupId>
  <artifactId>java-db</artifactId>
  <version>${java-db.version}</version>
</dependency>
<dependency>
  <groupId>net.sf.ehcache</groupId>
  <artifactId>ehcache-core</artifactId>
  <version>2.6.11</version>
</dependency>

    添加配置文件 ehcache.xml

    ehcache.xml 是 Ehcache 缓存的配置文件。EcachePlugin 启动时会自动加载这个配置,它定义了缓存的基本属性和行为。以下是文件中每个部分的详细解释：

    1. <diskStore>: 指定磁盘存储的路径，用于溢出或持久化缓存数据到磁盘。

    2. <defaultCache>: 设置默认缓存的属性。这些属性将应用于未单独配置的所有缓存。

      • eternal: 设置为 false 表示缓存不是永久的，可以过期。
      • maxElementsInMemory: 内存中可以存储的最大元素数量。
      • overflowToDisk: 当内存中的元素数量超过最大值时，是否溢出到磁盘。
      • diskPersistent: 是否在 JVM 重启之间持久化到磁盘。
      • timeToIdleSeconds: 元素最后一次被访问后多久会变成空闲状态。
      • timeToLiveSeconds: 元素从创建或最后一次更新后多久会过期。
      • memoryStoreEvictionPolicy: 当内存达到最大值时，移除元素的策略（例如，LRU 表示最近最少使用）。

    ehcache.xml 配置文件内容如下

    <?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd" updateCheck="false">

  <diskStore path="java.io.tmpdir/EhCache" />

  <defaultCache eternal="false" maxElementsInMemory="10000" overflowToDisk="false" diskPersistent="false"
    timeToIdleSeconds="1800" timeToLiveSeconds="259200" memoryStoreEvictionPolicy="LRU" />
</ehcache>

    EhCachePluginConfig 配置类

    这个类是一个配置类，用于初始化和配置 EhCache 插件。它通过 @AConfiguration 注解标记为配置类。类中的方法 ehCachePlugin 通过 @ABean 注解标记为 Bean 方法,框架启动时会执行该方法并将返回值放到 bean 容器中。在这个方法中，创建了一个 Plugin 实例并启动它。destroyMethod 指定在服务关闭时将会调用该方法,关闭该插件

    import com.litongjava.db.ehcache.EhCachePlugin;
import com.litongjava.jfinal.aop.annotation.AConfiguration;
import com.litongjava.jfinal.aop.annotation.AInitialization;
import com.litongjava.tio.boot.server.TioBootServer;

@AConfiguration
public class EhCachePluginConfig {

  @ABean(destroyMethod = "stop")
  public EhCachePlugin ehCachePlugin() {
    EhCachePlugin ehCachePlugin = new EhCachePlugin();
    ehCachePlugin.start();
    return ehCachePlugin;
  }
}

    如果不想将 EhCachePlugin 放入 Aop 容器,你可以使用下面的配置类,实际上也完全没有必要放到到 Aop 容器中

    import com.litongjava.db.ehcache.EhCachePlugin;
import com.litongjava.jfinal.aop.annotation.AConfiguration;
import com.litongjava.jfinal.aop.annotation.AInitialization;
import com.litongjava.tio.boot.server.TioBootServer;

@AConfiguration
public class EhCacheConfig {

  @AInitialization
  public void ehCachePlugin() {
    EhCachePlugin ehCachePlugin = new EhCachePlugin();
    ehCachePlugin.start();
    TioBootServer.me().addDestroyMethod(ehCachePlugin::stop);
  }
}

    控制器

    1. EhCacheTestController:

      • 这个控制器包含一个方法 test01，用于测试将数据添加到 EhCache 缓存中并从中检索数据。
      • 在这个方法中，首先尝试从缓存中获取一个键值。如果不存在，它将计算一个新值并将其存储在缓存中。
      • 这个控制器演示了如何使用 Ehcache 存储和检索简单的键值对。

    2. EhCacheController:

      • 这个控制器包含多个方法，用于与 Ehcache 进行更复杂的交互。
      • 方法如 getCacheNames 和 getAllCacheValue 用于检索缓存中的信息，例如缓存名称或所有缓存的值。
      • 其他方法允许按名称检索特定缓存的值，或者根据缓存名称和键检索特定的值。
      • 这个控制器提供了更深入的视图，展示了如何管理和检查 Ehcache 中的数据。
    import com.litongjava.db.ehcache.CacheKit;
import com.litongjava.tio.http.server.annotation.RequestPath;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@RequestPath("/ecache/test")
public class EhCacheTestController {

  public String test01() {
    String cacheName = "student";
    String cacheKey = "litong";

    String cacheData = CacheKit.get(cacheName, cacheKey);

    if (cacheData == null) {
      String result = "001";
      log.info("计算新的值");
      CacheKit.put(cacheName, cacheKey, result);
    }

    return cacheData;
  }

}

    访问测试 http://localhost/ecache/test/test01

    import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.litongjava.db.ehcache.CacheKit;
import com.litongjava.tio.http.server.annotation.RequestPath;

import net.sf.ehcache.Cache;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Element;

@RequestPath("/ecache")
public class EhCacheController {
  public String[] getCacheNames() {
    String[] cacheNames = CacheKit.getCacheManager().getCacheNames();
    return cacheNames;
  }

  public Map<String, Map<String, Object>> getAllCacheValue() {
    CacheManager cacheManager = CacheKit.getCacheManager();
    String[] cacheNames = cacheManager.getCacheNames();
    Map<String, Map<String, Object>> retval = new HashMap<>(cacheNames.length);
    for (String name : cacheNames) {
      Map<String, Object> map = cacheToMap(cacheManager, name);
      retval.put(name, map);
    }
    return retval;

  }

  public Map<String, Object> getCacheValueByCacheName(String cacheName) {
    CacheManager cacheManager = CacheKit.getCacheManager();
    Map<String, Object> retval = cacheToMap(cacheManager, cacheName);
    return retval;
  }

  public Object getCacheValueByCacheNameAndCacheKey(String cacheName, String key) {
    Object object = CacheKit.get(cacheName, key);
    return object;
  }

  private Map<String, Object> cacheToMap(CacheManager cacheManager, String name) {
    Cache cache = cacheManager.getCache(name);
    @SuppressWarnings("unchecked")
    List<String> keys = cache.getKeys();
    Map<String, Object> map = new HashMap<>(keys.size());
    for (String key : keys) {
      Element element = cache.get(key);
      Object value = element.getObjectValue();
      map.put(key, value);
    }
    return map;
  }
}

    访问测试
    http://localhost/ecache/getCacheNames
    http://localhost/ecache/getAllCacheValue

    EhCache 使用案例

    用户注册数量计数

    1. 思路
    • 创建用户表：创建一张用户注册记录表，每当有新用户注册时，将 userId 保存到此表中。
    • 统计用户数量：通过查询此表中的记录数量来统计用户注册总数，并将结果缓存。
    • 缓存机制：当有新用户注册时，清除缓存，然后更新表中的数据。
    2. 数据库表设计
    CREATE TABLE sys_new_user (
  id BIGINT PRIMARY KEY,
  user_id VARCHAR,
  remark VARCHAR (256),
  creator VARCHAR (64) DEFAULT '',
  create_time TIMESTAMP WITHOUT TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  updater VARCHAR (64) DEFAULT '',
  update_time TIMESTAMP WITHOUT TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  deleted SMALLINT NOT NULL DEFAULT 0,
  tenant_id BIGINT NOT NULL DEFAULT 0
);
    • sys_new_user 表记录了新用户的 user_id 以及一些元数据，如 create_time 和 update_time 等。
    3. 业务逻辑实现

    下面是核心的 NewUserService 服务类，用于保存用户注册信息和统计用户数量。

    package com.litongjava.open.chat.services;

import com.litongjava.db.activerecord.Db;
import com.litongjava.db.activerecord.Record;
import com.litongjava.db.ehcache.CacheKit;
import com.litongjava.tio.utils.snowflake.SnowflakeIdUtils;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class NewUserService {

  public boolean save(String userId) {
    // 创建记录并存入数据库
    Record record = Record.by("id", SnowflakeIdUtils.id()).set("user_id", userId);
    // 清除缓存
    CacheKit.remove("sys_new_user", "count");
    // 保存记录到数据库表
    return Db.save("sys_new_user", record);
  }

  public Long count() {
    // 从缓存中获取用户数量
    Long count = CacheKit.get("sys_new_user", "count");

    if (count == null) {
      // 如果缓存中没有数据，则从数据库中查询用户数量并缓存结果
      count = Db.countTable("sys_new_user");
      log.info("user count: {}", count);
      CacheKit.put("sys_new_user", "count", count);
    }

    return count;
  }
}
    • save 方法：接收 userId，生成唯一 id，保存到数据库，并清除缓存。
    • count 方法：首先尝试从缓存中获取用户数量，如果缓存不存在则查询数据库，并将结果放入缓存。
    4. 测试代码

    测试代码用于验证 NewUserService 的功能，包括用户注册和缓存机制。

    import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.junit.Test;

import com.litongjava.db.ehcache.CacheKit;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.open.chat.config.DbConfig;
import com.litongjava.open.chat.config.EhCacheConfig;
import com.litongjava.tio.utils.environment.EnvUtils;
import com.litongjava.tio.utils.json.JsonUtils;

import net.sf.ehcache.Cache;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Element;

public class NewUserServiceTest {

  @Test
  public void test() {
    // 加载环境变量
    EnvUtils.load();
    // 初始化数据库配置
    new DbConfig().config();
    // 初始化 EhCache 配置
    new EhCacheConfig().ehCachePlugin();

    // 获取 NewUserService 实例
    NewUserService newUserService = Aop.get(NewUserService.class);
    // 保存两个新用户
    newUserService.save("001");
    newUserService.save("002");

    // 多次调用 count 方法以测试缓存功能
    newUserService.count();
    newUserService.count();
    newUserService.count();
    Long count = newUserService.count();
    System.out.println(count);

    // 检查缓存中的数据
    CacheManager cacheManager = CacheKit.getCacheManager();
    String[] cacheNames = cacheManager.getCacheNames();
    Map<String, Map<String, Object>> allValue = new HashMap<>(cacheNames.length);
    for (String name : cacheNames) {
      Map<String, Object> map = cacheToMap(cacheManager, name);
      allValue.put(name, map);
    }

    // 打印缓存内容
    System.out.println(JsonUtils.toJson(allValue));
  }

  private Map<String, Object> cacheToMap(CacheManager cacheManager, String name) {
    Cache cache = cacheManager.getCache(name);
    @SuppressWarnings("unchecked")
    List<String> keys = cache.getKeys();
    Map<String, Object> map = new HashMap<>(keys.size());
    for (String key : keys) {
      Element element = cache.get(key);
      Object value = element.getObjectValue();
      map.put(key, value);
    }
    return map;
  }
}

    • 测试流程：

      1. 初始化环境和配置。
      2. 测试用户注册功能，并验证缓存机制是否生效。
      3. 打印缓存内容以确认数据存储是否正确。
    5. 测试日志输出

    以下是测试运行后的日志输出：

    2024-08-12 16:55:19.632 [main] INFO  c.z.h.HikariDataSource.<init>:80 - HikariPool-1 - Starting...
2024-08-12 16:55:20.418 [main] INFO  c.z.h.HikariDataSource.<init>:82 - HikariPool-1 - Start completed.
2024-08-12 16:55:20.443 [main] INFO  c.l.o.c.c.DbConfig.config:75 - show sql:true
2024-08-12 16:55:20.549 [main] WARN  c.l.d.e.CacheKit.getOrAddCache:33 - Could not find cache config [sys_new_user], using default.
Sql: insert into "sys_new_user"("id", "user_id") values(?, ?)
Sql: insert into "sys_new_user"("id", "user_id") values(?, ?)
Sql: SELECT count(*) from sys_new_user;
2024-08-12 16:55:20.590 [main] INFO  c.l.o.c.s.NewUserService.count:25 - user count:4
4
{"sys_new_user":{"count":"4"}}

    • 日志解读：

      • 数据源初始化成功。
      • 新用户注册时，向数据库中插入数据。
      • 执行 count 方法时，系统从数据库查询用户数量并缓存结果。
      • 缓存中的用户数量被正确打印出来。
    javaehcache
    李通
    215 声望0 粉丝
    « 上一篇
    tio-boot整合Dubbo
    下一篇 »
    TioBoot 和 RedisTemplate 读取redis中的数据

    引用和评论

    推荐阅读
    头像
    tio-boot 整合hotswap-classloader 实现热加载

    李通阅读 332

    头像
    在Java程序中监听mysql的binlog

    huan1993赞 11阅读 1.9k

    头像
    Jerry和您聊聊Chrome开发者工具

    注销赞 9阅读 4.5k评论 3

    头像
    Bitmap 和 布隆过滤器傻傻分不清？你这不应该啊

    程序员小富赞 8阅读 1.6k评论 1

    头像
    Just for fun——迅速写完快速排序

    ufdf赞 3阅读 2.6k

    头像
    Spring 实现 3 种异步流式接口，干掉接口超时烦恼

    程序员小富赞 5阅读 1.7k

    头像
    💢线上高延迟请求排查

    crossoverJie赞 6阅读 802评论 5

    0 条评论
    得票最新