Documentation

A good document is like an intriguing story.

Usage

基于 StringRedisTemplate 实现了常用的基础方法。

                        Copy
                        
<dependency>
    <groupId>net.dragonshard</groupId>
    <artifactId>dragonshard-data-redis-starter</artifactId>
    <version>${latest.version}</version>
</dependency>
                        
                    

配置文件

                        Copy
                        
spring:
  redis:
    host: 192.168.1.1
    password: pwd
    port: 6379
    database: 0
  # 防止出现加载冲突
  data:
    redis:
      repositories:
        enabled: false

dragonshard:
  redis:
    enabled: true
    biz-prefix: dragonshard
                                
                            

配置项前缀dragonshard.redis

配置项 默认值 选项 描述
enabled true true / false 是否开启
biz-prefix ${spring.application.name} String key的业务前缀

基础方法

                        
Role role = new Role();
// 单位秒
CacheService.save("key", role, 60);
CacheService.delete("key1","key2", ...);
CacheService.get("key");
CacheService.get("key", new TypeReference<Role>(){});
// 清空以cachePrefix开头的缓存
CacheService.clear("cachePrefix");
// 判断 key 是否存在
CacheService.hasKey("key");
// 给 key 设置失效时间,单位秒
CacheService.expire("key", 60);
// 获取 key 的失效时间,单位秒
CacheService.getExpire("key");
                        
                    

Biz Prefix

在实际开发中,经常会多个业务系统共用 Redis 服务,为了增加数据安全性和可读性,在每个key序列化之前,都会自动附加一个业务前缀。

该配置项如果省略,系统会自动使用 spring.application.name 作为前缀,如果该参数也为空,则会抛出异常启动终止。

e.g. 正常 redis 的缓存 key 为: myRedisKey,那么实际存入的 key 为: dragonshard:myRedisKey,dragonshard就是业务前缀,用英文分号分隔。