【PowerJob语雀转载】快速开始（本地IDE版）本教程适用于熟悉项目或搭建本地试用/测试环境，正式部署请阅读正式部署

本教程适用于熟悉项目或搭建本地试用/测试环境，正式部署请阅读正式部署章节。 PowerJob 的设计目标为企业级的分布式任务调度平台，即成为公司内部的调度中间件。整个公司统一部署调度中心 powerjob-server，旗下所有业务线应用只需要依赖 powerjob-worker 即可接入获取任务调度与分布式计算能力，通过不同的 appName 相互隔离。

因此，PowerJob 由调度服务器（powerjob-server）和执行器(powerjob-worker)两部分组成，powerjob-server 负责提供 Web 服务和完成任务的调度，powerjob-worker 则负责执行用户所编写的任务代码，同时提供分布式计算能力。

以下为在本地开发环境快速搭建并试用 PowerJob 的教程。

STEP1: 初始化项目

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

STEP2: 启动调度服务器

创建数据库（仅需要创建数据库）：找到你的 DB，运行 SQL CREATE DATABASE IF NOT EXISTS `powerjob-daily` DEFAULT CHARSET utf8mb4，搞定～
修改配置文件，配置文件的说明官方文档写的非常详细，此处不再赘述。

需要修改的地方(路径: 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以获取完全版体验。

powerjob-server 日常环境配置文件：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://localhost:3306/powerjob-daily?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.core.username=root
spring.datasource.core.password=No1Bug2Please3!
spring.datasource.core.hikari.maximum-pool-size=20
spring.datasource.core.hikari.minimum-idle=5

####### mongoDB配置，非核心依赖，通过配置 oms.mongodb.enable=false 来关闭 #######
oms.mongodb.enable=true
spring.data.mongodb.uri=mongodb://localhost:27017/powerjob-daily

####### 邮件配置（不需要邮件报警可以删除以下配置来避免报错） #######
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.instanceinfo.retention=1
oms.container.retention.local=1
oms.container.retention.remote=-1

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

####### 用户与权限体系配置 #######
oms.auth.initiliaze.admin.password=powerjob_admin

tips：如果你暂时没有可用的数据库进行测试，那么可以使用以下数据库配置来一键启动 server（仅限测试环境使用！）：

spring.datasource.core.driver-class-name=org.h2.Driver
spring.datasource.core.jdbc-url=jdbc:h2:file:~/h2/powerjob-daily-test
spring.datasource.core.username=sa
spring.datasource.core.password=

3. 完成配置文件的修改后，可以直接通过启动类 tech.powerjob.server.PowerJobServerApplication 启动调度服务器（注意：需要使用 daily 配置文件启动，可自行百度搜索“SpringBoot 指定配置文件启动” ），观察启动日志，查看是否启动成功～启动成功后，访问 http://127.0.0.1:7700/ ，如果能顺利出现 Web 界面，则说明调度服务器启动成功！ 4. 注册应用

- v4.x及前序版本：点击主页应用注册按钮，填入 powerjob-worker-samples 和控制台密码（用于进入控制台），注册示例应用（当然你也可以注册其他的 appName，只是别忘记在示例程序中同步修改～）

- v5.x 版本：

- - 选择 PowerJob Account进行登录，简单起见可直接使用超级管理员登录（账号 ADMIN，密码 powerjob_admin）

登录后，进入应用管理TAB，点击右上角新增进行应用注册即可。

STEP3: 编写示例代码

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

修改 powerjob-worker-samples 的 application.properties，将 powerjob.worker.app-name 改为刚刚在控制台注册的名称。

server.port=8081

spring.jpa.open-in-view=false

########### powerjob-worker 配置 ###########
# akka 工作端口，可选，默认 27777
powerjob.worker.akka-port=27777
# 接入应用名称，用于分组隔离，推荐填写 本 Java 项目名称
powerjob.worker.app-name=powerjob-worker-samples
# 调度服务器地址，IP:Port 或 域名，多值逗号分隔
powerjob.worker.server-address=127.0.0.1:7700,127.0.0.1:7701
# 持久化方式，可选，默认 disk
powerjob.worker.store-strategy=disk
# 任务返回结果信息的最大长度，超过这个长度的信息会被截断，默认 8192
powerjob.worker.max-result-length=4096
# 单个任务追加的工作流上下文最大长度，超过这个长度的会被直接丢弃，默认 8192
powerjob.worker.max-appended-wf-context-length=4096

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

@Slf4j
@Component
public class StandaloneProcessorDemo implements BasicProcessor {

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

        // PowerJob 在线日志功能，使用该 Logger 打印的日志可以直接在 PowerJob 控制台查看
        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.info("StandaloneProcessorDemo start process,context is {}.", context);
        
        return new ProcessResult(true, "process successfully~");
    }
}

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

