Java 分布式任务调度平台：PowerJob 快速开始+agent使用教程

引言

PowerJob 的设计目标为企业级的分布式任务调度平台，即成为公司内部的调度中间件。整个公司统一部署调度中心 powerjob-server，旗下所有业务线应用只需要依赖 ‘powerjob-worker’ 即可接入获取任务调度与分布式计算能力。
因此，PowerJob 由调度服务器（powerjob-server）和执行器（powerjob-worker）两部分组成，powerjob-server 负责提供 Web 服务和完成任务的调度，powerjob-worker 则负责执行用户所编写的任务代码，同时提供分布式计算能力。
以下为在本地开发环境快速搭建并试用 PowerJob 的教程。

步骤一：初始化项目

1. 下载源码到本地

git clone https://gitee.com/KFCFans/PowerJob.git

2. 导入 IDE，源码结构如下，我们需要启动调度服务器（powerjob-server），同时在 samples 工程中编写自己的处理器代码
   

3. 创建数据库（仅需要创建数据库）：找到你的 DB，运行 SQL CREATE DATABASE IF NOT EXISTS powerjob-daily DEFAULT CHARSET utf8mb4，搞定～

4. 修改配置文件，配置文件的说明官方文档写的非常详细，此处不再赘述。
   需要修改的地方(路径: PowerJob/powerjob-server/powerjob-server-starter/src/main/resources/application-daily.properties)为数据库配置spring.datasource.core.jdbc-url、spring.datasource.core.username和spring.datasource.core.password，当然，有 mongoDB 的同学也可以修改spring.data.mongodb.uri以获取完全版体验。

5. 修改配置文件 application-daily.properties

oms.env=DAILY
logging.config=classpath:logback-dev.xml

####### 外部数据库配置（需要用户更改为自己的数据库配置） #######
spring.datasource.core.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.core.jdbc-url=jdbc:mysql://127.0.0.1:3306/powerjob-daily?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.core.username=root
spring.datasource.core.password=zhangqing0718!@#
spring.datasource.core.maximum-pool-size=20
spring.datasource.core.minimum-idle=5

####### mongoDB配置，非核心依赖，通过配置 oms.mongodb.enable=false 来关闭  #######
#oms.mongodb.enable=true
#spring.data.mongodb.uri=mongodb+srv://zqq:No1Bug2Please3!@cluster0.wie54.gcp.mongodb.net/powerjob_daily?retryWrites=true&w=majority

####### 邮件配置（不需要邮件报警可以删除以下配置来避免报错） #######
#spring.mail.host=smtp.163.com
#spring.mail.username=zqq@163.com
#spring.mail.password=GOFZPNARMVKCGONV
#spring.mail.properties.mail.smtp.auth=true
#spring.mail.properties.mail.smtp.starttls.enable=true
#spring.mail.properties.mail.smtp.starttls.required=true

####### 钉钉属性(非核心配置属性) #######
#oms.alarm.ding.app-key=dingauqwkvxxnqskknfv
#oms.alarm.ding.app-secret=XWrEPdAZMPgJeFtHuL0LH73LRj-74umF2_0BFcoXMfvnX0pCQvt0rpb1JOJU_HLl
#oms.alarm.ding.agent-id=847044348

####### 资源清理配置 #######
oms.instanceinfo.retention=1
oms.container.retention.local=1
oms.container.retention.remote=-1

####### 缓存配置 #######
oms.instance.metadata.cache.size=1024

####### Threshold in precise fetching server(0~100). 100 means full detection of server, in which #######
####### split-brain could be avoided while performance overhead would increase. #######
oms.accurate.select.server.percentage = 50

6. 完成配置文件的修改后，可以直接通过启动类 tech.powerjob.server.PowerJobServerApplication 启动调度服务器（注意：需要使用 daily 配置文件启动，可自行百度搜索“SpringBoot 指定配置文件启动”），观察启动日志，查看是否启动成功～启动成功后，访问 http://127.0.0.1:7700/ ，如果能顺利出现 Web 界面，则说明调度服务器启动成功！
7. 注册应用：点击主页应用注册按钮，填入 power-job-test 和控制台密码（用于进入控制台），注册示例应用（当然你也可以注册其他的 appName，只是别忘记在示例程序中同步修改～）
   

步骤二：编写测试用例

进入示例工程（powerjob-worker-samples），修改配置文件连接powerjob-server并编写自己的处理器代码。

server.port=8081
spring.jpa.open-in-view=false
########### PowerJob-worker properties. ###########
# Whether to enable PowerJob Worker, default is true
powerjob.worker.enabled=true
# Transport port, default is 27777
powerjob.worker.port=27777
# Application name, used for grouping applications. Recommend to set the same value as project name.
powerjob.worker.app-name=power-job-test
# Address of PowerJob-server node(s). Ip:port or domain. Multiple addresses should be separated with comma.
powerjob.worker.server-address=127.0.0.1:7700
# transport protocol between server and worker
powerjob.worker.protocol=akka
# Store strategy of H2 database. disk or memory. Default value is disk.
powerjob.worker.store-strategy=disk
# Max length of result. Results that are longer than the value will be truncated.
powerjob.worker.max-result-length=4096
# Max length of appended workflow context . Appended workflow context value that is longer than the value will be ignore.
powerjob.worker.max-appended-wf-context-length=4096

