springboot中使用redis的方法代码详解

 更新时间:2019年05月29日 10:37:48   作者:烦嚣的人  
​redis 作为一个高性能的内存数据库,如果不会用就太落伍了,之前在 node.js 中用过 redis,本篇记录如何将 redis 集成到 spring boot 中。感兴趣的朋友跟随小编一起看看吧

特别说明:

本文针对的是新版 spring boot 2.1.3,其 spring data 依赖为 spring-boot-starter-data-redis,且其默认连接池为 lettuce

​redis 作为一个高性能的内存数据库,如果不会用就太落伍了,之前在 node.js 中用过 redis,本篇记录如何将 redis 集成到 spring boot 中。提供 redis 操作类,和注解使用 redis 两种方式。主要内容如下:

•docker 安装 redis
•springboot 集成 redis
•编写 redis 操作类
•通过注解使用 redis

安装 redis

通过 docker 安装,docker compose 编排文件如下:

# docker-compose.yml
version: "2"
services:
 redis:
 container_name: redis
 image: redis:3.2.10
 ports:
  - "6379:6379"

然后在docker-compose.yml所在目录使用docker-compose up -d命令,启动 redis。 

集成 springboot

说明:springboot 版本为 2.1.3

添加 maven 依赖

只需添加spring-boot-starter-data-redis依赖即可,并排除 lettuce 依赖,然后引入 jedis 和 jedis 的依赖 commons-pool2

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-data-redis</artifactId>
 <exclusions>
  <exclusion>
   <groupId>io.lettuce</groupId>
   <artifactId>lettuce-core</artifactId>
  </exclusion>
 </exclusions>
</dependency>

<dependency>
 <groupId>org.apache.commons</groupId>
 <artifactId>commons-pool2</artifactId>
</dependency>

<dependency>
 <groupId>redis.clients</groupId>
 <artifactId>jedis</artifactId>
</dependency>

编写 springboot 配置文件

配置文件如下:

server:
 port: 8081
 servlet:
 context-path: /sso
spring:
 application:
 name: SSO
 cache:
 type: redis
 redis:
 database: 0
 host: 192.168.226.5
 port: 6379
 # 有密码填密码,没有密码不填
 password:
 # 连接超时时间(ms)
 timeout: 1000ms
 # 高版本springboot中使用jedis或者lettuce
 jedis:
  pool:
  # 连接池最大连接数(负值表示无限制)
  max-active: 8
  # 连接池最大阻塞等待时间(负值无限制)
  max-wait: 5000ms
  # 最大空闲链接数
  max-idle: 8
  # 最小空闲链接数
  min-idle: 0

编写配置类

配置类代码如下:

@EnableCaching//开启缓存
@Configuration
public class RedisConfig extends CachingConfigurerSupport {
 /**
  * 设置缓存管理器,这里可以配置默认过期时间等
  *
  * @param connectionFactory 连接池
  * @return
  */
 @Bean
 public CacheManager cacheManager(RedisConnectionFactory connectionFactory) {
  RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration
    .defaultCacheConfig()
    .entryTtl(Duration.ofSeconds(60));
  //注意:请勿使用先new 配置对象,然后在调用entryTtl方法的方式来操作
  //会导致配置不生效,原因是调用.entryTtl方法会返回一个新的配置对象,而不是在原来的配置对象上修改

  RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(connectionFactory);
  RedisCacheManager manager = new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);
  return manager;
 }
 @SuppressWarnings("all")
 @Bean
 public RedisTemplate<String, String> redisTemplate(JedisConnectionFactory factory) {
  StringRedisTemplate template = new StringRedisTemplate(factory);
  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);
  RedisSerializer stringSerializer = new StringRedisSerializer();
  template.setKeySerializer(stringSerializer);
  template.setValueSerializer(jackson2JsonRedisSerializer);
  template.setHashKeySerializer(stringSerializer);
  template.setHashValueSerializer(jackson2JsonRedisSerializer);
  template.afterPropertiesSet();
  return template;
 }

 //使用jedis连接池建立jedis连接工厂
 @Bean
 public JedisConnectionFactory jedisConnectionFactory() {
  logger.info("jedisConnectionFactory:初始化了");
  JedisPoolConfig config = new JedisPoolConfig();
  config.setMaxIdle(maxIdle);
  config.setMinIdle(minIdle);
  config.setMaxWaitMillis(maxWaitMillis);
  config.setMaxTotal(maxActive);
  //链接耗尽时是否阻塞,默认true
  config.setBlockWhenExhausted(true);
  //是否启用pool的jmx管理功能,默认true
  config.setJmxEnabled(true);
  JedisConnectionFactory factory = new JedisConnectionFactory();
  factory.setPoolConfig(config);
  factory.setHostName(host);
  factory.setPort(port);
  factory.setPassword(password);
  factory.setDatabase(database);
  factory.setTimeout(timeout);
  return factory;
 }
}

使用方法

有两种方法来进行缓存操作,一种是在方法上添加缓存注解实现各种操作,一种是手动控制。个人比较喜欢手动控制,觉得这样都在自己的掌控中。

通过注解使用

主要有以下 5 个注解:

•@CacheConfig: 类级别缓存,设置缓存 key 前缀之类的
•@Cacheable: 触发缓存入口
•@CacheEvict: 触发移除缓存
•@CachePut: 更新缓存
•@Caching: 组合缓存

