分布式定时任务注解开发

1. 需求

我们在 SpringTask 一文中讲过 @Scheduled 并不支持分布式，这意味着很多定时任务会多次执行，这显然不是我们期望的结果。让我们利用我们讲过的 Spring AOP 来开发一个分布式的 @Scheduled 注解吧！

2. 准备

最好会用 SpringTask、Spring AOP、Redisson （不会也没关系），SpringTask和SpringAOP已经默认继承，只需引入Redisson。

        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson</artifactId>
            <version>3.16.1</version>
        </dependency>

3. 思路

1. 首先需要一个中间件来存储某个定时任务已经有一个服务去执行的相关信息，选择有很多，只要每个微服务都能够访问得到即可，如 zookeeper，Mysql，redis 等等。我们利用 Redis 实现。
2. 这个信息其实就类似于分布式锁，一个微服务执行定时任务前，先尝试从 Redis 中获取锁，获取到则执行，如果一个服务获取不到锁，就说明已经有一个微服务去执行了这个定时任务，那它就不必执行了。
3. 那我们如何干预定时任务呢，答案就是 AOP，利用 AOP 的环绕增强，我们可以控制定时任务是否执行。
4. 接来下就是抢锁和释放锁的逻辑，抢锁成功就允许定时任务执行，失败就不允许定时任务执行。

4. 实现

1. Redisson

Redisson为我们实现好了分布式锁，我们只需要配置客户端

import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.config.Config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * redis为单例情况下的配置
 * @Description: Redisson客户端
 * @Author: Shell Fish
 * @Date: 2021/8/4
 * @Version: V1.0
 */
@Configuration
public class RedissonConfig {
   

    @Value("${spring.redis.host}")
    String redisHost;
    @Value("${spring.redis.port}")
    Integer redisPort;
    @Value("${spring.redis.password}")
    String redisPassword;

    @Bean
    public RedissonClient redissonClient(){
   
        Config config = new Config();
        config.useSingleServer().setConnectionMinimumIdleSize(10);
        config.useSingleServer().setAddress("redis://"+redisHost+":"+redisPort).setPassword(redisPassword).setDatabase(0);
        return Redisson.create(config);
    }
}

2. 注解开发

希望在使用上更简单，我用新的注解直接代替原有的 @Scheduled 注解，这里我用 SpringMvc 的 @GetMapping 强化 @RequestMapping 的方式强化 @Scheduled，就像这样

import org.springframework.core.annotation.AliasFor;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import java.lang.annotation.*;

/**
 * name：你需要保证name所有的在定时任务是唯一的(每个name会对应一个锁)
 * <p/>
 * maxLockTime：最大锁时间(防止死锁)
 * <p/>
 * minLockTime：最小锁时间(服务器之间时间差最大限制值),一个定时任务需要在 12:00:00 的时候执行,允许这个定时任务延时 minLockTime 毫秒执行,
 *              @FishScheduled 仍可以保证分布式定时任务的控制。定时任务有时会延时几秒执行,可以通过增大 minLockTime 来控制
 *
 * @author: Shell Fish
 * @since: 1.0
 */
@Target({
   ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)