github-forks
/
spring-cloud-alibaba
mirror of https://github.com/alibaba/spring-cloud-alibaba.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.2.x
2022.x
2021.x
2023.x
1116-yuluo/remove-ai
2023.x-2024-ospp
2023.x-dashscope-ai
2.2.x-ospp2023
spring-cloud-dubbo
2020.0.0
greenwich
rocketmq
spring-cloud-gateway
1.x
2022.0.0.2
2023.0.3.2
2.2.11
2021.0.6.2
2023.0.1.3
2023.0.1.0
2.2.10-RC2
2021.0.6.0
2.2.10-RC1
2021.0.1.0
2.0.2.RELEASE
2.0.3.RELEASE
2.0.4.RELEASE
2.1.2.RELEASE
2.1.3.RELEASE
2.1.4.RELEASE
2.2.1.RELEASE
2.2.10
2.2.2.RELEASE
2.2.3.RELEASE
2.2.4.RELEASE
2.2.5-RocketMQ-RC1
2.2.5.RC1
2.2.5.RC2
2.2.5.RELEASE
2.2.6.RC1
2.2.6.RELEASE
2.2.7.RELEASE
2.2.8.RELEASE
2.2.9.RELEASE
2020.0.RC1
2021.0.4.0
2021.0.5.0
2021.0.6.1
2021.1
2022.0.0.0
2022.0.0.0-RC1
2022.0.0.0-RC2
2023.0.0.0-RC1
2023.0.1.1
2023.0.1.2
v0.1.0.RELEASE
v0.1.1.RELEASE
v0.1.2.RELEASE
v0.2.0.RELEASE
v0.2.1.RELEASE
v0.2.2.RELEASE
v0.9.0.RELEASE
v1.5.0.RELEASE
v1.5.1.RELEASE
v2.0.0.RELEASE
v2.0.1.RELEASE
v2.1.0.RELEASE
v2.1.1.RELEASE
v2.2.0.RELEASE
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2.2.x'
${ noResults }
spring-cloud-alibaba/spring-cloud-alibaba-examples/spring-cloud-scheduling-exa.../README-en.md

6.6 KiB
Raw Permalink Blame History Unescape Escape

Spring Cloud Alibaba Scheduling Example

Project description

Spring Cloud Alibaba Scheduling provides a timing task scheduling capability based on Spring Scheduling, supporting distributed scenarios for timing task scheduling. It offers a quick integration solution for timing task scheduling services in distributed scenarios.

The current offering is based on the open-source ShedLock for distributed lock acquisition, along with Alibaba Cloud's SchedulerX service quick start, Subsequent releases will provide access to more open-source solutions implementations.

Project dependencies

Access spring-cloud-starter-alibaba-schedulerx

Add the following dependencies to the project pom.xml：

<dependency>
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-schedulerx</artifactId>
</dependency>

Project config description

In the Example project, two types of integration configuration modes are provided for shedlock and schedulerx, Select the required access mode configuration file in application.yaml, the example defaults to the shedlock solution.

Solution 1. Distributed shedlock integration configuration

Edit the following configuration to the application-schedulerx.yml:

spring:
   cloud:
      scheduling:
         # Distributed mode: shedlock, schedulerx
         # Set config value: shedlock
         distributed-mode: shedlock
   datasource:
      driver-class: com.mysql.cj.jdbc.Driver
      url: {jdbc_url}
      username: {jdbc.username}
      password: {jdbc.password}

You should replace {jdbc_url},{jdbc.username}, and {jdbc.password} with your actual database connection information.

️ Precautions：If there's no database instance can be used, please create a database instance first.

Solution 2. Alibaba Cloud's SchedulerX integration configuration

Edit the following configuration to the application-schedulerx.yml:

spring:
   cloud:
      scheduling:
         # Distributed mode: shedlock, schedulerx
         # Set config value: schedulerx
         distributed-mode: schedulerx
         schedulerx:
            # This configuration is required, Please get it from aliyun schedulerx console
            endpoint: acm.aliyun.com
            namespace: aad167f6-xxxx-xxxx-xxxx-xxxxxxxxx
            groupId: xxxxx
            appKey: PZm1XXXXXXXXXXXX
            # Optional config, if you need to sync task to schedulerx
            # task-sync: true
            # region-id: public
            # aliyun-access-key: XXXXXXXXXXXX
            # aliyun-secret-key: XXXXXXXXXXXX
            # task-model-default: standalone

On Alibaba Cloud service, each account has be granted a free quota for schedulerx. For detailed instructions on how to configure and use cloud product integrations, please refer to the respective product documentation. Refer to: SchedulerX Spring Task

Start application

After completing the above selection and configuration, simply run the ScheduleApplication class in Example to start the application. The SimpleJob class in this example project includes two Spring scheduled tasks that run every minute. Upon starting, you can expect to see the following logs:

2024-05-17T11:20:59.981+08:00  INFO 66613 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-4] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-17 11:20:59 do job1...
2024-05-17T11:20:59.985+08:00  INFO 66613 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-1] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-17 11:20:59 do job2...

Distributed running verification

Create two application launch configurations in IDEA, each with the startup parameter --server.port={port} to start the corresponding application processes. The example project defaults to using shedlock, We can observe that job1 will be triggered by both applications, whereas job2 which has been annotated with @SchedulerLock will only be triggered in one application at the same time. idea-server-port

  • ScheduleApplication-1, startup parameter: --server.port=18080, application logs：
2024-05-20T14:02:00.003+08:00  INFO 80520 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-4] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:02:00 do job1...
2024-05-20T14:03:00.008+08:00  INFO 80520 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-4] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:03:00 do job1...
2024-05-20T14:03:00.008+08:00  INFO 80520 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-1] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:03:00 do job2...
2024-05-20T14:04:00.006+08:00  INFO 80520 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-3] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:04:00 do job1...
2024-05-20T14:04:00.010+08:00  INFO 80520 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-2] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:04:00 do job2...
2024-05-20T14:05:00.003+08:00  INFO 80520 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-5] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:05:00 do job1...
  • ScheduleApplication-2, startup parameter: --server.port=18081, application logs：
2024-05-20T14:02:00.003+08:00  INFO 80596 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-4] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:02:00 do job1...
2024-05-20T14:02:00.008+08:00  INFO 80596 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-3] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:02:00 do job2...
2024-05-20T14:03:00.004+08:00  INFO 80596 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-5] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:03:00 do job1...
2024-05-20T14:04:00.006+08:00  INFO 80596 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-3] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:04:00 do job1...
2024-05-20T14:05:00.004+08:00  INFO 80596 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-2] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:05:00 do job1...
2024-05-20T14:05:00.007+08:00  INFO 80596 --- [spring-cloud-alibaba-schedule-example] [ sca-schedule-4] c.a.c.examples.schedule.job.SimpleJob    : time=2024-05-20 14:05:00 do job2...