DataEaseV2开发指南

1、环境搭建（Windows环境）

1. Java 安装

• 环境要求：Java 17。
• 下载地址：https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe。
• 点击安装，并且设置要环境变量（网上很多，不过多赘述），并检查Java是否正确安装（打开电脑CMD，输入 java -version，查看是否能够正常输出）。

2. Maven 安装

• 下载地址：https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.zip。
• 解压到某个目录中，注意主要不要有中文，空格。
• 添加环境变量，打开电脑CMD，输入 mvn -version，检查maven版本是否一致，检查输出Java版本和安装路径是否和上面Java版本和安装路径一致。

3. Git 安装

• 下载地址：https://github.com/git-for-windows/git/releases/download/v2.43.0.windows.1/Git-2.43.0-64-bit.exe。
• 点击安装，安装完成后，打开电脑CMD，输入 git --version，检查版本是否一致。
• 如果想要创建私有代码管理平台的话，建议可以看下 Gitea。私有化的 Github，值得拥有。

4. Node.js 安装

• 下载地址：https://nodejs.org/dist/v20.11.0/node-v20.11.0-x64.msi
• 点击安装，安装完成后，打开电脑CMD，输入 node -v,查看版本是否一致，输入 npm -v，检查是否输出正常。
• 注意：建议替换下镜像源，npm config set registry=https://registry.npmmirror.com --global
  最后检查下镜像源是否替换成功，npm config get registry 。

5. Idea 安装

• 下载地址：https://www.jetbrains.com.cn/idea/
  点击安装，其他自行处理。

6、Mysql 安装

• 此处，我用的公有云的服务器，通过 1Panel 安装的 Mysql，简单又方便，还可以快速搭建很多应用和管理容器。

2、获取 DataEase V2 代码

• 访问仓库地址：https://github.com/dataease/dataease/，获取到git地址。
• 在电脑上执行，git clone https://github.com/dataease/dataease.git
  等待代码复制完成。别忘记给项目点个 Star。
• 如果觉得git clone 太慢，建议直接下载 ZIP 包，代码会打包一起下载下来。解压代码到本地目录中去，如果需要使用git管理的话，需要执行，git 初始化等操作。（此下载，只会下载当前分支的代码，注意别选错分支，选已经release的分支，如果是dev的分支的话，可能会存在项目启动和依赖问题）。

3、打包安装项目前置依赖

• 通过 Idea 打开项目文件，设置好 Idea 的 Maven 目录和本地依赖仓库路径，设置到项目JDK的版本和每个模块的JDK版本。在代码文件存放的根路径，创建好 D:\opt\dataease2.0 文件夹（比如我是存放在D盘下面的）。
• 切换到 core/core-frontend/ 下，CMD 命令执行 npm install ,等待安装完成。
• 切换到 sdk/ 目录下，执行 maven clear install，等待依赖下载和将 sdk 项目下的内容安装到本地仓库。

4、运行项目

• 修改 core/core-backend/src/main/resources/application-standalone.yml 中 Mysql 的信息，需要提前创建好 dataease 的数据库。命令如下：CREATE DATABASE dataease DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;。
• 运行前端项目，切换到 core/core-frontend/ ，CMD 命令执行 npm run dev，等待项目启动，启动完成会显示访问地址。
• 后端项目运行，在 Idea 中使用运行器运行或者使用 maven 的 Spring boot 插件运行（首次运行，如果数据库中没有数据的话，会执行建表语句）。
• 最后访问前端项目地址。

5、自定义开发

• 重点是在core-frontend（前端文件），core-backend（后端文件）里面，代码内容自行分析。

6、打包成 Jar 包

• 首次打包需要打开 core/core-frontend/pom.xml 中的注释位置（id节点为:install node and npm）,或则手动安装，npm install -g win-node-env。
• 在 core 目录下面，执行mvn clean package -Pstandalone。
• 最后在 core/core-backend/target/ 下载找到 CoreApplication.jar。

7、Jar 包更新法&持久化生成镜像

• 使用 1Panel 安装同代码版本的DataEase或则在官网通过在线或离线安装方式安装好DataEase的环境。
• 将打包好的 CoreApplication.jar 上传到DataEase安装服务器上。
• 通过 docker cp CoreApplication.jar dataease:/opt/apps/app.jar 。
• 执行 docker restart dataease。
• 验证开发内容。
• 查看运行镜像id（docker ps），通过 docker commit [容器ID] [镜像地址] ，生成新的镜像。
• 通过 docker save -o [tar包名称] [镜像地址]，将 Docker 镜像保存为 tar 包，可以复制上传到其他地方，或者通过 docker push [镜像地址] 上传到镜像仓库中。
• 通过 docker load -i [tar包名称],将镜像解压加载到本地docker中。

8、生成 Docker 镜像

• 在项目根目录下，有 DockerFile 文件，可以通过 docker build 命令执行镜像打包。

---

最后最后，推荐几个比较好用的开源软件。别忘记在项目上点个 Star
JumpServer 广受欢迎的开源堡垒机，国产开源堡垒机，运维审计必备。
MeterSphere 一站式开源持续测试平台，包括了用例管理、接口测试、接口自动化、UI测试、性能测试等。
DataEase 人人可用的开源数据可视化分析平台，能够对接多种数据源，通过拖拉拽的方式快速创建出自己想要的大屏，最最最重要的是，还有很多免费的大屏模版可以用。
1Panel 开源 Linux 面板，可以快速创建多种常见的应用还能管理数据、容器等。
Halo 开源建站工具，程序博客快速搭建，还有多种免费主题可供选择
Gitea 新一代的代码托管平台，具备基于 Git 的核心代码托管能力和 DevSecOps 延伸能力，并且支持用户开展私有化部署。