编译

不同的编译方式和环境可能会获得不同的编译结果，甚至会编译失败！scaleph 拥有多个编译场景：

本地 IDE 开发。
基于 github actions 的 CI 流程。
基于 github actions 的 CD 流程。

scaleph 确保 3 个场景的编译环境、命令和结果的一致性，保证了开发者本地开发效果，CI/CD 流程都是可信的。

当开发者需要手动编译项目时，可以参考此文档。

编译

机器本地编译

开发者需安装如下环境：

JDK。下载并安装 open JDK 11。
Node。下载并安装 Node 16。
Docker。下载并安装 Docker，已有 Docker 环境时，使用 docker version 和 docker compose version 检查对应的版本，更新为最新版本。

# 编译服务端。编译完成后，可以在 scaleph-api/target/scaleph-api.jar
./mvnw -B -U -T 4 clean package -DskipTests -Dfast -am --projects scaleph-api

# 启动服务端
# 参考 https://github.com/flowerfine/scaleph/blob/dev/tools/docker/build/scaleph-api/Dockerfile

# 编译前端
# 安装依赖。如果网络不好，可以配置国内 npm 包镜像源
npm install --force
# 执行编译。编译完成后，可以在 scaleph-ui-react/dist 目录获取编译结果
npm run build --prod
# 启动前端
# 参考 https://github.com/flowerfine/scaleph/blob/dev/tools/docker/build/scaleph-ui-react/Dockerfile
# nginx 配置参数 https://github.com/flowerfine/scaleph/blob/dev/tools/docker/build/scaleph-ui-react/nginx.conf.template

容器内编译

scaleph 服务端和前端的编译需要安装 JDK 和 Node，通过容器内编译，可以统一编译环境，无需用户准备对应版本的 JDK 和 Node。

开发者需安装如下环境：

Docker。下载并安装 Docker，已有 Docker 环境时，使用 docker version 和 docker compose version 检查对应的版本，更新为最新版本。

# 编译服务端
docker run -it --rm \
--name scaleph-api-build \
-v "$(pwd)":/usr/src/mymaven \
-w /usr/src/mymaven \
maven:3.8-eclipse-temurin-11 \
mvn -B -U -T 4 clean package -DskipTests -Dfast -am --projects scaleph-api

# 启动服务端
# 参考 https://github.com/flowerfine/scaleph/blob/dev/tools/docker/build/scaleph-api/Dockerfile

# 编译前端
# 安装依赖
docker run -it --rm \
--name scaleph-ui-react-build \
-v "$(pwd)/scaleph-ui-react":/usr/src/mymaven \
-w /usr/src/mymaven/ \
node:16 \
npm install --force
# 编译
docker run -it --rm \
--name scaleph-ui-react-build \
-v "$(pwd)/scaleph-ui-react":/usr/src/mymaven \
-w /usr/src/mymaven/ \
node:16 \
npm run build --prod
# 启动前端
# 参考 https://github.com/flowerfine/scaleph/blob/dev/tools/docker/build/scaleph-ui-react/Dockerfile
# nginx 配置参数 https://github.com/flowerfine/scaleph/blob/dev/tools/docker/build/scaleph-ui-react/nginx.conf.template

镜像制作

scaleph 基于 Docker 提供快速的开发和测试运行环境，本文将介绍如何在本地构建镜像。

在 $SCALEPH_HOME/tools/docker/build 目录下有 docker-compose-build-api.yml 和 docker-compose-build-ui.yml文件，分别用于构建 scaleph-api 和 scaleph-ui-react 模块。docker compose 中添加了程序运行依赖的 mysql、redis 、minio 等环境。

# clone 源码
git clone https://github.com/flowerfine/scaleph.git
cd scaleph/tools/docker/build/scaleph

# 编译 scaleph-api 镜像
docker compose -f docker-compose-build-api.yml build
# 测试 scaleph-api 镜像编译结果
docker compose -f docker-compose-build-api.yml up -d

# 编译 scaleph-ui-react 镜像
docker compose -f docker-compose-build-ui.yml build
# 测试 scaleph-ui-react 镜像编译结果
docker compose -f docker-compose-build-ui.yml up -d

安装包编译

请先参照前文安装本地编译环境。

# clone 源码
git clone https://github.com/flowerfine/scaleph.git
cd scaleph

# 开始编译
mvn -U -B -T 4 clean package -Pdist -DskipTests -Dfast

编译完成后在scaleph-dist/target下生成后缀为.tar.gz的安装包。