spring boot集成redis使用教程

蔚落 2024-03-24 12:49 66阅读 0赞

> 提示：这是一个简单、一看就会的spring boot集成redis使用教程。再使用前，请先在自己电脑里 下载好redis服务。

**目录**

一、什么是redis

二、项目集成redis相关依赖（这里使用的默认的lettuce做redis客户端，可自行选择引入jedis）

三、添加redis配置类

四、如何使用redis缓存

4.1 Spring Boot缓存注解

4.2 启动redis服务

4.2实现

总结

--------------------

## 一、什么是redis ##

## ![f95242bcfd7b4cae9fe72bb639310e88.png][] ##

## 二、项目集成redis相关依赖（这里使用的默认的lettuce做redis客户端，可自行选择引入jedis） ##

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
                <version>2.5.15</version>
            </dependency>
          <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-cache</artifactId>
                <version>2.5.15</version>
          </dependency>
            
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-pool2</artifactId>
                <version>2.6.0</version>
            </dependency>

## 三、添加redis配置类 ##

@Configuration //配置类
    @EnableCaching //开启缓存
    public class RedisConfig extends CachingConfigurerSupport {
        @Bean
        public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
            RedisTemplate<String, Object> template = new RedisTemplate<>();
            RedisSerializer<String> redisSerializer = new StringRedisSerializer();
            Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
            ObjectMapper om = new ObjectMapper();
            om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
            om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
            jackson2JsonRedisSerializer.setObjectMapper(om);
            template.setConnectionFactory(factory);
            //key序列化方式
            template.setKeySerializer(redisSerializer);
            //value序列化
            template.setValueSerializer(jackson2JsonRedisSerializer);
            //value hashmap序列化
            template.setHashValueSerializer(jackson2JsonRedisSerializer);
            return template;
        }
    
        @Bean
        public CacheManager cacheManager(RedisConnectionFactory factory) {
            RedisSerializer<String> redisSerializer = new StringRedisSerializer();
            Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new
                    Jackson2JsonRedisSerializer(Object.class);
            //解决查询缓存转换异常的问题
            ObjectMapper om = new ObjectMapper();
            om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
            om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
            jackson2JsonRedisSerializer.setObjectMapper(om);
            // 配置序列化（解决乱码的问题）,过期时间600秒
            RedisCacheConfiguration config =
                    RedisCacheConfiguration.defaultCacheConfig()
                            .entryTtl(Duration.ofSeconds(600)) //设置缓存存在的时间 600s
                            .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                            .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                            .disableCachingNullValues();
            RedisCacheManager cacheManager = RedisCacheManager.builder(factory)
                    .cacheDefaults(config)
                    .build();
            return cacheManager;
        }
    
    
    }

###  ###

## 四、如何使用redis缓存 ##

首先要明确，一个项目中是哪些地方需要使用到缓存。一般来说，前台用户访问量较大。并且由于前台数据变化不是很频繁，涉及更多的是查询操作。所以我们有必要把前台相关（如首页）数据缓存到redis缓存中，减少数据库压力和提高访问速度。

#### 4.1 Spring Boot缓存注解 ####

![54b4145b75d548af8225618c0f016af8.png][]

**（1）缓存@Cacheable**  
根据方法对其返回结果进行缓存，下次请求时，如果缓存存在，则直接读取缓存数据返回；如果缓存不  
存在，则执行方法，并把返回的结果存入缓存中。一般用在`查询方法`上。  
查看源码，属性值如下：

![bbcc4758a69b419b90aa604235c6be22.png][]

**（2）缓存@CachePut**

使用该注解标志的方法，每次都会执行，并将结果存入指定的缓存中。其他方法可以直接从响应的缓存  
中读取缓存数据，而不需要再去查询数据库。一般用在`新增方法`上。

![af8c3e6e031047da840c9e4892aaf78e.png][]

**（3）缓存@CacheEvict**

使用该注解标志的方法，会清空指定的缓存。一般用在`更新或者删除方法`上  
查看源码，属性值如下：

![34f7e2515bc045e0a7a6b41824d98d11.png][]![ce4abc7dc4184ddb80d4225d0a446eca.png][]

#### 4.2 启动redis服务 ####

启动你电脑上的redis服务

#### 4.3实现 ####

**（1）在yml文件中添加redis配置**

>     spring:
>       redis:
>         host: 192.168.101.132     #redis所在ip地址
>         port: 6379
>         password: root            #密码
>         connect-timeout: 1800000  #连接redis超时时间，（过期时间是配在config类中的）
>         database: 0
>         #lettuce客户端用以连接redis
>         lettuce:
>           pool:
>             max-active: 20        #lettuce最大连接数：能够同时建立的“最大链接个数”
>             max-wait: 1           #lettuce 从连接池中获取Collection最大等待时间：单位ms
>             max-idle: 5           #最大空闲数：空闲链接数大于maxIdle时，将进行回收
>             min-idle: 0           #最小空闲数：低于minIdle时，将创建新的链接

因为查询优先从缓存查，而如果数据做了修改为了能确保数据最终一致性。这里选择在修改、删除、添加等方法加@CacheEvict注解，当执行以上方法时直接删除缓存，然后再从数据库查出数据添加进缓存。

如

查询相关方法：

@Cacheable(value = "banner", key = "'selectIndexList'")
        @Override
        public List<CrmBanner> selectIndexList() {
            List<CrmBanner> list = baseMapper.selectList(new
            QueryWrapper<CrmBanner>().orderByDesc("sort"));
            return list;
        }

修改、删除、添加相关方法：

//CacheEvict用于更新或删除，allEntries属性清楚缓存
        @CacheEvict(value = "banner", allEntries=true)
        @Override
        public void updateBannerById(CrmBanner banner) {
       		 baseMapper.updateById(banner);
        }

#### 最后： 在你的启动类上添加 @EnableCaching 注解 开启缓存就行。 ####

--------------------

## 总结 ##

至此，一个简单的redis使用就完成了

[f95242bcfd7b4cae9fe72bb639310e88.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/2325f757eeb3410999ec525b4577d267.png
[54b4145b75d548af8225618c0f016af8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/c75aaab292cc47e9a69a64f5dd9a925d.png
[bbcc4758a69b419b90aa604235c6be22.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/3038d613dc034544b2bd159342f22b20.png
[af8c3e6e031047da840c9e4892aaf78e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/364bdecf0b4041e3b48d786cd2a1c96a.png
[34f7e2515bc045e0a7a6b41824d98d11.png]: https://img-blog.csdnimg.cn/34f7e2515bc045e0a7a6b41824d98d11.png
[ce4abc7dc4184ddb80d4225d0a446eca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/ef7e66d3cbeb4809a67dd7cc37cf01c9.png