Spring boot 整合 Redis

1安装

Redis下载地址:

https://redis.io/download

首先要在本地安装一个redis程序,安装过程十分简单(略过),安装完成后进入到Redis 文件夹中可以看到如下:

点击 redis-server.exe 开启 Redis 服务,可以看到如下图所示即代表开启 Redis 服务成功:

那么我们可以开启 Redis 客户端进行测试:

2整合到 Spring Boot

1、在项目中加入 Redis 依赖,pom 文件中添加如下。

<!-- 整合Redis缓存支持 -->org.springframework.bootspring-boot-starter-data-redis

2、在 application.yml 中添加 Redis 配置。

##默认密码为空redis:host:127.0.0.1      # Redis服务器连接端口port:6379jedis:pool:          #连接池最大连接数(使用负值表示没有限制)max-active:100          # 连接池中的最小空闲连接max-idle:10          # 连接池最大阻塞等待时间(使用负值表示没有限制)max-wait:100000      # 连接超时时间(毫秒)timeout:5000      #默认是索引为0的数据库database:0

3、新建 RedisConfiguration 配置类,继承 CachingConfigurerSupport,@EnableCaching 开启注解。

@Configuration@EnableCachingpublicclassRedisConfigurationextendsCachingConfigurerSupport {/**    * 自定义生成key的规则    */@OverridepublicKeyGenerator keyGenerator() {returnnewKeyGenerator() {@OverridepublicObjectgenerate(Objecto, Method method,Object... objects) {//格式化缓存key字符串StringBuilder sb =newStringBuilder();//追加类名                sb.append(o.getClass().getName());//追加方法名                sb.append(method.getName());//遍历参数并且追加for(Objectobj : objects) {                    sb.append(obj.toString());                }System.out.println("调用Redis缓存Key : "+ sb.toString());returnsb.toString();            }        };    }/**    * 采用RedisCacheManager作为缓存管理器 * @param connectionFactory    */@BeanpublicCacheManager cacheManager(RedisConnectionFactory connectionFactory) {        RedisCacheManager redisCacheManager = RedisCacheManager.create(connectionFactory);returnredisCacheManager;    }@BeanpublicRedisTemplate redisTemplate(RedisConnectionFactory factory) {////解决键、值序列化问题StringRedisTemplate template =newStringRedisTemplate(factory);Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =newJackson2JsonRedisSerializer(Object.class);ObjectMapper om =newObjectMapper();        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);        jackson2JsonRedisSerializer.setObjectMapper(om);        template.setValueSerializer(jackson2JsonRedisSerializer);        template.afterPropertiesSet();returntemplate;    }}

4、创建自定义的接口来定义需要的 Redis 的功能。

/** * K 指以hash结构操作时 键类型 * T 为数据实体 应实现序列化接口,并定义serialVersionUID * RedisTemplate 提供了五种数据结构操作类型 hash / list / set / zset / value * 方法命名格式为 数据操作类型 + 操作 如 hashPut 指以hash结构(也就是map)想key添加键值对  */publicinterfaceRedisHelper{/*** Hash结构 添加元素 *@paramkey key *@paramhashKey hashKey *@paramdomain 元素    */voidhashPut(String key, HK hashKey, T domain);/*** Hash结构 获取指定key所有键值对 *@paramkey *@return    */MaphashFindAll(String key);/*** Hash结构 获取单个元素 *@paramkey *@paramhashKey *@return    */ThashGet(String key, HK hashKey);voidhashRemove(String key, HK hashKey);/*** List结构 向尾部(Right)添加元素 *@paramkey *@paramdomain *@return    */LonglistPush(String key, T domain);/*** List结构 向头部(Left)添加元素 *@paramkey *@paramdomain *@return    */LonglistUnshift(String key, T domain);/*** List结构 获取所有元素 *@paramkey *@return    */ListlistFindAll(String key);/*** List结构 移除并获取数组第一个元素 *@paramkey *@return    */TlistLPop(String key);/**    * 对象的实体类*@paramkey*@paramdomain*@return    */voidvaluePut(String key, T domain);/**    * 获取对象实体类*@paramkey*@return    */TgetValue(String key);voidremove(String key);/*** 设置过期时间 *@paramkey 键 *@paramtimeout 时间 *@paramtimeUnit 时间单位    */booleanexpirse(String key,longtimeout, TimeUnit timeUnit);}

5、下面是创建 RedisHelperImpl 进行接口的实现。

@Service("RedisHelper")publicclassRedisHelperImplimplementsRedisHelper {// 在构造器中获取redisTemplate实例, key(not hashKey) 默认使用String类型privateRedisTemplate redisTemplate;// 在构造器中通过redisTemplate的工厂方法实例化操作对象privateHashOperations hashOperations;privateListOperations listOperations;privateZSetOperations zSetOperations;privateSetOperations setOperations;privateValueOperations valueOperations;// IDEA虽然报错,但是依然可以注入成功, 实例化操作对象后就可以直接调用方法操作Redis数据库@AutowiredpublicRedisHelperImpl(RedisTemplate redisTemplate) {this.redisTemplate = redisTemplate;this.hashOperations = redisTemplate.opsForHash();this.listOperations = redisTemplate.opsForList();this.zSetOperations = redisTemplate.opsForZSet();this.setOperations = redisTemplate.opsForSet();this.valueOperations = redisTemplate.opsForValue();    }@OverridepublicvoidhashPut(Stringkey, HK hashKey, T domain) {        hashOperations.put(key, hashKey, domain);    }@OverridepublicMap hashFindAll(Stringkey) {returnhashOperations.entries(key);    }@OverridepublicT hashGet(Stringkey, HK hashKey) {returnhashOperations.get(key, hashKey);    }@OverridepublicvoidhashRemove(Stringkey, HK hashKey) {        hashOperations.delete(key, hashKey);    }@OverridepublicLong listPush(Stringkey, T domain) {returnlistOperations.rightPush(key, domain);    }@OverridepublicLong listUnshift(Stringkey, T domain) {returnlistOperations.leftPush(key, domain);    }@OverridepublicList listFindAll(Stringkey) {if(!redisTemplate.hasKey(key)) {returnnull;        }returnlistOperations.range(key,0, listOperations.size(key));    }@OverridepublicT listLPop(Stringkey) {returnlistOperations.leftPop(key);    }@OverridepublicvoidvaluePut(Stringkey, T domain) {        valueOperations.set(key, domain);    }@OverridepublicT getValue(Stringkey) {returnvalueOperations.get(key);    }@Overridepublicvoidremove(Stringkey) {        redisTemplate.delete(key);    }@Overridepublicbooleanexpirse(Stringkey, long timeout, TimeUnit timeUnit) {returnredisTemplate.expire(key, timeout, timeUnit);    }}

3测试

编写 TestRedis 类进行测试。

@RunWith(SpringRunner.class)@SpringBootTestpublicclassTestRedis{@AutowiredprivateStringRedisTemplate stringRedisTemplate;@AutowiredprivateRedisTemplate redisTemplate;@AutowiredprivateRedisHelperImpl redisHelper;@Testpublicvoidtest()throwsException{//        基本写法//        stringRedisTemplate.opsForValue().set("aaa","111");//        Assert.assertEquals("111",stringRedisTemplate.opsForValue().get("aaa"));//        System.out.println(stringRedisTemplate.opsForValue().get("aaa"));Author user=newAuthor();user.setName("Alex");user.setIntro_l("不会打篮球的程序不是好男人");redisHelper.valuePut("aaa",user);System.out.println(redisHelper.getValue("aaa"));    }@TestpublicvoidtestObj()throwsException{Author user=newAuthor();user.setName("Jerry");user.setIntro_l("不会打篮球的程序不是好男人!");        ValueOperations<String, Author> operations=redisTemplate.opsForValue();operations.set("502", user);Thread.sleep(500);booleanexists=redisTemplate.hasKey("502");if(exists){System.out.println(redisTemplate.opsForValue().get("502"));}else{System.out.println("exists is false");        }// Assert.assertEquals("aa", operations.get("com.neo.f").getUserName());    }}

运行 TestRedis 测试类,结果如下。

注意:如果在 RedisConfiguration 中不配置redisTemplate(RedisConnectionFactory factory) 注解,会造成键、值的一个序列化问题,有兴趣的可以去试一下,序列化:序列化框架的选型和比对

4项目实战

首先需要在程序的入口处 Application 中添加 @EnableCaching 开启缓存的注解。

@EnableCaching//开启缓存@SpringBootApplicationpublicclassPoetryApplication{publicstaticvoidmain(String[] args){        SpringApplication.run(PoetryApplication.class, args);    }}

上面的 Redis 相关写法是我们自定义设置并获取的,那么我们经常要在访问接口的地方去使用 Redis 进行缓存相关实体对象以及集合等,那么我们怎么实现呢?

比如我现在想在 AuthorController 中去缓存作者相关信息的缓存数据,该怎么办呢?如下:

@RestController@RequestMapping(value ="/poem")publicclassAuthorController{privatefinalstatic Logger logger = LoggerFactory.getLogger(AuthorController.class);@AutowiredprivateAuthorRepository authorRepository;@Cacheable(value="poemInfo")//自动根据方法生成缓存@PostMapping(value ="/poemInfo")publicResult author(@RequestParam("author_id")int author_id,@RequestParam("author_name")String author_name) {if(StringUtils.isEmpty(author_id) || StringUtils.isEmpty(author_name)){returnResultUtils.error(ResultCode.INVALID_PARAM_EMPTY);        }        Author author;        Optional<Author> optional = authorRepository.getAuthorByIdAndName(author_id, author_name);if(optional.isPresent()) {author = optional.get();//通过\n或者多个空格 进行过滤去重if(!StringUtils.isEmpty(author.getIntro_l())) {                String s = author.getIntro_l();String intro = s.split("\\s +")[0];                author.setIntro_l(intro);            }}else{returnResultUtils.error(ResultCode.NO_FIND_THINGS);        }returnResultUtils.ok(author);    }}

这里 @Cacheable(value="poemInfo") 这个注解的意思就是自动根据方法生成缓存,value 就是缓存下来的 key。到这里我们就已经把 Redis 整合到了 Spring Boot 中了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容