@CacheConfig

该注解可以将缓存分类,它是类级别注解,主要用于给某个类的缓存全局配置,例子如下:

@CacheConfig(cacheNames = "redis_test")
@Service
public class RedisService {
 //....
}

上面 CacheConfig 会给类下通过注解生成的 key 加上 redis_test 的前缀。

@Cacheable

方法级别注解,根据 key 查询缓存:

•如果 key 不存在,将方法返回值缓存到 redis 中
•如果 key 存在,直接从缓存中取值

 例子如下:

 /**
  * 缓存时间,首次查询后会缓存结果,key中的值可使用表达式计算.
  * 如不提供key,将使用默认key构造方法生成一个key
  * @return long
  */
 @Cacheable(key = "'currentTime'")
 public long getTime() {
  return System.currentTimeMillis();
 }

多次调用此段代码会发现每次返回的值都是一样的。

CachePut

用于更新缓存,每次调用都会想 db 请求,缓存数据

•如果 key 存在,更新内容
•如果 key 不存在,插入内容

代码如下:

/**
  * 一般用于更新查插入操作,每次都会请求db
  */
 @CachePut(key = "'currentTime'+#id")
 public long updateTime(String id) {
  return System.currentTimeMillis();
 }

每次调用此方法都会根据 key 刷新 redis 中的缓存数据。

@CacheEvict

根据 key 删除缓存中的数据。allEntries=true 表示删除缓存中所有数据。

 代码如下:

 @CacheEvict(key = "'currentTime'+#id",allEntries=false)
 public void deleteTime(String id) {
 }

@Caching

本注解可将其他注解组合起来使用。比如下面的例子:

//value属性为key指定前缀
 @Caching(put = {@CachePut(value = "user", key = "'name_'+#user.name"),
   @CachePut(value = "user", key = "'pass_'+#user.password")})
 public User testCaching(User user) {
  return user;
 }

上面的代码执行后将在 redis 中插入两条记录。使用keys *将看到如下结果:

手动控制

手动控制就相当于 mybatis 的手写 sql 语句,需要调用redisTemplate中的各种方法来进行缓存查询,缓存更新,缓存删除等操作。

使用方法参见 util/RedisUtil 中的方法。redisTemplate基本可以实现所有的 redis 操作。

项目源码

总结

以上所述是小编给大家介绍的springboot中使用redis的方法代码详解,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

相关文章

  • SpringBoot2.3定制错误页面的方法示例

    SpringBoot2.3定制错误页面的方法示例

    这篇文章主要介绍了SpringBoot2.3定制错误页面的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • springboot上传图片文件步骤详解

    springboot上传图片文件步骤详解

    这篇文章主要介绍了springboot上传图片文件步骤详解,本文通过实例代码图文相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • java.io.IOException:你的主机中的软件中止了一个已建立的连接踩坑实战

    java.io.IOException:你的主机中的软件中止了一个已建立的连接踩坑实战

    最近在工作中遇到了个问题,分享给同样遇到问题的同学,这篇文章主要给大家介绍了关于java.io.IOException:你的主机中的软件中止了一个已建立的连接的踩坑实战记录,需要的朋友可以参考下
    2023-03-03
  • springboot中报错Invalid character found in the request的解决

    springboot中报错Invalid character found in 

    这篇文章主要介绍了springboot中报错Invalid character found in the request的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-09-09
  • Java 多线程并发编程_动力节点Java学院整理

    Java 多线程并发编程_动力节点Java学院整理

    这篇文章主要介绍了Java 多线程并发编程的相关资料,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2017-05-05
  • SpringCloud中的Eureka注册中心详细解读

    SpringCloud中的Eureka注册中心详细解读

    这篇文章主要介绍了SpringCloud中的Eureka注册中心详细解读,想要参与服务注册发现的实例首先需要向Eureka服务器注册信息,注册在第一次心跳发生时提交,需要的朋友可以参考下
    2023-11-11
  • Springboot+ElementUi实现评论、回复、点赞功能

    Springboot+ElementUi实现评论、回复、点赞功能

    这篇文章主要介绍了通过Springboot ElementUi实现评论、回复、点赞功能。如果是自己评论的还可以删除,删除的规则是如果该评论下还有回复,也一并删除。需要的可以参考一下
    2022-01-01
  • java使用@Scheduled注解执行定时任务

    java使用@Scheduled注解执行定时任务

    这篇文章主要给大家介绍了关于java使用@Scheduled注解执行定时任务的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • 详解Spring数据缓存注解@Cacheable、@CachePut、@CacheEvict

    详解Spring数据缓存注解@Cacheable、@CachePut、@CacheEvict

    这篇文章主要介绍了详解Spring数据缓存注解@Cacheable、CachePut、@CacheEvict,当以一组参数第一次调用某个方法时,返回值会被保存在缓存中,如果这个方法再次以相同的参数进行调用时,这个返回值会从缓存中查询获取,需要的朋友可以参考下
    2023-07-07
  • SpringBoot图文并茂详解如何引入mybatis与连接Mysql数据库

    SpringBoot图文并茂详解如何引入mybatis与连接Mysql数据库

    这篇文章主要介绍了SpringBoot如何引入mybatis与连接Mysql数据库,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07

最新评论