当前位置: 移动技术网 > IT编程>开发语言>Java > springboot中使用redis的方法代码详解

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

2019年07月19日  | 移动技术网IT编程  | 我要评论

特别说明:

本文针对的是新版 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的方法代码详解,希望对大家有所帮助

如对本文有疑问, 点击进行留言回复!!

相关文章:

验证码:
移动技术网