STEP4: 任务的配置与运行

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

进入执行器应用的主界面

v4.x 及前序版本：在首页输入框输入配置的应用名称，成功操作后会正式进入前端管理界面

v5.x：在应用管理页面，选择对应的应用，点击右侧“进入”按钮即可。

进入注册应用首页后，出现如下图页面

新建任务

点击“任务管理” -> “新建任务”（右上角），开始创建任务。

可按下图说明填写参数

任务名称：名称
任务描述：描述
任务参数：任务处理时能够获取到的参数（即各个 Processor 的 process 方法入参 TaskContext 对象的jobParams 属性）（进行一次处理器开发就能理解了）
定时信息：该任务的触发方式，由下拉框和输入框组成

- API -> 不需要填写任何参数，表明该任务由 OpenAPI 触发，不会被调度器主动调度执行
- CRON -> 填写 CRON 表达式（在线生成网站）
- 固定频率 -> 任务以固定的频率执行，填写整数，单位毫秒
- 固定延迟 -> 任务以固定的延迟执行，填写整数，单位毫秒
- 每日固定间隔 -> 哪几天的哪些时间段需要执行，比如每周二和三的10点到11点间每10分钟触发一次
- 工作流 -> 不需要填写任何参数，表明该任务由工作流（workflow）触发

生命周期：任务的有效时间范围，不在生命周期的任务会自动停止。常用于任务的延迟启动和过期自动关停。

执行配置：由执行类型（单机、广播和 MapReduce ）、处理器类型和处理器参数组成，后两项相互关联。

- 内置Java处理器

- - 方式一 -> 填写该处理器的全限定类名（eg, tech.powerjob.samples.processors.MapReduceProcessorDemo）
  - 方式二 -> 填写 IOC 容器的 bean 名称，比如 Spring 用户可填写 Spring Bean 名称（eg, 处理器使用注解 @Component(value = "powerJobProcessor")，则控制台可填写 powerJobProcessor）
  - 方式三 -> 方法级注解，非 MapReduce 任务可直接使用注解 @PowerJobHandler 将某个方法转化为 PowerJob 任务，并设置唯一入参 TaskContext注入上下文，具体参考代码

@Component(value = "springMethodProcessorService")
public class SpringMethodProcessorService {

    /**
     * 处理器配置方法1： 全限定类名#方法名，比如 tech.powerjob.samples.tester.SpringMethodProcessorService#testEmptyReturn
     * 处理器配置方法2： SpringBean名称#方法名，比如 springMethodProcessorService#testEmptyReturn
     * @param context 必须要有入参 TaskContext，返回值可以是 null，也可以是其他任意类型。正常返回代表成功，抛出异常代表执行失败
     */
    @PowerJobHandler(name = "testEmptyReturn")
    public String testEmptyReturn(TaskContext context) {
        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.warn("测试日志");
        return "响应结果，正常返回视为执行成功，抛出异常视为执行失败"
    }
}

- 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 将不会执行该任务。

集群配置

- 执行机器地址，指定集群中的某几台机器执行任务

- - IP模式：多值英文逗号分割，如192.168.1.1:27777,192.168.1.2:27777。常用于 debug 等场景，需要指定特定机器运行。
  - TAG 模式：通过 PowerJobWorkerConfig#tag将执行器打标分组后，可在控制台通过 tag 指定某一批机器执行。常用于分环境分单元执行的场景。如某些任务需要屏蔽安全生产环境（tag 设置为环境标），某些任务只需要在特定单元执行（tag 设置单元标）

- 最大执行机器数量：限定调动执行的机器数量

报警配置：选择任务执行失败后报警通知的对象，需要事先录入。
日志配置：可使用控制台配置调整 Job 使用的 Logger 及 LogLevel

- 支持 SERVER（服务端日志，默认）、LOCAL（本地日志）、STDOUT（系统输出）、NULL（空实现）4种 LogType
- 支持 DEBUG、INFO、WARN、ERROR、OFF 5种级别控制
- 使用建议：初期调试可使用 SERVER 日志，后续功能稳定后改为 LOCAL，并调高日志级别，降低通讯压力，消除性能瓶颈问题

任务运行&运维

完成任务创建后，即可在控制台看到刚才创建的任务，如果觉得等待调度太过于漫长，可以直接点击运行按钮，立即运行本任务。

前往任务实例边栏，查看任务的运行状态和在线日志

基础的教程到这里也就结束了～

更多功能示例可见官方文档，工作流、MapReduce、容器等高级特性等你来探索！

Others

PowerJob 部署视频教程（server + agent + 容器）：点击查看