SpringBoot零基础集成xxl-job

SpringBoot零基础集成xxl-job

xxl-job主要分成两部分:

• 一部分是xxl-job-admin。这是管理控制台，简单理解就是用于管理和调度任务。
• 另一部分是xxl-job-core。这主要是帮助开发人员更高效的开发具体的任务，然后与调度中心交互，完成具体任务的执行操作。

xxl-job-admin部署

xxl-job源码地址https://github.com/xuxueli/xxl-job

• 下载源码
  • git clone https://github.com/xuxueli/xxl-job
• 执行数据库初始化脚本tables_xxl_job.sql
  
• 修改配置文件tables_xxl_job.sql
  
  • 修改xxl-job-admin启动端口
    
  • 修改数据库配置信息
    
  • 关闭邮件通知服务
    
• 启动xxl-job-admin
  
  • 输出以下日志代表启动成功

  Connected to the target VM, address: '127.0.0.1:52449', transport: 'socket'
  
  .   ____          _            __ _ _
  /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
  ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
  \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
  =========|_|==============|___/=/_/_/_/
  :: Spring Boot ::                (v2.4.5)
  
  12:55:31.507 logback [main] INFO  c.x.job.admin.XxlJobAdminApplication - Starting XxlJobAdminApplication using Java 1.8.0_241 on DESKTOP-MRA9GD8 with PID 5492 (G:\projects-blog\xxl-job\xxl-job-admin\target\classes started by Administrator in G:\projects-blog\xxl-job)
  12:55:31.518 logback [main] INFO  c.x.job.admin.XxlJobAdminApplication - No active profile set, falling back to default profiles: default
  12:55:39.973 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat initialized with port(s): 8080 (http)
  12:55:40.002 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8080"]
  12:55:40.004 logback [main] INFO  o.a.catalina.core.StandardService - Starting service [Tomcat]
  12:55:40.005 logback [main] INFO  o.a.catalina.core.StandardEngine - Starting Servlet engine: [Apache Tomcat/9.0.45]
  12:55:40.306 logback [main] INFO  o.a.c.c.C.[.[.[/xxl-job-admin] - Initializing Spring embedded WebApplicationContext
  12:55:40.306 logback [main] INFO  o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 7862 ms
  12:55:42.028 logback [main] INFO  c.x.j.a.c.scheduler.XxlJobScheduler - >>>>>>>>> init xxl-job admin success.
  12:55:42.064 logback [xxl-job, admin JobLogReportHelper] INFO  com.zaxxer.hikari.HikariDataSource - HikariCP - Starting...
  12:55:42.281 logback [xxl-job, admin JobLogReportHelper] INFO  com.zaxxer.hikari.HikariDataSource - HikariCP - Start completed.
  12:55:42.487 logback [main] INFO  o.s.s.c.ThreadPoolTaskExecutor - Initializing ExecutorService 'applicationTaskExecutor'
  12:55:43.048 logback [main] INFO  o.s.b.a.w.s.WelcomePageHandlerMapping - Adding welcome page template: index
  12:55:44.373 logback [main] INFO  o.s.b.a.e.web.EndpointLinksResolver - Exposing 2 endpoint(s) beneath base path '/actuator'
  12:55:44.508 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Starting ProtocolHandler ["http-nio-8080"]
  12:55:44.571 logback [main] INFO  o.a.c.c.C.[.[.[/xxl-job-admin] - Initializing Spring DispatcherServlet 'dispatcherServlet'
  12:55:44.573 logback [main] INFO  o.s.web.servlet.DispatcherServlet - Initializing Servlet 'dispatcherServlet'
  12:55:44.576 logback [main] INFO  o.s.web.servlet.DispatcherServlet - Completed initialization in 3 ms
  12:55:44.583 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat started on port(s): 8080 (http) with context path '/xxl-job-admin'
  12:55:44.618 logback [main] INFO  c.x.job.admin.XxlJobAdminApplication - Started XxlJobAdminApplication in 14.266 seconds (JVM running for 16.126)
  12:55:47.010 logback [xxl-job, admin JobScheduleHelper#scheduleThread] INFO  c.x.j.a.c.thread.JobScheduleHelper - >>>>>>>>> init xxl-job admin scheduler success.
  

  • 当然也可以通过mvn package命令打成Fatjar，然后通过java -jar xxxx.jar命令运行
• 浏览器访问调度中心
  • 访问地址http://localhost:8080/xxl-job-admin/
    
  • 默认登录账号: admin
  • 默认登录密码: 123456
• 登录后的界面
  

部署SpringBoot示例xxl-job-executor-sample-springboot

• 修改配置
  • 修改示例程序启动的端口
  • 修改调度中心的地址
  • 修改示例程序与调度中心通讯的端口
    
• 启动示例程序
  
  • 当然也可以通过mvn package命令打成Fatjar，然后通过java -jar xxxx.jar命令运行
  • 输出以下日志代表启动成功

  Connected to the target VM, address: '127.0.0.1:55351', transport: 'socket'
  
  .   ____          _            __ _ _
  /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
  ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
  \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
  =========|_|==============|___/=/_/_/_/
  :: Spring Boot ::                (v2.4.5)
  
  13:18:48.342 logback [main] INFO  c.x.j.e.XxlJobExecutorApplication - Starting XxlJobExecutorApplication using Java 1.8.0_241 on DESKTOP-MRA9GD8 with PID 7176 (G:\projects-blog\xxl-job\xxl-job-executor-samples\xxl-job-executor-sample-springboot\target\classes started by Administrator in G:\projects-blog\xxl-job)
  13:18:48.348 logback [main] INFO  c.x.j.e.XxlJobExecutorApplication - No active profile set, falling back to default profiles: default
  13:18:51.795 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat initialized with port(s): 8081 (http)
  13:18:51.812 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8081"]
  13:18:51.814 logback [main] INFO  o.a.catalina.core.StandardService - Starting service [Tomcat]
  13:18:51.814 logback [main] INFO  o.a.catalina.core.StandardEngine - Starting Servlet engine: [Apache Tomcat/9.0.45]
  13:18:51.998 logback [main] INFO  o.a.c.c.C.[Tomcat].[localhost].[/] - Initializing Spring embedded WebApplicationContext
  13:18:51.999 logback [main] INFO  o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 2909 ms
  13:18:52.152 logback [main] INFO  c.x.j.e.core.config.XxlJobConfig - >>>>>>>>>>> xxl-job config init.
  13:18:52.515 logback [main] INFO  o.s.s.c.ThreadPoolTaskExecutor - Initializing ExecutorService 'applicationTaskExecutor'
  13:18:53.303 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:demoJobHandler2, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@4f2d014a[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#demoJobHandler2]
  13:18:53.310 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:demoJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@28e0e464[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#demoJobHandler]
  13:18:53.311 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:httpJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@1d98daa0[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#httpJobHandler]
  13:18:53.311 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:commandJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@70a898b0[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#commandJobHandler]
  13:18:53.312 logback [main] INFO  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job register jobhandler success, name:shardingJobHandler, jobHandler:com.xxl.job.core.handler.impl.MethodJobHandler@7bdf61ad[class com.xxl.job.executor.service.jobhandler.SampleXxlJob#shardingJobHandler]
  13:18:53.777 logback [main] WARN  c.x.job.core.executor.XxlJobExecutor - >>>>>>>>>>> xxl-job accessToken is empty. To ensure system security, please set the accessToken.
  13:18:53.879 logback [main] INFO  o.a.coyote.http11.Http11NioProtocol - Starting ProtocolHandler ["http-nio-8081"]
  13:18:53.975 logback [main] INFO  o.s.b.w.e.tomcat.TomcatWebServer - Tomcat started on port(s): 8081 (http) with context path ''
  13:18:53.996 logback [main] INFO  c.x.j.e.XxlJobExecutorApplication - Started XxlJobExecutorApplication in 6.383 seconds (JVM running for 9.119)
  13:18:55.608 logback [Thread-5] INFO  com.xxl.job.core.server.EmbedServer - >>>>>>>>>>> xxl-job remoting server start success, nettype = class com.xxl.job.core.server.EmbedServer, port = 9999
  

• 在调度中心界面配置执行器
  • 查看本机IP
    
  • 配置执行器
    
• 在调度中心界面调度执行一次任务
  
• 查看执行日志
  
  

分析执行日志原理

从上面的执行日志中可以看到输出XXL-JOB, Hello World等内容，这是怎么输出到调度中心的呢？接着往下看。

示例程序中的代码位置

使用XxlJobHelper.log()这个方法可以把日志输出到调度中心，如果使用本地的slf4j输出日志则只能打印到本地，要注意这个区别。

@XxlJob注解的使用

示例源码@XxlJob("demoJobHandler")中的demoJobHandler要与调度中心的配置JobHandler保持一致

总结

• 每个步骤都有截图，写的很详细，方便零基础的同学跟着节奏一步一步上手。
• 有兴趣的同学可以模仿这个示例程序自己写一个JobHandler，然后在调度中心注册一个执行器，新增一个任务。
• 如果有疑问，欢迎交流沟通。