注意:本文借用了一些其他文章的一些截图,同时自己做了具体的编译步骤,添加了一些新的内容
目标: 编译StarRocks2.5.13版本FE节点代码,在本地window环境运行,可以访问到8030界面。
StarRocks的FE是使用Java语言开发的,这里咱们使用IntelliJ IDEA在Windows下进行FE开发环境的搭建。以下演示过程中所用组件的版本信息如下:
工具名称 | 当前版本 | 版本要求 | 备注 |
---|---|---|---|
linux服务器 | centos7 | 无 | |
IntelliJ IDEA | IntelliJ IDEA 2021.03 | 不要过低 | |
JDK | Oracle JDK 1.8.0_201 | jdk 1.8+ | |
Maven | apache-maven-3.6.3 | 无特别要求 | |
DBeaver | 20.2 | 无特别要求 |
不同于一般的Maven类的项目,若我们直接从git中获取代码放入IDEA中是跑不起来的,我们需要先在StarRocks工程中手动运行maven命令生成一些Java代码来加入到FE工程中用于后续IDEA的编译。在Windows环境下,部分make命令和sh脚本可能无法执行,所以我们可以先在Docker镜像中进行StarRocks的编译,编译的过程中同样会生成那些我们需要用到的Java文件。
为方便演示,我们使用虚拟机下的CentOS 7.6执行编译,虚拟机的配置建议在2核4G以上,内存过小编译过程中可能会出错,CPU核数过少则可能会导致编译时间较长。同时,编译过程中还务必保持网络畅通。
在root用户下使用yum安装Docker:
[root@localhost ~]# yum -y install docker
[root@localhost ~]# systemctl start docker
[root@localhost ~]# systemctl enable docker
Created symlink from /etc/systemd/system/multi-user.target.wants/docker.service to /usr/lib/systemd/system/docker.service.
[root@localhost ~]# docker run hello-world
Unable to find image 'hello-world:latest' locally
Trying to pull repository docker.io/library/hello-world ...
latest: Pulling from docker.io/library/hello-world
2db29710123e: Pull complete
Digest: sha256:cc15c5b292d8525effc0f89cb299f1804f3a725c8d05e158653a563f15e4f685
Status: Downloaded newer image for docker.io/hello-world:latest
Hello from Docker!
This message shows that your installation appears to be working correctly.
………………
由于网络原因,下载一个Docker官方镜像可能会需要很长的时间,甚至下载失败。为此,阿里云容器镜像服务ACR提供了官方的镜像站点,从而加速官方镜像的下载。具体配置方法参考阿里云文档:
https://help.aliyun.com/zh/acr/user-guide/accelerate-the-pulls-of-docker-official-images
我们等待拉取完成:
docker拉取2.5.13版本命令
docker pull starrocks/dev-env-centos7:2.5-latest
这里注意,我们编译的时候要选择和StarRocks大版本匹配的Docker镜像,例如:
starrocks branch | image tag |
---|---|
main | starrocks/dev-env:main |
branch-1.19 | starrocks/dev-env:branch-1.19 |
branch-2.0 | starrocks/dev-env:branch-2.0 |
branch-2.1 | starrocks/dev-env:branch-2.1 |
我们这里使用的是2.5.13下的代码,所以直接pull main对应的镜像:
[root@localhost ~]# docker pull starrocks/dev-env-centos7:2.5-latest
19884eca2d12: Pull complete
463267783751: Pull complete
Digest: sha256:ab44decbdc2eaaa98cdc4647380a492299b175a35b165d50e30f183495090123
Status: Downloaded newer image for docker.io/starrocks/dev-env-centos7:2.5-latest
[root@localhost ~]# docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
docker.io/starrocks/dev-env-centos7:2.5-latest 2.5-latest 76d14ca637fc 5 weeks ago 8.65 GB
docker.io/hello-world latest feb5d9fea6a5 8 weeks ago 13.3 kB
[root@localhost ~]# git clone https://github.com/StarRocks/starrocks.git
Cloning into 'starrocks'...
以通过浏览器访问github,然后从main分支下下载的最新代码为例,我们下载后得到源码包starrocks-2.5.13.zip,将其上传至CentOS中,文件路径为/root/starrocks-2.5.13.zip:
[root@localhost ~]# ls
starrocks-2.5.13.zip
执行解压:
[root@localhost ~]# unzip starrocks-2.5.13.zip
得到:/root/starrocks-2.5.13
[root@localhost ~]# ls
starrocks-2.5.13 starrocks-2.5.13.zip
[root@localhost ~]# docker run -it -v /root/.m2:/root/.m2 -v /root/starrocks-2.5.13:/root/starrocks-2.5.13 --name starrocks-image --privileged=true -d starrocks/dev-env-centos7:2.5-latest
6ebc6a124fdf9d2c28b6eb2543e570775b2f3eabb7716120a3cefe8506ee9d2f
[root@localhost ~]# docker ps
[root@localhost ~]# docker exec -it starrocks-image /bin/bash
[root@ed39d436e75c local]# [这里注意看主机名,确认已进入容器]
[root@ed39d436e75c local]# cd /root/starrocks-2.5.13
[root@ed39d436e75c starrocks-2.5.13]#
[root@ed39d436e75c starrocks-2.5.13]# sh build.sh --clean --fe
这一步会下载较多依赖并执行编译,会非常耗时。运行容器时我们挂载本地.m2目录即是为了首次编译下载的依赖后面再编译时可以复用。这一步只要不报错,我们慢慢等待即可。编译完成后,产出文件在output/目录中:
[root@docker starrocks-2.5.13]# cd output/
[root@docker output]# ll
total 1992
drwxr-xr-x 6 root root 51 Nov 2 00:20 be
drwxr-xr-x 7 root root 72 Nov 2 00:20
-rw-r--r-- 1 root root 3858 Nov 1 11:20 LICENSE.txt
-rw-r--r-- 1 root root 2032787 Nov 2 00:20 NOTICE.txt
drwxr-xr-x 4 root root 32 Nov 2 00:20 udf
需要把【/root/starrocks-2.5.13/fe/fe-core/target】目录下产生的generated-sources下载下来,后面会用到。
接下来我们准备FE工程代码,首先,我们FE中需要用到的git中的代码有:
例如我们将项目放在本地C盘下的starRocks文件夹中,fe工程主目录结构如下:
为了避免本地多网卡(虚拟网卡)导致的IP识别错误问题,我们需要在fe.conf中提前配置需要用的本地ip,例如我本地当前可与局域网通信的ip为192.168.1.10,则配置如下:
priority_networks = 192.168.1.40
注意:在配置ip后,还建议将本机的ip配置为固定ip,避免因电脑重启或者其他原因引起本地ip改变,进而导致FE无法正常启动。
fe.conf中的其他配置通常默认即可,若需要修改,可以参考“集群部署”章节进行调整。
在D:\soft\sourcecode\starrocks-2.5.13\fe\fe-core中创建target文件夹,然后我们再将前面生成的generated-sources目录同路径拷贝过来:
2、调试工程
打开IntelliJ IDEA(IDEA已配置jdk和maven),选择Open打开项目,找到我们本地工程的路径,
点击:Trust Project信任项目:
等待项目加载完成,期间会下载依赖,可能需要等待一些时间:
加载完毕,确认没有依赖缺失后,我们找到FE的项目启动文件:
fe/fe-core/src/main/java/com/starrocks/StarRocksFE.java
这里还取个巧,我们先运行Main方法让工程开始build:
在这里设置两个运行环境变量,路径都设置为当前工程的主目录D:\soft\sourcecode\starrocks-2.5.13\fe:
STARROCKS_HOME=D:/soft/sourcecode/starrocks-2.5.13/fe;PID_DIR=D:/soft/sourcecode/starrocks-2.5.13/fe;LOG_DIR=D:/soft/sourcecode/starrocks-2.5.13/fe
配置完成后点击“Apply”,等待工程Bulid完成和启动,当我们看到日志中出现:
notify new FE type transfer: MASTER
即表明工程已启动成功(若提示没有STARROCKS_HOME等,可以重新执行方法)。
再次提示:FE启动后会将当前的ip信息写入本地文件中,若ip改变会无法正常启动,所以务必要将本机的ip配置为静态ip。
3、访问FE
地址:
http://localhost:8030/