|
|
@@ -277,7 +277,7 @@ The concrete contet describe as follows:
|
|
277
|
277
|
If you has finished step 1,then you can compile the project in maven and deploy the war package to tomcat.
|
|
278
|
278
|
the url to visit is :http://localhost:8080/xxl-job-admin (this address will be used by executor and use it as callback url),the index page after login in is as follow
|
|
279
|
279
|
|
|
280
|
|
-
|
|
|
280
|
+
|
|
281
|
281
|
|
|
282
|
282
|
Now,the “xxl-job-admin” project is deployed success.
|
|
283
|
283
|
|
|
|
@@ -371,16 +371,16 @@ Now let’s create a "GLUE模式(Java)" job,if you want to learn more about it ,
|
|
371
|
371
|
#### Step 1:Create new job
|
|
372
|
372
|
Login in xxl-job-admin,click on the"新建任务" button, configure the job params as follows and click "保存" button to save the job info.
|
|
373
|
373
|
|
|
374
|
|
-
|
|
|
374
|
+
|
|
375
|
375
|
|
|
376
|
|
-
|
|
|
376
|
+
|
|
377
|
377
|
|
|
378
|
378
|
#### Step 2：develop “GLUE模式(Java)” job
|
|
379
|
379
|
Click “GLUE” button on the right of the job to go to GLUE editor view as shown below。“GLUE模式(Java)” mode task has been inited with default task code for printing Hello World。 （ “GLUE模式(Java)” mode task is a java code fragment implements IJobHandler interface,it will be executed in executor,you can use @Resource/@Autowire to inject other java bean instance,if you want to see more info please go to chapter 3）
|
|
380
|
380
|
|
|
381
|
|
-
|
|
|
381
|
+
|
|
382
|
382
|
|
|
383
|
|
-
|
|
|
383
|
+
|
|
384
|
384
|
|
|
385
|
385
|
#### Step 3:trigger task
|
|
386
|
386
|
If you want to run the job manually please click "执行" button on the right of the job(usually we trigger job by Cron expression)
|
|
|
@@ -388,11 +388,11 @@ If you want to run the job manually please click "执行" button on the right of
|
|
388
|
388
|
#### Step 4:view log
|
|
389
|
389
|
Click “日志” button on the right side of the task you will go to the task log list ,you will see the schedule history records of the task and the schedule detail info,execution info and execution params.If you click the “执行日志” button on the right side of the task log record,you will go to log console and view the execute log in the course of task execution.
|
|
390
|
390
|
|
|
391
|
|
-
|
|
|
391
|
+
|
|
392
|
392
|
|
|
393
|
393
|
On the log console,you can view task execution log on the executor immediately after it dump to log file,so you can monitor the task execution process by Rolling way.
|
|
394
|
394
|
|
|
395
|
|
-
|
|
|
395
|
+
|
|
396
|
396
|
|
|
397
|
397
|
## 3. Task details
|
|
398
|
398
|
|
|
|
@@ -440,12 +440,12 @@ The task logic exist in the executor project as JobHandler,the develop steps as
|
|
440
|
440
|
- 3, add “@JobHandler(value=" customize jobhandler name")” annotation，the value stand for JobHandler name,it will be used as JobHandler property when create a new task in the schedule center.
|
|
441
|
441
|
（go and see DemoJobHandler in the xxl-job-executor-example project, as shown below）
|
|
442
|
442
|
|
|
443
|
|
-
|
|
|
443
|
+
|
|
444
|
444
|
|
|
445
|
445
|
#### Step 2:create task in schedule center
|
|
446
|
446
|
If you want learn more about configure item please go and sedd “Description of configuration item”，select "BEAN模式" as run mode，property JobHandler please fill in the value defined by @JobHande.
|
|
447
|
447
|
|
|
448
|
|
-
|
|
|
448
|
+
|
|
449
|
449
|
|
|
450
|
450
|
### 3.2 GLUE模式(Java)
|
|
451
|
451
|
Task source code is maintained in the schedule center and can be updated by Web IDE online, it will be compiled and effective real-time,didn’t need to assign JobHandler,develop flow shown as below:
|
|
|
@@ -453,14 +453,14 @@ Task source code is maintained in the schedule center and can be updated by Web
|
|
453
|
453
|
#### Step 1:create task in schedule center
|
|
454
|
454
|
If you want learn more about configure item please go and sedd “Description of configuration item”，select "GLUE模式(Java)" as run mode.
|
|
455
|
455
|
|
|
456
|
|
-
|
|
|
456
|
+
|
|
457
|
457
|
|
|
458
|
458
|
#### Step 2:develop task source code
|
|
459
|
459
|
Select the task record and click “GLUE” button on the righe of it,it will go to GLUE task’s WEB IDE page,on this page yo can edit you task code(also can edit in other IDE tools,copy and paste into this page).
|
|
460
|
460
|
|
|
461
|
461
|
Version backtrack（support 30 versions while backtrack）：on the WEB IDE page of GLUE task,on upper right corner drop down box please select “版本回溯”,it will display GLUE updated history,select the version you want it will display the source code of this version,it will backtrace the version while click save button.
|
|
462
|
462
|
|
|
463
|
|
-
|
|
|
463
|
+
|
|
464
|
464
|
|
|
465
|
465
|
### 3.3 GLUE模式(Shell)
|
|
466
|
466
|
|
|
|
@@ -472,7 +472,7 @@ Select the task record and click “GLUE” button on the righe of it,it will go
|
|
472
|
472
|
|
|
473
|
473
|
Actually it is a shell script fragment.
|
|
474
|
474
|
|
|
475
|
|
-
|
|
|
475
|
+
|
|
476
|
476
|
|
|
477
|
477
|
### 3.4 GLUE模式(Python)
|
|
478
|
478
|
|
|
|
@@ -484,19 +484,19 @@ Select the task record and click “GLUE” button on the righe of it,it will go
|
|
484
|
484
|
|
|
485
|
485
|
Actually it is a python script fragment.
|
|
486
|
486
|
|
|
487
|
|
-
|
|
|
487
|
+
|
|
488
|
488
|
|
|
489
|
489
|
|
|
490
|
490
|
## 4. Task Management
|
|
491
|
491
|
### 4.0 configure executor
|
|
492
|
492
|
click"执行器管理" on the left menu,it will go to the page as shown below:
|
|
493
|
|
-
|
|
|
493
|
+
|
|
494
|
494
|
|
|
495
|
495
|
1,"调度中心OnLine”:display schedule center machine list,when task is scheduled it will callback schedule center for notify the execution result in failover mode, so that it can avoid a single point scheduler;
|
|
496
|
496
|
2,"执行器列表" :display all nodes under this executor group.
|
|
497
|
497
|
|
|
498
|
498
|
If you want to create a new executor,please click "+新增执行器" button:
|
|
499
|
|
-
|
|
|
499
|
+
|
|
500
|
500
|
|
|
501
|
501
|
### Description of executor attributes
|
|
502
|
502
|
|
|
|
@@ -523,19 +523,19 @@ choose the task you want to edit and click” GLUE”button on the right side of
|
|
523
|
523
|
### 4.4 pause/recover task
|
|
524
|
524
|
You can pause or recover task but it just fit to follow up schedule trigger and won’t affect scheduled tasks,if you want to stop tasks which has been triggered,please go and see “4.8 stop the running task”
|
|
525
|
525
|
|
|
526
|
|
-
|
|
|
526
|
+
|
|
527
|
527
|
|
|
528
|
528
|
### 4.5 manually trigger
|
|
529
|
529
|
You can trigger a task manually by Click “执行”button,it won’t affect original scheduling rules.
|
|
530
|
530
|
|
|
531
|
|
-
|
|
|
531
|
+
|
|
532
|
532
|
|
|
533
|
533
|
### 4.6 view schedule log
|
|
534
|
534
|
You can view task’s history schedule log by click “日志” button,on the history schedule log list page you can view every time of task’s schedule result,execution result and so on,click “执行日志” button can view the task’s full execute log.
|
|
535
|
535
|
|
|
536
|
|
-
|
|
|
536
|
+
|
|
537
|
537
|
|
|
538
|
|
-
|
|
|
538
|
+
|
|
539
|
539
|
|
|
540
|
540
|
调度时间:schedule center trigger time when schedule and send execution signal to executor;
|
|
541
|
541
|
调度结果:schedule center trigger task’s result, 200 represent success,500 or other number stands for fail;
|
|
|
@@ -553,12 +553,12 @@ You can view task’s history schedule log by click “日志” button,on the h
|
|
553
|
553
|
### 4.7 view execution log
|
|
554
|
554
|
Click the “执行日志” button on the right side of the record,you can go to the execution log page,you can view the full execution log of the logic business code, shown as below:
|
|
555
|
555
|
|
|
556
|
|
-
|
|
|
556
|
+
|
|
557
|
557
|
|
|
558
|
558
|
### 4.8 stop running tasks
|
|
559
|
559
|
Just fit to running tasks,on the task log list page,click “终止任务” button on the right side of the record, it will send stop command to the executor where the task was executed,finally the task was killed and the task instance execute queue of this task will be clear.
|
|
560
|
560
|
|
|
561
|
|
-
|
|
|
561
|
+
|
|
562
|
562
|
|
|
563
|
563
|
It is implemented by interrupt execute thread, it will trigger InterruptedException.so if JobHandler catch this execuption and handle this exception this function is unavailable.
|
|
564
|
564
|
|
|
|
@@ -579,14 +579,14 @@ If JobHandler start child thread,child thread also must not catch InterruptedExc
|
|
579
|
579
|
|
|
580
|
580
|
### 4.9 delete execution log
|
|
581
|
581
|
On the task log list page, after you select executor and task, you can click"删除" button on the right side and it will pop-up "日志清理" window,on the pop-up window you can choose different log delete policy,choose the policy you want to execute and click "确定" button it will delele relative logs:
|
|
582
|
|
-
|
|
|
582
|
+
|
|
583
|
583
|
|
|
584
|
|
-
|
|
|
584
|
+
|
|
585
|
585
|
|
|
586
|
586
|
### 4.10 delete task
|
|
587
|
587
|
Click the delete button on the right side of the task,the task will be deteted.
|
|
588
|
588
|
|
|
589
|
|
-
|
|
|
589
|
+
|
|
590
|
590
|
|
|
591
|
591
|
## 5. Overall design
|
|
592
|
592
|
### 5.1 Source directory introduction
|
|
|
@@ -601,7 +601,7 @@ XXL-JOB schedule module is implemented based on Quartz cluster,it’s “databas
|
|
601
|
601
|
|
|
602
|
602
|
XXL-JOB custom Quartz table structure prefix(XXL_JOB_QRTZ_).
|
|
603
|
603
|
|
|
604
|
|
-
|
|
|
604
|
+
|
|
605
|
605
|
|
|
606
|
606
|
The added tables as shown below:
|
|
607
|
607
|
- XXL_JOB_QRTZ_TRIGGER_GROUP:executor basic table, maintain the info about the executor;
|
|
|
@@ -630,7 +630,7 @@ So schedule and task can be decoupled from each other, by the way it can improve
|
|
630
|
630
|
|
|
631
|
631
|
#### 5.3.3 Architecture diagram
|
|
632
|
632
|
|
|
633
|
|
-
|
|
|
633
|
+
|
|
634
|
634
|
|
|
635
|
635
|
### 5.4 Schedule module analysis
|
|
636
|
636
|
#### 5.4.1 Disadvantage of quartz
|
|
|
@@ -713,7 +713,7 @@ If executor project was deployed as cluster schedule center will known all onlin
|
|
713
|
713
|
When "路由策略" select "故障转移(FAILOVER)",it will send heart beat check request in order while schedule center start schedule request. The first alive checked executor node will be selected and send schedule request to it.
|
|
714
|
714
|
|
|
715
|
715
|
“调度备注” can be viewed on the monitor page when schedule success. As shown below:
|
|
716
|
|
-
|
|
|
716
|
+
|
|
717
|
717
|
|
|
718
|
718
|
“调度备注” will display local schedule route path、executor’s "注册方式"、"地址列表" and task’s "路由策略"。Under "故障转移(FAILOVER)" policy, schedule center take first address to do heartbeat detection, heat beat fail will automatically skip, the second address heart beat fail…… until the third address “127.0.0.1:9999” heart beat success, it was selected as target executor, then send schedule request to target executor, now the schedule process is end wait for the executor’s callback execution result.
|
|
719
|
719
|
|
|
|
@@ -743,9 +743,9 @@ When parent task end execute and success, it will match child task dependency ac
|
|
743
|
743
|
|
|
744
|
744
|
On the task log page ,you can see matched child task and triggered child task’s log info when you “查看”button of “执行备注”,otherwise the child task didin’t execute, as shown beleow:
|
|
745
|
745
|
|
|
746
|
|
-
|
|
|
746
|
+
|
|
747
|
747
|
|
|
748
|
|
-
|
|
|
748
|
+
|
|
749
|
749
|
|
|
750
|
750
|
### 5.5 Task "run mode" analysis
|
|
751
|
751
|
#### 5.5.1 "Bean模式" task
|
xuxueli