1. 编写自己的处理器：随便找个地方新建类，继承你想要使用的处理器（各个处理器的介绍可见官方文档，文档非常详细），这里为了简单演示，选择使用单机处理器 BasicProcessor，以下是代码示例。

@Slf4j
@Component
public class MyStandaloneProcessorDemo implements BasicProcessor {

    @Override
    public ProcessResult process(TaskContext context) throws Exception {

        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.info("处理器启动成功，context 是 {}.", context);

        log.info("单机处理器正在处理");
        log.info(context.getJobParams());

        omsLogger.info("处理器执行结束");

        boolean success = true;

        return new ProcessResult(success, context + ": " + success);
    }
}

3. 启动示例程序，即直接运行主类 tech.powerjob.samples.SampleApplication，观察控制台输出信息，判断是否启动成功。

步骤三：任务的配置与运行

调度服务器与示例工程都启动完毕后，再次前往Web页面（ http://127.0.0.1:7700/ ），进行任务的配置与运行。

1. 在首页输入框输入配置的应用名称，成功操作后会正式进入前端管理界面。
   
2. 点击任务管理 -> 新建任务（右上角），开始创建任务。
   
   ps: 定时信息选择CRON，如果时间小于15秒会发现执行频率还是15秒跑一次，如果业务需要可选择固定频率(毫秒)

● 任务名称：名称
● 任务描述：描述
● 任务参数：任务处理时能够获取到的参数（即各个 Processor 的 process 方法入参 TaskContext 对象的jobParams 属性）（进行一次处理器开发就能理解了）
● 定时信息：该任务的触发方式，由下拉框和输入框组成
○ API -> 不需要填写任何参数，表明该任务由 OpenAPI 触发，不会被调度器主动调度执行
○ CRON -> 填写 CRON 表达式（在线生成网站）
○ 固定频率 -> 任务以固定的频率执行，填写整数，单位毫秒
○ 固定延迟 -> 任务以固定的延迟执行，填写整数，单位毫秒
○ 工作流 -> 不需要填写任何参数，表明该任务由工作流（workflow）触发
● 执行配置：由执行类型（单机、广播和 MapReduce ）、处理器类型和处理器参数组成，后两项相互关联。
○ 内置Java处理器 -> 填写该处理器的全限定类名（eg, tech.powerjob.samples.processors.MapReduceProcessorDemo）
○ Java容器 -> 填写容器ID#处理器全限定类名（eg，1#cn.edu.zju.oms.container.ContainerMRProcessor）
○ SHELL、Python、SQL 、HTTP 等任务的执行：点击查看官方处理器的使用教程
● 运行配置
○ 最大实例数：该任务同时执行的数量，0 代表不限制实例数量
○ 单机线程并发数：该实例执行过程中每个 Worker 使用的线程数量（MapReduce 任务生效，其余无论填什么，都只会使用必要的线程数）
○ 运行时间限制：限定任务的最大运行时间，超时则视为失败，单位毫秒，0 代表不限制超时时间（不建议不限制超时时间）。
● 重试配置：
○ Instance 重试次数：实例级别，失败了整个任务实例重试，会更换 TaskTracker（本次任务实例的Master节点），代价较大，大型Map/MapReduce慎用。
○ Task 重试次数：Task 级别，每个子 Task 失败后单独重试，会更换 ProcessorTracker（本次任务实际执行的 Worker 节点），代价较小，推荐使用。
○ 注：请注意同时配置任务重试次数和子任务重试次数之后的重试放大，比如对于单机任务来说，假如任务重试次数和子任务重试次数都配置了 1 且都执行失败，实际执行次数会变成 4 次！推荐任务实例重试配置为 0，子任务重试次数根据实际情况配置。
● 机器配置：用来标明允许执行任务的机器状态，避开那些摇摇欲坠的机器，0 代表无任何限制。
○ 最低 CPU 核心数：填写浮点数，CPU 可用核心数小于该值的 Worker 将不会执行该任务。
○ 最低内存（GB）：填写浮点数，可用内存小于该值的 Worker 将不会执行该任务。
○ 最低磁盘（GB）：填写浮点数，可用磁盘空间小于该值的 Worker 将不会执行该任务。
● 集群配置
○ 执行机器地址：指定集群中的某几台机器执行任务（ debug 的好帮手），多值英文逗号分割，如192.168.1.1:27777,192.168.1.2:27777
○ 最大执行机器数量：限定调动执行的机器数量
● 报警配置：选择任务执行失败后报警通知的对象，需要事先录入。

3. 完成任务创建后，即可在控制台看到刚才创建的任务，如果觉得等待调度太过于漫长，可以直接点击运行按钮，立即运行本任务。
   
   基础的教程到这里也就结束了～

agent使用教程(容器)

1. 点击容器 -> 模版生成，创建一个容器。
   
2. 解压生成的zip包，用IDE打开,并创建一个Java类实现BasicProcessor(根据业务需求选择，这里为了简便用的单机处理器)
   
3. 使用maven将项目打包

mvn clean package -Dmaven.test.skip=true

4. 进入PowerJob服务端控制台，点击容器 -> 容器运维-> 新增容器。

5. 回到任务管理-> 新建任务

至此agent简单使用完成了～