Redis 工具

目前文档内容对标 ballcat v0.4.0 以上版本

ballcat 中有以下两个模块和 redis 有关：

  • ballcat-common-redis

基于 spring-data-redis，对 redis 的使用进行了二次封装

  • ballcat-spring-boot-starter-redis

    SpringBoot 的 starter，依赖 ballcat-common-redis，提供了 redis 使用时的相关自动配置

使用方式

依赖引入

直接在项目中引入 starter 组件：

		<dependency>
			<groupId>com.hccake</groupId>
			<artifactId>ballcat-spring-boot-starter-redis</artifactId>
            <version>${lastedVersion}</version>
		</dependency>

配置属性

spring-data-redis 的基本配置：

spring:
  redis:
    host: your-host
    password: ''
    port: 6379

ballcat-spring-boot-starter-redis 的额外属性配置：

属性描述默认值
ballcat.redis.keyPrefixredis 的全局 key 前缀""
ballcat.redis.lockKeySuffix使用 redis 做分布式锁时，对应 key 的后缀"locked"
ballcat.redis.delimiterredis key 的分隔符":"
ballcat.redis.nullValue空值标识"N_V"
ballcat.redis.expireTimeredis 缓存的默认超时时间(s)86400
ballcat.redis.lockedTimeOutredis 锁的超时时间(ms)1000

yml 配置示例：

ballcat:
  redis:
  	key-prefix: 'ballcat:'
  	lock-key-suffix: 'locked'
  	delimiter: ':'
  	null-value: 'N_V'
    expire-time: 86400
    locked-time-out: 1000

基本功能

1. RedisHelper 操作类

ballcat-spring-boot-starter-redis 会自动注册该类。

RedisHelper 中的方法全部为静态方法，用户可以方便的通过该类进行 redis 的操作。

String key = "testKey";
String value = RedisHelper.get(key);

2. 全局 key 前缀

通过修改 RedisTemplate 的 key 序列化器，进行 redis 全局 key 前缀的注册，方便公用 redis 环境时的 key 隔离。

例如当配置以下 key 前缀时：

ballcat:
  redis:
  	key-prefix: 'ballcat:'

代码中添加一个 String 类型的 key：testKey，其实际在 redis 中存储的 key name 为 ballcat:testKey

String key = "testKey";
RedisHelper.set(key, "testValue");

全局 key 前缀的配置，并不影响对 key 的其他操作，例如获取对应的 value 时，依然是传入 testKey，而不是 ballcat:testKey

String key = "testKey";
String value = RedisHelper.get(key);

3. 简易分布式锁

CacheLock 类中，提供了 lock 和 releaseLock 方法，并利用 lua 脚本，保证了加解锁的一致性。

但是并未提供锁的续期机制，如需更高要求，可自行引入 redission.

4. 消息监听者自动注册

提供了 MessageEventListener 类，对于 PUB/SUB 的消息监听者只需实现该类，就可默认注册到 RedisMessageListenerContainer 中。

/**
 * PUB/SUB 模式中的消息监听者
 *
 * @author hccake
 */
public interface MessageEventListener extends MessageListener {

	/**
	 * 订阅者订阅的话题
	 * @return topic
	 */
	Topic topic();

}

注解操作

缓存查询 @Cached

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@MetaCacheAnnotation
public @interface Cached {

	/**
	 * redis 存储的Key名
	 */
	String key();

	/**
	 * 如果需要在key 后面拼接参数 则传入一个拼接数据的 SpEL 表达式
	 */
	String keyJoint() default "";

	/**
	 * 超时时间(S) ttl = 0 使用全局配置值 ttl < 0 : 不超时 ttl > 0 : 使用此超时间
	 */
	long ttl() default 0;
}

key 和 keyJoint 共同拼接出了当前的 redis key，拼接的连接符默认为 :。

keyJoint 的值为 SPEL 表达式open in new window，可以进行一些简单的字面量运算，根据方法的上下文信息进行值的解析，最常用的就是获取入参的值。

注解示例：

@Cached(key = "testKey", keyJoint = "#p0", ttl=86400)
public User getUser(String userName) {
    return new User("zhangsan", 18);
}

当调用方法 getUser("zhangsan") 时，该注解对应的 redis key 为：testKey:zhangsan

注解流程

该注解标记于方法上时，将会对标记方法开启代理增强，后续对方法的调用将会按以下逻辑处理：

- 先查询缓存 若不为空 直接返回 - 若缓存为空，则调用方法，获取结果集 - 将结果集置入缓存，以便下次读取

此外该注解提供了缓存防击穿，和防穿透的处理：

在缓存中不存在，进而进行方法调用前，使用分布式锁进行加锁处理，保证只有一个线程去执行方法，进行缓存的初始化。

当方法返回值为 null，标识 db 中没有数据时，将会在缓存中添加一个空值标识，后续进行查询时，发现缓存中存储的是空值标识，将不再进行方法的调用，直接返回 null 值。

缓存删除 @CacheDel

在方法执行后执行缓存删除操作

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@MetaCacheAnnotation
public @interface CacheDel {

   /**
    * redis 存储的Key名
    */
   String key();

