手机网站生成网站建设首页

SR简介

StarRocks 是一款高性能分析型数据库，支持实时、多维度、高并发的数据分析。本指南旨在解决在使用 VSCode 或 Cursor 开发 StarRocks 后端项目时遇到的模块识别问题。

问题描述

使用 Cursor 或 VSCode 打开 StarRocks 的后端工程 fe 时，spark-dpp 和 fe-core 模块没有被正确识别为 Java 工程，而其它 3 个模块（plugin-common、fe-common 和 hive-udf）可以正常识别。这会导致代码导航、自动补全等功能无法正常使用。

StarRocks FE 工程结构说明

StarRocks FE（Frontend）是 StarRocks 的前端服务组件，负责元数据管理、查询规划和优化等功能。它包括以下 5 个模块：

<modules><module>plugin-common</module>  <!-- 插件通用模块 --><module>fe-common</module>      <!-- 前端通用模块 --><module>spark-dpp</module>      <!-- Spark数据预处理模块 --><module>fe-core</module>        <!-- 前端核心模块 --><module>hive-udf</module>       <!-- Hive用户自定义函数模块 -->
</modules>

使用 Cursor/VSCode 打开前的准备工作

在使用 Cursor 或 VSCode 打开 StarRocks FE 项目前，需要完成以下准备工作：

1. 环境准备

确保您的开发环境满足以下要求：

• JDK 17（StarRocks 3.4.0+ 版本要求）
• Maven 3.6+
• Python 3.x
• Thrift 编译器

2. 生成源代码

按照官方指导，需要先完成以下步骤：

# 进入 fe 目录
cd starrocks/fe# 编译生成源代码
mvn clean install -DskipTests=true

这一步会在 fe-core 模块的 target 目录生成源代码，包括 Thrift 和 Protobuf 生成的代码。

3. 常见问题及解决方法

在执行 Maven 构建过程中，可能会遇到以下问题：

3.1 找不到 Thrift 编译器

如果报错找不到 thrift，需要安装 thrift 编译器：

# Ubuntu/Debian
sudo apt install thrift-compiler# CentOS/RHEL
sudo yum install thrift

3.2 Python 相关问题

确保已安装 Python，并在 Cursor 的 terminal （如果在 Cursor 的 terminal 运行 mvn，因 Cursor 的默认设置有问题）中运行 Maven 命令时清理环境变量：

# 清理 Python 相关环境变量
unset PYTHONHOME
unset PYTHONPATH

3.3 Java 版本问题

StarRocks FE 3.4.0+ 版本需要使用 Java 17：

# 设置 Java 环境变量
export JAVA_HOME=/path/to/java17
export PATH=$JAVA_HOME/bin:$PATH

问题解决方案

为了让 Cursor/VSCode 正确识别 spark-dpp 和 fe-core 模块，我们可以使用 Maven Eclipse 插件生成 Eclipse 项目配置文件（.project 和 .classpath），这些文件可以辅助 Cursor/VSCode 的 Java 扩展正确识别 Java 工程结构。

生成 Eclipse 配置文件

执行以下命令为 spark-dpp 和 fe-core 模块生成 Eclipse 配置：

mvn eclipse:clean eclipse:eclipse -pl spark-dpp,fe-core

注意：

1. 运行时间可能较长，请耐心等待
2. 如果 Java 语言服务器 (kvjs) 报 JTS 的 OOM 错误，需要在 fe/.vscode/settings.json 文件中增加以下配置：

   "java.jdt.ls.vmargs": "-XX:+UseG1GC -Dsun.zip.disableMemoryMapping=true -Xmx4G -Xms512m -Xlog:disable"
   

3. 使用eclipse插件完成后，检查生成的fe-core/.classpath文件，需要包括以下所有源代码，如果不全，可修改修改文件添加

	<classpathentry including="**/*.java" kind="src" output="target/test-classes" path="src/test/java"/><classpathentry excluding="**/*.java" kind="src" output="target/test-classes" path="src/test/resources"/><classpathentry including="**/*.java" kind="src" path="src/main/java"/><classpathentry including="**/*.java" kind="src" path="target/generated-sources/thrift"/><classpathentry including="**/*.java" kind="src" path="target/generated-sources/antlr4/com/starrocks/sql/parser"/><classpathentry including="**/*.java" kind="src" path="target/generated-sources/proto"/><classpathentry including="**/*.java" kind="src" path="target/generated-sources/build"/>

4. 使用ctrl+shift+p打开Java: Open Project Settings，修改fe-core模块的一些信息，apply
5. 每次修改都要重新打开一下工程，直接打开starrocks/fe这个父目录

补充说明

使用 IntelliJ IDEA 的替代方案

如果您更习惯使用 IntelliJ IDEA，可以直接打开 fe 文件夹，IDEA 会正常识别各个模块。但需要注意：

• 加载过程中 IDEA 可能会报 OOM 错误，可以通过增加 IDEA 的内存配置解决：
  参见另外一篇博客

Docker 开发环境

如果您希望使用 Docker 进行 StarRocks 开发，可以参考以下资源：

• StarRocks-Docker-Dev：一键式 StarRocks Docker 开发环境
• StarRocks/docker：官方 Docker 开发环境构建工具

注意事项

• 确保 pom.xml 文件正确配置
• 确保 Java 环境变量正确设置
• 确保 Maven 的 settings.xml 正确配置
• 模块名要使用 pom.xml 中定义的 <artifactId>
• 生成的 Eclipse 配置文件不应提交到版本控制系统中

相关资源

• StarRocks 官方文档
• StarRocks GitHub 仓库
• StarRocks 社区论坛
• StarRocks Slack 频道