Microservices Engine:Manage XXL-JOB jobs in SchedulerX 2.0

Benefits

Commercialized alerting and O&M

Differences between XXL-JOB based on SchedulerX V2.0 and open source XXL-JOB

Connect XXL-JOB jobs to SchedulerX 2.0

Procedure

Delete the com.xuxueli:xxl-job-core dependency and add com.aliyun.schedulerx:schedulerx2-plugin-xxljob, which is the dependency and plug-in of the SchedulerX agent. In this example, schedulerx2-spring-boot-starter is connected.

1. Add the following dependencies to the pom.xml file to connect the SchedulerX agent:

   XXL-JOB V2.3.X

   <!-- xxl-job-core annotation -->
   <!--
   <dependency>
   	<groupId>com.xuxueli</groupId>
   	<artifactId>xxl-job-core</artifactId>
   	<version>${project.parent.version}</version>
   </dependency>
   -->
   <! -- Add the schedulerx dependency -->
   <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx2-spring-boot-starter</artifactId>
     <version>${schedulerx2.version}</version>
   </dependency>
   <! -- Add schedulerx2-plugin-xxljob -->
   <dependency>
   	<groupId>com.aliyun.schedulerx</groupId>
   	<artifactId>schedulerx2-plugin-xxljob</artifactId>
   	<version>2.3.5</version>
   </dependency>

   For more information, see Demo.

   XXL-JOB V2.2.x or earlier

   <!-- xxl-job-core annotation -->
   <!--
   <dependency>
   	<groupId>com.xuxueli</groupId>
   	<artifactId>xxl-job-core</artifactId>
   	<version>${project.parent.version}</version>
   </dependency>
   -->
   <! -- Add the schedulerx dependency -->
   <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx2-spring-boot-starter</artifactId>
     <version>${schedulerx2.version}</version>
   </dependency>
   <! -- Add schedulerx2-plugin-xxljob -->
   <dependency>
   	<groupId>com.aliyun.schedulerx</groupId>
   	<artifactId>schedulerx2-plugin-xxljob</artifactId>
   	<version>2.2.4</version>
   </dependency>

   For more information, see Demo.

2. Add the following configurations to the application.properties file:

   spring.schedulerx2.endpoint=xxxxxxx
   spring.schedulerx2.namespace=xxxxxxx
   spring.schedulerx2.groupId=xxxxxxxx
   spring.schedulerx2.appKey=xxxxxxx

Create a method job

Obtain job parameters

• If the version of the plug-in that you use is V2.2.x, run the following code to obtain job parameters:

  // If you use a V2.2.x plug-in, you can use one of the following methods to obtain job parameters: 
  // 1. Use the String input parameter of the method. 
  // 2. Use the XxlJobHelper.getJobParam() method. 
  @XxlJob("demoJobHandler")
  public void demoJobHandler(String  jobParameters) throws Exception {
      XxlJobHelper.log("XXL-JOB, Hello World." + jobParameters);
      String jobParam = XxlJobHelper.getJobParam();
      XxlJobHelper.log("XXL-JOB, Hello World." + jobParam);
      // default success
  }

• If the version of the plug-in that you use is V2.3.x, run the following code to obtain job parameters:

  // If you use a V2.3.x plug-in, you can use one of the following methods to obtain job parameters: 
  // 1. Use the XxlJobHelper.getJobParam() method. 
  @XxlJob("demoJobHandler")
  public void demoJobHandler() throws Exception {
      String jobParam = XxlJobHelper.getJobParam();
      XxlJobHelper.log("XXL-JOB, Hello World." + jobParam);
      // default success
  }

Migrate multiple XXL-JOB jobs at a time

Step 1: Export the configurations of XXL-JOB jobs

1. Download xxljob-export.tar.

2. Decompress the package, view the readme file, and add the following code to the application.properties file:

   ### xxl-job, datasource
   datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
   datasource.username=root
   datasource.password=123456
   datasource.driver-class-name=com.mysql.cj.jdbc.Driver
   
   ### Specify the name of the application whose job configurations you want to export. If you skip this step, the configurations of the jobs in all groups are exported.
   #xxl-job.app-name=xxl-job-executor-sample
   
   # Optional. Filter the specified job description, which contains the specified string.
   #xxl-job.filter.job-desc=test
   
   # Optional. Filter the author information of the specified job, which contains the specified string.
   #xxl-job.filter.author=test
   
   # Optional. Filter the configurations of jobs in the specified state (0: disabled; 1: enabled). If you skip this step, the configurations of all jobs are exported.
   #xxl-job.filter.trigger-status=0
   
   # Optional. Specify the start page number of job configurations to read. Default value: 0. Job configurations are sorted in different pages by job ID.
   #xxl-job.filter.page-start=0
   
   # Optional. Specify the page size of job configurations to read. By default, the page size has no limit. Job configurations are sorted by job ID.
   #xxl-job.filter.page-size=10
   
   
   # Optional. Specify the status of exported jobs. Valid values: 0 (disabled) and 1 (enabled). By default, the original status of jobs before the export is retained.
   #xxl-job.default.job-status=0

3. Run the ./start.sh command to export the job configurations.

4. After the configurations are exported, obtain the xxljob_*******.json configuration file that contains only job configurations in Bean mode.

Step 2: Import XXL-JOB jobs to SchedulerX 2.0

1. Log on to the SchedulerX console. In the left-side navigation pane, click Task Management. On the Task Management page, click Import Task.

2. Import the exported configuration file to synchronize the XXL-JOB jobs to SchedulerX.

FAQ

/**
 * Copyright (c) 2022-present Alibaba Group
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

package com.alibaba.schedulerx.example.xxljob;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        return xxlJobSpringExecutor;
    }
}