还是来完善一下,很多地方不清不楚,可能过段时间自己都不清楚了。
本文主要记录如何在Java中利用redis进行定时任务的业务处理。
有些场景需要定时处理某些业务,这就不可能让人工定个闹钟提醒大家该做什么事情吧?有些场景我需要精确到秒进行业务触发,比如2020-11-14 8:00需要提醒我去医院,那么到这个时间就得进行数据发送。
这种场景可以使用定时框架quartz,java的timer等。但是这种框架如果业务需要以秒为单位的话,就需要在应用程序中每秒持续的进行业务判断处理,这样对于应用程序会有较大开销,若业务较多,会影响应用性能。
那么就可以换一种方案,使用redis来处理这个业务
一开始我知道Redis还能这么做的时候觉得好神奇,也觉得自己已经落伍了,所以决定痛定思痛,好好学习。
想要在redis中使用这种功能,就得先进行这两步~
- 打开键空间通知
- 对key设置超时时间
如何打开键空间?
我们可以先去看看什么是键空间通知
在redis中,由于开启键空间通知的话,会占用一定的CPU,所以默认是关闭的。
如果要是用到的话,需要去修改redis.conf文件的配置。
在windows中名字是redis.windows.conf
我建议直接修改文件即可:
打开配置文件,找到配置项notify-keyspace-events,配置如下选项。
详细配置字符项如下:
字符 | 通知 |
---|---|
K | 键空间通知,所有通知以__keyspace@__为前缀,详情下面介绍 |
E | 键事件通知,所有通知以__keyevent@__为前缀,详情下面介绍 |
g | DEL、EXPIRE、RENAME等类型无关的通用命令的通知 |
l | 列表命令的通知 |
s | 集合命令的通知 |
h | 哈希命令的通知 |
z | 有序集合命令的通知 |
x | 过期事件:每当有过期键被删除时发送 |
e | 驱逐事件:每当有键因为maxmemory政策而被删除时发送 |
A | 参数 g$lshzxe 的别名 |
若想要开启全部配置,就设置为EKA。若只想要开启某些通知的话,比如超时的配置,就设置为Kg或者Eg。若notify-keyspace-events为空,键空间通知则关闭。
输入的参数中至少要有一个K或者E,否则的话,不管其余的参数是什么,都不会有任何通知被分发。
定时任务的这个功能,就可以利用key的超时处理,当key超时后,那么就会PUB发布两个频道,键空间通知与键事件通知。
那么如何对key设置超时时间呢?主要有两种方式:
- 添加键值对的时候就设置,例如:
SETEX key 1000 value
直接设置key1000秒后过期。
- 使用expire或者expireat
//设置key 1000秒后超时
EXPIRE key 1000
//设置key在timeMills这个时间的时候超时,有准确的到期时间的话,就可以使用这个命令
EXPIREAT key timeMills
若配置了EKA那么在redis中的任何操作,键空间通知都会发送两种不同类型的事件。
比如对0号数据库中的一个key进行del操作,那么就会发送以下两种事件:
- PUBLISH __keyspace@0__:mykey del
- PUBLISH __keyevent@0__:del mykey
这两条命令,发现了什么?这……不就是Pub/Sub(发布/订阅)嘛?原来Redis的键空间通知是通过PUB\SUB机制来完成对事件的发布与订阅的。那我们就只需要需要订阅频道这两个频道__keyevent@0__:del或者__keyspace@0__:mykey,等着接收频道发布消息就好了吗,没错就是这样,这其中0表示的是0号数据库。
以上,redis的一些东西就介绍完了,下面就开始梳理业务设置
若我们需要在指定时间到达后,直接将某个数据删除,我们需要做什么呢?
- 订阅expire事件的频道
- 取得数据的唯一标识
这时候我们需要重新开启一个客户端,订阅__keyevent@0__:expired这个频道,该频道内的消息(message),就是超时的key。我们就可以对这个key进行处理,那么我们设置超时语句的时候,不就需要对key进行规则设计吗?
expire expiredata:dataid001 10
10秒后expiredata:dataid001这个key就会超时,而我们订阅的频道就会返回这一条消息,从这条消息中就知道dataid001是数据的唯一标识,这样我们可以对dataid001进行增删改查等业务处理了。
业务场景梳理完成,接下来Coding环节。
在本例子中,采用的是springboot集成的redis。那么,看一下我所使用的pom文件:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.redisroot</groupId>
<artifactId>redisdemo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>redisdemo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!--<scope>test</scope>-->
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
在Java中,我们若想要使用**PUB\SUB(发布\订阅)**的话,就需要编写三个文件代码。
- 配置消息监听器(RedisConfig)
- 编写消息监听器逻辑(RedisSubService)
- 编写消息发布的逻辑(setQuartzByUser)
1.RedisConfig
package com.redisroot.redisdemo.config;
import com.redisroot.redisdemo.service.RedisSubService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.listener.PatternTopic;
import org.springframework.data.redis.listener.RedisMessageListenerContainer;
import org.springframework.data.redis.listener.adapter.MessageListenerAdapter;
@Configuration
public class RedisConfig {
/**
* 配置消息监听器的容器
* 通过方法注入,将redisConnectionFactory、messageListenerAdapter注入进来
* @param redisConnectionFactory
* @param messageListenerAdapter
* @return
*/
@Bean
RedisMessageListenerContainer container(RedisConnectionFactory redisConnectionFactory, MessageListenerAdapter messageListenerAdapter) {
RedisMessageListenerContainer container = new RedisMessageListenerContainer();
container.setConnectionFactory(redisConnectionFactory);
//可以同时订阅多个频道
container.addMessageListener(messageListenerAdapter,new PatternTopic("__keyevent@0__:expired"));//订阅超时频道
container.addMessageListener(messageListenerAdapter,new PatternTopic("__keyevent@0__:del"));//订阅删除频道
return container;
};
/**
* 配置监听适配器,通过这个配置,将redisSubService实例注入
* @param redisSubService
* @return
*/
@Bean
MessageListenerAdapter listenerAdapter(RedisSubService redisSubService){
//return new MessageListenerAdapter(redisSubService,"method");
//若没有设置方法,会调用内部的默认方法handleMessage
//那么我们就需要去redisSubService写一个handleMessage方法
return new MessageListenerAdapter(redisSubService);
};
}
这段代码我们看到主要配置消息监听的容器(RedisMessageListenerContainer)与消息监听的适配器(MessageListenerAdapter)。
在RedisMessageListenerContainer源码中,我们就可以看到,该类实现了SmartLifecycle,用来监听心跳。
设置了消息监听器,也都是进入addListener方法内
而addListener中主要是判断所订阅的频道是否存在,才添加监听器。判断是否正在监听,所为true才进行频道的订阅。
而listening默认是为false的,是在lazyListen当中设置为true
而MessageListenerAdapter的设置就是将监听器授权给自己的方法。
而delegate默认的方法名就是handleMessage,当然也可以自己设置方法名。
2.消息监听器
package com.redisroot.redisdemo.service;
import com.redisroot.redisdemo.entity.ProductComment;
import com.redisroot.redisdemo.repository.ProductCommentRepository;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.Message;
import org.springframework.data.redis.connection.MessageListener;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.listener.adapter.MessageListenerAdapter;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;
@Service
@Slf4j
public class RedisSubService {
@Autowired
private ProductCommentRepository productCommentRepository;
@Autowired
private StringRedisTemplate stringRedisTemplate;
/**
* 接收到消息的处理方法
*/
public void handleMessage(String message) {
if(!StringUtils.isEmpty(message)){
log.info("Redis sub 接收到消息,消息为"+message);
String[] messages = message.split(":");
String userid = messages[messages.length-1];
//使用jpa对数据进行删除
productCommentRepository.delete(ProductComment.builder().id(userid).build());
}
}
}
而这段代码,我就将key进行解析,获取真实的id进行数据删除,这里使用的是jpa进行数据库操作。
3.消息发布(这边只设置了超时时间,因为超时后会自动发布)
package com.redisroot.redisdemo.service;
import com.redisroot.redisdemo.entity.ProductComment;
import com.redisroot.redisdemo.repository.ProductCommentRepository;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Example;
import org.springframework.data.redis.core.HashOperations;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
@Service
@Slf4j
public class RedisService {
@Autowired
private ProductCommentRepository productCommentRepository;
@Autowired
private StringRedisTemplate stringRedisTemplate;
public void setQuartzByUser(){
ValueOperations valueOperations = stringRedisTemplate.opsForValue();
Example example = Example.of(ProductComment.builder().id("pc1").build());
Optional<ProductComment> optional = productCommentRepository.findOne(example);
ProductComment comment = optional.get();
valueOperations.set("expired:"+comment.getId(),comment.getCommentText());
stringRedisTemplate.expire("expired:"+comment.getId(),30, TimeUnit.SECONDS);//30秒后超时。
//也可以使用expireAt在超过指定时间后对key进行删除
//stringRedisTemplate.expireAt("key",new Date());
//若想要自己发布消息,就是以下代码
//stringRedisTemplate.convertAndSend("topic","自己发送消息");
//此时消息监听器配置的订阅频道就要换成topic啦
}
}
然后再Application中调用setQuartzByUser方法,直接执行就好啦。
package com.redisroot.redisdemo;
import com.redisroot.redisdemo.service.RedisService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class RedisDemoApplication implements CommandLineRunner {
@Autowired
private RedisService redisService;
public static void main(String[] args) {
SpringApplication.run(RedisDemoApplication.class, args);
}
/**
* 注册redisTemplate
*
* @param redisConnectionFactory
* @return
*/
@Bean
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
StringRedisTemplate redisTemplate = new StringRedisTemplate();
redisTemplate.setConnectionFactory(redisConnectionFactory);
return redisTemplate;
}
@Override
public void run(String... args) throws Exception {
}
@RequestMapping("/index")
public String index(){
redisService.setQuartzByUser();
return "success";
}
}
建议在redis客户端中进行简单的测试,我是在客户端测试通过后才进行程序开发。
若有不足,请指正,谢谢!