ChunJun 开源项目使用教程
1. 项目的目录结构及介绍
ChunJun 项目的目录结构如下:
chunjun/
├── bin/
├── build/
├── chunjun-assembly/
├── chunjun-clients/
├── chunjun-connectors/
├── chunjun-core/
├── chunjun-ddl/
├── chunjun-dev/
├── chunjun-dirty/
├── chunjun-docker/
├── chunjun-e2e/
├── chunjun-examples/
├── chunjun-local-test/
├── chunjun-metrics/
├── chunjun-restore/
├── chunjun-server/
├── conf/
├── docs/
├── website/
├── editorconfig
├── gitignore
├── gitmodules
├── licenserc.yaml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── README_CH.md
├── mvnw
├── mvnw.cmd
└── pom.xml
目录介绍
bin/
: 包含启动脚本。build/
: 构建相关文件。chunjun-assembly/
: 项目打包相关。chunjun-clients/
: 客户端相关代码。chunjun-connectors/
: 连接器插件。chunjun-core/
: 核心代码。chunjun-ddl/
: DDL 相关代码。chunjun-dev/
: 开发相关工具和配置。chunjun-dirty/
: 脏数据处理相关。chunjun-docker/
: Docker 相关配置。chunjun-e2e/
: 端到端测试相关。chunjun-examples/
: 示例代码。chunjun-local-test/
: 本地测试相关。chunjun-metrics/
: 监控指标相关。chunjun-restore/
: 数据恢复相关。chunjun-server/
: 服务端相关代码。conf/
: 配置文件。docs/
: 文档。website/
: 项目网站相关。editorconfig
: 编辑器配置。gitignore
: Git 忽略文件配置。gitmodules
: Git 子模块配置。licenserc.yaml
: 许可证配置。CONTRIBUTING.md
: 贡献指南。LICENSE
: 许可证文件。README.md
: 项目介绍。README_CH.md
: 中文项目介绍。mvnw
: Maven 包装器脚本。mvnw.cmd
: Maven 包装器脚本(Windows)。pom.xml
: Maven 项目配置文件。
2. 项目的启动文件介绍
启动文件
bin/chunjun-local.sh
: 本地模式启动脚本。mvnw
: Maven 包装器脚本,用于启动 Maven 构建。mvnw.cmd
: Maven 包装器脚本(Windows)。
启动命令
在本地模式下启动 ChunJun 任务的命令如下:
sh bin/chunjun-local.sh -job $SCRIPT_PATH
其中,$SCRIPT_PATH
是任务脚本的路径。
3. 项目的配置文件介绍
配置文件
conf/
: 包含项目的配置文件。pom.xml
: Maven 项目配置文件,包含项目依赖、插件等配置。editorconfig
: 编辑器配置文件,用于统一代码风格。licenserc.yaml
: 许可证配置文件。
配置文件示例
pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.dtstack</groupId>
<artifactId>chunjun</artifactId>
<