spring boot分布式定时任务：使用xxl-job实现分布式定时任务代码示例

妖狐艹你老母 2024-02-18 12:30 72阅读 0赞

XXL-Job是一个开源的分布式任务调度平台，可以用于实现分布式定时任务。下面是一个简单的示例，演示如何使用XXL-Job来创建和执行分布式定时任务：

1.  在你的项目中添加XXL-Job的依赖。你可以在项目的`pom.xml`文件中添加以下依赖：

<dependency>
        <groupId>com.xuxueli</groupId>
        <artifactId>xxl-job-core</artifactId>
        <version>2.3.0</version>
    </dependency>

1.  创建一个任务类 `MyJobHandler.java`，实现`IJobHandler`接口：

import com.xxl.job.core.context.XxlJobHelper;
    import com.xxl.job.core.handler.IJobHandler;
    import com.xxl.job.core.handler.annotation.XxlJob;
    
    public class MyJobHandler extends IJobHandler {
        
    
        @XxlJob("myJobHandler")
        @Override
        public void execute() throws Exception {
        
            // 任务执行逻辑
            XxlJobHelper.log("分布式定时任务执行中...");
            // 执行完毕后返回成功
            XxlJobHelper.handleSuccess();
        }
    }

在上述代码中，`MyJobHandler`类实现了`IJobHandler`接口，并使用`@XxlJob`注解标记了任务执行方法。在任务执行方法中，你可以编写具体的业务逻辑。

1.  在XXL-Job的管理后台中创建一个任务，并指定任务的执行器为`com.xxl.job.core.executor.impl.XxlJobSpringExecutor`。在任务配置中，将`JobHandler`配置为`myJobHandler`，这与我们在`MyJobHandler`类中使用的`@XxlJob`注解的值相对应。
2.  在Spring Boot应用程序的配置类中配置XXL-Job的执行器：

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class XxlJobConfig {
        
    
        @Value("${xxl.job.admin.addresses}")
        private String adminAddresses;
    
        @Value("${xxl.job.executor.appname}")
        private String appName;
    
        @Value("${xxl.job.executor.ip}")
        private String ip;
    
        @Value("${xxl.job.executor.port}")
        private int port;
    
        @Value("${xxl.job.accessToken}")
        private String accessToken;
    
        @Bean(initMethod = "start", destroyMethod = "destroy")
        public XxlJobSpringExecutor xxlJobExecutor() {
        
            XxlJobSpringExecutor xxlJobExecutor = new XxlJobSpringExecutor();
            xxlJobExecutor.setAdminAddresses(adminAddresses);
            xxlJobExecutor.setAppName(appName);
            xxlJobExecutor.setIp(ip);
            xxlJobExecutor.setPort(port);
            xxlJobExecutor.setAccessToken(accessToken);
            return xxlJobExecutor;
        }
    }

在上述代码中，通过`@Configuration`注解将`XxlJobConfig`类声明为配置类，使用`@Bean`注解创建一个`XxlJobSpringExecutor`实例，并在该实例中设置相关属性，如XXL-Job的管理后台地址、应用程序名称、IP地址、端口号和访问令牌。

1.  启动Spring Boot应用程序，并启动XXL-Job的执行器。执行器将会向XXL-Job的管理后台注册，并按照配置执行定时任务。

通过以上步骤，你就可以使用XXL-Job来实现分布式定时任务了。在XXL-Job的管理后台创建任务，指定执行器为`com.xxl.job.core.executor.impl.XxlJobSpringExecutor`，编写任务逻辑的方法需要使用`@XxlJob`注解进行标记。在配置类中配置XXL-Job的执行器，并启动Spring Boot应用程序，即可实现定时任务的分布式执行。