DolphinScheduler 开发手册

此教程注册中心使用的是mysql 作为注册中心

1、软件要求

在搭建 DolphinScheduler 开发环境之前请确保你已经安装以下软件:

• Git
• JDK: v1.8.x (当前暂不支持 jdk 11)
• Maven: v3.5+
• Node: v16.13+ (dolphinScheduler 版本低于 3.0, 请安装 node v12.20+)
• Pnpm: v6.x

环境示例

D:\>git --version
git version 2.39.0.windows.1D:\>java -version
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF-8
java version "1.8.0_131"
Java(TM) SE Runtime Environment (build 1.8.0_131-b11)
Java HotSpot(TM) 64-Bit Server VM (build 25.131-b11, mixed mode)D:\>mvn --version
D:\
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF-8
Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: D:\devtool\apache-maven-3.6.3\bin\..
Java version: 1.8.0_131, vendor: Oracle Corporation, runtime: D:\devtool\java\jre
Default locale: zh_CN, platform encoding: UTF-8
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"
Active code page: 65001D:\>node --version
v18.12.1D:\>pnpm --version
7.18.2D:\>

2、克隆代码库

通过你 git 管理工具下载 git 代码

mkdir dolphinscheduler
cd dolphinscheduler
git clone git@github.com:apache/dolphinscheduler.git -b 3.1.8

3、编译打包

支持的系统:

• MacOS
• Linux

运行 mvn clean install -Prelease -Dmaven.test.skip=true

4、代码风格

DolphinScheduler使用Spotless检查并修复代码风格和格式问题。
您可以执行如下的命令，Spotless将会为您自动检查并修复代码风格和格式问题。

./mvnw spotless:apply

您可将/style/pre-commit目录下的pre-commit hook文件拷贝到您的.git/hooks/
目录下，这样您每次使用git commit命令时，Spotless将会自动为您修复代码风格和格式问题。

5、新建数据库，导入元数据。

-- 创建元数据库
create database dolphinscheduler;
-- 导入元数据相关表格
source  dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_mysql.sql
-- 导入注册中心相关表格
source  dolphinscheduler-registry/dolphinscheduler-registry-plugins/dolphinscheduler-registry-mysql/src/main/resources/mysql_registry_init.sql

6， 启动后端

后端进程一共4个进程，分别是：
api-server
master-server
worker-server
alert-server
本地源码调试一般启动api、master、worker 即可。

6.1 启动api-server

复制dolphinscheduler-api 模块的resources下的application.yaml， 命名成 application-local-dev.yaml
修改里面的注册中心和数据源配置，示例如下：

--- datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://127.0.0.1:3306/dolphinscheduler?serverTimezone=Asia/Shanghaiusername: rootpassword: root
--- 
registry:type: mysqlterm-refresh-interval: 2sterm-expire-times: 3hikari-config:driver-class-name: com.mysql.cj.jdbc.Driverjdbc-url: jdbc:mysql://127.0.0.1:3306/dolphinscheduler?serverTimezone=Asia/Shanghaiusername: rootpassword: rootmaximum-pool-size: 5connection-timeout: 9000idle-timeout: 600000

修改完成后，在idea 的启动配置里， 设置jvm 参数，加入如下参数：

-Dspring.profiles.active=local-dev

最后启动ApiApplicationServer

6.2 启动master-server

参考启动api-server，配置好后即可启动。
对应的模块是： dolphinscheduler-master.

6.3 启动worker-server

参考启动api-server，配置好后即可启动。
对应的模块是： dolphinscheduler-worker.

7 启动前端

cd dolphinscheduler-ui
pnpm install
pnpm run dev
启动示例：

C:\linux\project\3.1.8\dolphinscheduler-ui>pnpm install
Lockfile is up to date, resolution step is skipped
Already up to date
Done in 849msC:\linux\project\3.1.8\dolphinscheduler-ui>pnpm run dev > dolphinscheduler-ui@0.0.0 dev C:\linux\project\3.1.8\dolphinscheduler-ui
> viteVITE v3.1.2  ready in 1127 ms➜  Local:   http://localhost:3005/➜  Network: use --host to expose

最后访问地址http://localhost:3005/dolphinscheduler/ui， 使用默认账户密码 admin/dolphinscheduler123 即可完成登录