springboot 集成shedlock

怼烎@ 2022-11-09 12:57 150阅读 0赞

shedLock介绍：  
当我们的服务是集群部署时，我们代码中的定时任务在每个节点都有，每个节点都去跑定时任务很显然不大合适，这就是我们要解决的问题。

shedlock guiHub: https://github.com/lukas-krecan/ShedLock

使用数据库作为第三方锁  
mysql 建表

CREATE TABLE shedlock(name VARCHAR(64) NOT NULL, lock_until TIMESTAMP(3) NOT NULL,
        locked_at TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3), locked_by VARCHAR(255) NOT NULL, PRIMARY KEY (name));

## pom依赖 ##

<dependency>
                <groupId>net.javacrumbs.shedlock</groupId>
                <artifactId>shedlock-spring</artifactId>
                <version>4.21.0</version>
            </dependency>
    
            <dependency>
                <groupId>net.javacrumbs.shedlock</groupId>
                <artifactId>shedlock-provider-jdbc-template</artifactId>
                <version>4.21.0</version>
            </dependency>
            
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.25</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.2.4</version>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>

## application.yml ##

server:
      port: 8889
    
    spring:
      #数据库配置 根据实际修改ip 库 用户名 密码等
      datasource:
        driverClassName: com.mysql.jdbc.Driver
        type: com.alibaba.druid.pool.DruidDataSource
        url: jdbc:mysql://xx.xx.xx.xx:3306/shed_lock?useSSL=false&useUnicode=true&amp&characterEncoding=utf-8
        username: root
        #ENC()前缀为数据库密码密文处理，也可直接配置数据库密码如：password =7ui8&UI*
        password: xxxx
    logging:
      level:
        com.example.shedlockdemo: debug

## 配置类 ##

package com.example.shedlockdemo.conf;
    
    import lombok.extern.slf4j.Slf4j;
    import net.javacrumbs.shedlock.core.LockProvider;
    import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.jdbc.core.JdbcTemplate;
    import org.springframework.scheduling.annotation.EnableScheduling;
    import net.javacrumbs.shedlock.provider.jdbctemplate.JdbcTemplateLockProvider;
    import javax.sql.DataSource;
    
    @Configuration
    @EnableScheduling
    @EnableSchedulerLock(defaultLockAtMostFor = "10m")
    @Slf4j
    public class MySpringConfiguration { 
      
      @Bean
      public LockProvider lockProvider(DataSource dataSource) { 
    
        return new JdbcTemplateLockProvider(
          JdbcTemplateLockProvider.Configuration.builder()
            .withJdbcTemplate(new JdbcTemplate(dataSource))
            .usingDbTime() // Works on Postgres, MySQL, MariaDb, MS SQL, Oracle, DB2, HSQL and H2
            .build()
        );
      }
    }

## 创建定时任务 ##

注解参数说明：

*  定时任务使用的是shedLock --jdbc分布式锁,当任务执行的时，
 *  当前节点获取到锁，存储到sehdlock表中，表由框架维护，无需我们设置
 *  @Scheduled 定时任务时间表达式
 *  @SchedulerLock任务锁—
 *  name->锁名称，定时任务的名字是锁的id
 *  lockAtMostFor–>设置锁的最大持续时间，防止当某个节点宕机，没有释放，导致其他节点不能执行下一次任务，**小于定时任务间隔时间**
 *  lockAtLeastFor–>保留锁的最短时间，防止如果定时的执行时间短，不同节点之间的服务器时间存在差异，导致定时重复执行；

package com.example.shedlockdemo.task;
    
    import lombok.extern.slf4j.Slf4j;
    import net.javacrumbs.shedlock.spring.annotation.SchedulerLock;
    import org.springframework.scheduling.annotation.Scheduled;
    import org.springframework.stereotype.Component;
    
    @Component
    @Slf4j
    public class TimeTaskJob { 
    
      //定时任务1
      @Scheduled(cron = "0/2 * * * * *")
      @SchedulerLock(name = "scheduledTaskName", lockAtMostFor = "1s", lockAtLeastFor = "1s")
      public void scheduledTask() { 
        //todo 定时任务业务逻辑实现
        log.debug("scheduledTaskName");
      }
    
      //定时任务2
      @Scheduled(cron = "0/5 * * * * *")
      @SchedulerLock(name = "scheduledTaskFive", lockAtMostFor = "4s", lockAtLeastFor = "4s")
      public void scheduledTaskFive() { 
        //todo 定时任务业务逻辑实现
        log.debug("scheduledTaskName-5s");
    
      }
    }

拷贝两项目运行即可  
数据库中会看到注册进去的定时任务。

shedLock 当多个节点都有定时，某个节点启动后，会获得数据中shedLock表中的锁，其他的定时再来时，无法获取锁对象，认为其他的节点已经在执行了，所以就不在去执行。这个表是shedLock自带的表，无需程序员自己维护

![在这里插入图片描述][20210315160423229.png]

[20210315160423229.png]: /images/20221023/c125a5d33fbb4566bc3f7a3fbf411f67.png