Spring boot 整合 Redis

1安装

Redis下载地址:

https://redis.io/download

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

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

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

2整合到 Spring Boot

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

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 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 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 中了。