   /**
    * 如果需要在key 后面拼接参数 则传入一个拼接数据的 SpEL 表达式
    */
   String keyJoint() default "";

   /**
    * 清除多个 key，当值为 true 时，强制要求 keyJoint 有值，且 Spel 表达式解析结果为 Collection
    * @return boolean
    */
   boolean multiDel() default false;


  /**
   * 是否删除缓存空间key下的所有条目
   * 默认情况下，只删除相关键下的值。
   * 注意，设置该参数为true时，指定的 keyJoint与multiDel将被忽略.
   */
  boolean allEntries() default false;
}

key 和 keyjoint 同 @Cached，multiDel 属性主要用于控制是否是批量删除缓存。

批量删除缓存时，要求 keyjoint 对应的 SPEL 表达式解析出来的值为一个 Collection。

单独删除注解示例：

@CacheDel(key = "testKey", keyJoint = "#p0")
public User updateUser(String username, String age) {
    return mapper.updateUserAge(username, age);
}

批量删除示例：

@CacheDel(key = "testKey", keyJoint = "#p0", multiDel = true)
public User updateUserStatus(List<String> usernameList, String status) {
    return mapper.updateUserAge(usernameList, age);
}

有的时候我们需要一下清除Cache中所有的元素，因此类似于Spring Cache项目的@CacheEvict,@CacheDel同样提供了allEntries属性。allEntries是boolean类型，表示是否需要清除缓存中的所有元素。默认为false，表示不需要。当指定了allEntries为true时，将忽略指定的keyJoint表达式,通过redis scan删除@CacheDel的key属性能命中的所有相关的缓存。

清除缓存示例：

@CacheDel(key = "testKey",  allEntries = true)
public User removeUser(String username) {
  return mapper.removeUser(username);
}

进阶玩法，集合投影，可以对集合的元素操作，获取新的集合数据，类似于 stream 的 map 方法：

@CacheDel(key = "testKey", keyJoint = "#p0.![#this.username]", multiDel = true)
public User updateUserStatus(List<User> userList, String status) {
    List<String> usernameList = userList.stream().map(User::getUsername).collect(Collectors.toList());
    return mapper.updateUserAge(usernameList, age);
}

缓存修改 @CachePut

在方法执行后执行缓存put操作 将方法的返回值置入缓存中，若方法返回null，则会默认置入一个nullValue。

不推荐使用该注解，缓存变更时，尽量使用删除操作

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@MetaCacheAnnotation
public @interface CachePut {

   /**
    * redis 存储的Key名
    */
   String key();

   /**
    * 如果需要在key 后面拼接参数 则传入一个拼接数据的 SpEL 表达式
    */
   String keyJoint() default "";

   /**
    * 超时时间(S) ttl = 0 使用全局配置值 ttl < 0 : 不超时 ttl > 0 : 使用此超时间
    */
   long ttl() default 0;

}

redis键空间通知

spring官方封装了对redis过期键的操作。在这个基础上，ballcat额外封装了键的删除与更新操作。可以比较简单的实现清除二级缓存啊，缓存失效重新缓存啊，缓存失效清除数据库啊以及不可靠的定时任务等极限的操作。

注意

该功能会比起正常的redis服务器会消耗更多的CPU。因此，默认情况下 Redis 服务器端是不开启键空间通知的。 需要我们通过 config set notify-keyspace-events Ex或者用命令redis-server --notify-keyspace-events Ex启动redis或者调整redis默认配置文件的notify-keyspace-events属性来手动开启。 开启键空间通知后，我们就可以拿到每个键值指定的过期的事件。更进一步，同样能拿到其他事件。同样出于性能角度的考虑，ballcat默认也不会开启对应的功能，开发者如果需要使用，需按照以下步骤自行开启.

开启redis server的键空间通知功能

需要redis 2.8+,开启方法见上文注意中的内容

调整配置文件

通过ballcat.redis.key-deleted-event.enabled、ballcat.redis.key-set-event.enabled、ballcat.redis.key-expired-event.enabled属性设置为true可以开启redis键的 删除、新增/修改、过期事件的监听。

实现三个模版方法接口

Spring组件实现接口KeyDeletedEventMessageTemplate、KeySetEventMessageTemplate、KeyExpriredEventMessageTemplate可以分别定制key的 删除、新增/修改、过期事件的监听处理。

其他事项

  • 通过覆盖RedisKeyEventAutoConfiguration中几个Bean可以自定义监听行为。

  • redis server 在key过期事件推送到topic中只有key，无value，因为一旦过期，value就不存在了。

  • 关于服务器的键空间通知。以下内容来自官方配置文件注释翻译，开发者根据自身的要求酌情开启。

# K    键空间通知，以__keyspace@<db>__为前缀
# E    键事件通知，以__keysevent@<db>__为前缀
# g    del , expipre , rename 等类型无关的通用命令的通知, ...
# $    String命令
# l    List命令
# s    Set命令
# h    Hash命令
# z    有序集合命令
# x    过期事件（每次key过期时生成）
# e    驱逐事件（当key在内存满了被清除时生成）
# A    g$lshzxe的别名，因此”AKE”意味着所有的事件