【PowerJob】入门使用指南

背景

在没有使用调度框架的情况下，开发者除了要实现定时任务本身的业务逻辑，还要解决并发问题、以及定时任务失败需要手动触发等一系列问题。主流的定时任务调度框架有Quartz、xxl-job、SchedulerX 2.0、PowerJob，这篇文章主要介绍的是PowerJob。相比于其它调度框架，PowerJob有以下特点：

	QuartZ	xxl-job	SchedulerX 2.0	PowerJob
定时类型	CRON	CRON	CRON、固定频率、固定延迟、OpenAPI	CRON、固定频率、固定延迟、OpenAPI
任务类型	内置Java	内置Java、GLUE Java、Shell、Python等脚本	内置Java、外置Java（FatJar）、Shell、Python等脚本	内置Java、外置Java（容器）、Shell、Python等脚本
分布式任务	无	静态分片	MapReduce 动态分片	MapReduce 动态分片
在线任务治理	不支持	支持	支持	支持
日志白屏化	不支持	支持	不支持	支持
调度方式及性能	基于数据库锁，有性能瓶颈	基于数据库锁，有性能瓶颈 基于数据库锁，有性能瓶颈	不详	不详 无锁化设计，性能强劲无上限
报警监控	无	邮件	短信	邮件，提供接口允许开发者扩展
系统依赖	关系型数据库（MySQL、Oracle…）	MySQL	人民币	任意 Spring Data Jpa支持的关系型数据库（MySQL、Oracle…）
DAG 工作流	不支持	不支持	支持	支持

定时任务代码开发

引入maven依赖

这里使用的版本是: <powerjob.version>5.0.1-beta</powerjob.version>

<dependency>
    <groupId>tech.powerjob</groupId>
    <artifactId>powerjob-worker-spring-boot-starter</artifactId>
    <version>${powerjob.version}</version>
</dependency>

application.properties程序配置

# akka 工作端口，可选，默认 27777
powerjob.worker.akka-port=27777
# 接入应用名称，用于分组隔离，推荐填写 本 Java 项目名称
powerjob.worker.app-name=PowerJobDemo
# 调度服务器地址，IP:Port 或 域名，多值逗号分隔
powerjob.worker.server-address=127.0.0.1:7700
# 通讯协议，4.3.0 开始支持 HTTP 和 AKKA 两种协议，官方推荐使用 HTTP 协议（注意 server 和 worker 都要开放相应端口）
powerjob.worker.protocol=http
# 持久化方式，可选，默认 disk
powerjob.worker.store-strategy=disk
# 任务返回结果信息的最大长度，超过这个长度的信息会被截断，默认值 8192
powerjob.worker.max-result-length=4096
# 单个任务追加的工作流上下文最大长度，超过这个长度的会被直接丢弃，默认值 8192
powerjob.worker.max-appended-wf-context-length=4096
# 同时运行的轻量级任务数量上限
powerjob.worker.max-lightweight-task-num=1024
# 同时运行的重量级任务数量上限
powerjob.worker.max-heavy-task-num=64

开发定时任务

• 可以实现BasicProcessor接口，并使用@Component加入Spring的Bean容器
• 可以使用@PowerJobHandler(name = "xxx1")方法级注解

import org.springframework.stereotype.Component;
import tech.powerjob.worker.annotation.PowerJobHandler;
import tech.powerjob.worker.core.processor.ProcessResult;
import tech.powerjob.worker.core.processor.TaskContext;
import tech.powerjob.worker.core.processor.sdk.BasicProcessor;
import tech.powerjob.worker.log.OmsLogger;

/**
 * 单机处理器：BasicProcessor
 *
 * 单机执行的策略下，server 会在所有可用 worker 中选取健康度最佳的机器进行执行。单机执行任务需要实现接口 BasicProcessor，代码示例如下：
 *
 * @author tangheng
 */
// 支持 SpringBean 的形式
@Component("basicProcessorDemo")
public class BasicProcessorDemo implements BasicProcessor {

    @Override
    public ProcessResult process(TaskContext context) throws Exception {
        System.out.println("BasicProcessorDemo");
        // 在线日志功能，可以直接在控制台查看任务日志，非常便捷
        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.info("BasicProcessorDemo start to process, current JobParams is {}.", context.getJobParams());

        // TaskContext为任务的上下文信息，包含了在控制台录入的任务元数据，常用字段为
        // jobParams（任务参数，在控制台录入），instanceParams（任务实例参数，通过 OpenAPI 触发的任务实例才可能存在该参数）

        // 返回结果，该结果会被持久化到数据库，在前端页面直接查看，极为方便
        return new ProcessResult(true, "result is xxx");
    }

    @PowerJobHandler(name = "xxx1")
    public void xx1(TaskContext context) throws Exception {
        System.out.println("xxx1");
        // 在线日志功能，可以直接在控制台查看任务日志，非常便捷
        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.info("xx1");
    }

    @PowerJobHandler(name = "xxx2")
    public void xx2(TaskContext context) throws Exception {
        System.out.println("xxx2");
        // 在线日志功能，可以直接在控制台查看任务日志，非常便捷
        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.info("xx2");
    }
}

调度中心配置

• 浏览器访问: http://127.0.0.1:7700/
  

• 点击PowerJob Account
  

• 点击注册
  

• 填写账号信息，并点注册，回到登录界面

• 输入注册的账号密码，并点登录
  

• 登录进去后，可以管理命令空间，默认的命名空间也可以删除，然后再新建自己的命名空间
  

• 进入应用管理，新建应用
  

• 进入应用，点击任务管理，新建任务
  

• 在任务实例菜单下，可以看到任务运行的情况