Thingsboard开发环境搭建及编译项目

交流QQ群

如果安装有其他问题,可以到QQ群求助

如果安装有其他问题,可以优先查看本文后面的各种编译问题解决方案,如果还不行可以到交流群求助:121202538

环境安装

开发环境要求:
Jdk 1.8版本
Postgresql 9以上
Node.js
Npm
Maven 3.6以上
Git工具
Idea开发工具
Redis

JDK

下载安装

JDK官方下载地址: https://www.oracle.com/java/technologies/javase-jdk8-downloads.html

JDK版本选择JDK8,我本地环境是Windos10 64位,所以选择jdk-8u221-windows-x64.exe

image.png

下载好了之后直接默认安装就行
image.png

配置环境变量

步骤1:
在JAVA_HOME中增加JDK的安装地址:C:Program FilesJavajdk1.8.0_221
image.png

步骤2:
在CLASSPATH中增加JDK的安装地址中的文件:.;%JAVA_HOME%lib;%JAVA_HOME%libdt.jar;%JAVA_HOME%libtools.jar
image.png

步骤3:
在Path中增加JDK的地址:%JAVA_HOME%bin;%JAVA_HOME%jrebin;
image.png

步骤4
输入以下命令

java -version

如果能出现以下的提示信息,就算安装成功了
image.png

安装IDEA

参考:IDEA安装教程

安装Maven

步骤1:下载maven,进入地址:http://maven.apache.org/download.cgi
image.png

步骤2:下载到本地
image.png

步骤3:配置环境变量
增加MAVEN_HOME,即maven的地址:D:tbapache-maven-3.6.1-bin,请注意,如果直接解压,有可能会有两个apache-maven-3.6.1-bin
image.png

image.png

MAVEN_OPTS,参数是 -Xms128m -Xmx1024m
image.png

修改Path,增加Maven的地址%MAVEN_HOME%bin;
image.png

测试Maven安装,打开命令行工具。使用命令mvn -v,如果能出现以下提示,即安装成功
image.png

Nodejs安装

步骤1:下载Nodejs安装包,Nodejs官网地址:https://nodejs.org/en/download/
image.png

步骤2:安装完成后,使用命令查看Nodejs是否已经安装完成,能出现以下提示说明已经安装成功
image.png

安装git

步骤1:下载git安装包,git官网地址是:https://git-scm.com/download/win
image.png

步骤2:安装完成后,使用命令行测试git
image.png

安装npm全局依赖

步骤1:使用管理员CMD命令行,执行下面命令

#npm 环境读取环境变量包  npm install -g cross-env    #webpack打包工具  npm install -g webpack

image.png

安装redis

Redis安装参考:https://www.iotschool.com/wiki/redis

环境安装到此结束,接下来是通过Git拉取代码。

克隆thingsboard代码

确定代码存放位置

在本地创建代码存放位置的文件目录,然后进入当前目录点击鼠标右键,选择Git Bash Here
image.png

输入git命令克隆源代码

git clone https://github.com/thingsboard/thingsboard.git

image.png

耐心等待一段时间后,看到以下界面就算下载成功
image.png

切换git分支

默认下载的代码是master主分支的,我们开发需要切换到最新版本的分支。

查看项目源码的所有分支,下载源码后,需要进入到thingsboard文件夹
image.png

发现最新发布的版本是2.4,所以我这里选择2.4,当然你可以根据自己的情况进行分支选择

输入命令以下,即可切换至2.4的分支

git checkout release-2.4

看到下图这样,即切换成成功
image.png

准备工作

外网连接

因为TB在编译过程中需要依赖很多国外的包,那么需要外网才能连接,有连接外网支持,可以到社区求助:https://www.iotschool.com/topics/node8

设置Maven为淘宝镜像

工程是基于Maven管理,直接通过idea open,之后会自动下载各种依赖包。依赖包的默认存储地址为:C:Users用户名.m2repository,内容如下:

$tree ~/.m2 -L 2  /home/jay/.m2  └── repository      ├── antlr      ├── aopalliance      ├── asm      ├── backport-util-concurrent      ├── ch      ...

一般情况下,使用官方镜像更新依赖包,网速不稳定,可将Maven镜像源设置为淘宝的,在maven安装包目录下找到settings.xml设置

大概位置截图:

把settings.xml里面内容设置成以下:

<mirrors>    <mirror>         <!--This sends everything else to /public -->         <id>aliyun_nexus</id>         <mirrorOf>*,!maven_nexus_201</mirrorOf>         <url>http://maven.aliyun.com/nexus/content/groups/public/</url>     </mirror>  </mirrors>

不会设置的,可以参考这个文件:https://cdn.iotschool.com/iotschool/settings.xml

thingsboard QQ群也又这个资源:121202538

设置npm为淘宝镜像

同上,网速不好npm过程中也会下载失败,这是导致很多同学thingsboard编译失败的主要原因,所以我们在进行编译之前,也将npm替换为淘宝镜像:

npm install -g mirror-config-china --registry=http://registry.npm.taobao.org        #使用淘宝镜像  npm config get registry                                                             #查询当前镜像  npm config rm registry                                                              #删除自定义镜像,使用官方镜像  npm info express

设置IDEA管理员启动

我本地开发环境编译项目使用IDEA工具进行编译,所以需要设置管理员启动,这样才有所有的权限执行编译命令。
步骤1:点击IDEA图标右键,选择属性。
image.png

步骤2:点击兼容性-更改所有用户设置-以管理员身份运行此程序
image.png
image.png

开始编译

编译项目跟网速有关,最好连接上外网进行编译,一般5~30分钟都有可能,超过30分钟要检查你的网络。

清理项目编译文件

使用IDEA Maven工具进行清理
image.png

输入编译命令开始编译

在IDEA控制台(左下方)Terminal输入以下命令进行编译:

mvn clean install -DskipTests

image.png

等一段时间后,看到下面这张图就算编译成功,如果没有编译成功请按照本教程最后的常见问题进行排查,一般都是网络问题。如果还有问题,请到社区thingsboard专题中提问。

image.png

常见问题

本教程只会罗列IoTSchool小编在thingsboard编译过程中遇到的问题,如果有其他问题,请到社区thingsboard专题中提问,会有专家为你解答。

缓存导致编译失败

每次编译失败进行二次编译时,要清理缓存,并杀死遗留进程
步骤1:执行下面命令,杀死遗留进程

taskkill /f /im java.exe

步骤2:使用IDEA Maven工具进行清理
image.png

温馨提示:要进行二次编译前,最好重启一次电脑!

Server UI 编译失败

[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.0:npm (npm install) on project ui: Failed to run task: 'npm install' failed. (error code 1) -> [Help 1]

image.png

如果遇到这个问题,可从以下几个原因进行分析:

原因1:node、npm版本号问题

本地环境安装的node、npm版本号与源码中pom.xml文件配置的版本号不一致。

解决方案:
步骤1:使用node -v、npm -v查看安装的node和npm版本号
image.png

步骤2:修改源码中pom.xml文件中的版本号

<configuration>     <nodeVersion>v12.13.1</nodeVersion>     <npmVersion>6.12.1</npmVersion>  </configuration>

需要修改的文件有三处,位置如下:
image.png

原因2:node-sass下载失败

编译Server UI时,会下载node-sass依赖,如果因为网络原因没有下载成功,也会编译失败。如果你是按照本本教材一步一步来的,应该不会有问题,上面准备工作中,将npm镜像源切换为淘宝,那么下载会很快的。

[INFO] Downloading binary from https://github.com/sass/node-sass/releases/download/v4.12.0/win32-x64-72_binding.node  [ERROR] Cannot download "https://github.com/sass/node-sass/releases/download/v4.12.0/win32-x64-72_binding.node":  [ERROR]  [ERROR] ESOCKETTIMEDOUT  [ERROR]  [ERROR] Hint: If github.com is not accessible in your location  [ERROR]       try setting a proxy via HTTP_PROXY, e.g.  [ERROR]  [ERROR]       export HTTP_PROXY=http://example.com:1234  [ERROR]  [ERROR] or configure npm proxy via  [ERROR]  [ERROR]       npm config set proxy http://example.com:8080  [INFO]  [INFO] > [email protected] postinstall F:workspacethingsboardthingsboarduinode_modulesnode-sass  [INFO] > node scripts/build.js  [INFO]

image.png

解决方案:切换镜像源为淘宝

解决方案:重启电脑,清理缓存

原因3:Thingsboard 3.0版本编译遇到的问题

亲测:2.4版本也可以通过这种方式来解决

Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.7.5:npm (npm install) on project ui-ngx: Failed to run task: 'npm install' failed. org.apache.commons.exec.ExecuteException: Process exited with an error: -4048 (Exit value: -4048) -> [Help 1]

解决方案:https://www.iotschool.com/topics/84

原因4:二次编译导致残留进程

报错:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-clean-plugin:2.5:clean (default-clean) on project ui: Failed to clean project: Failed to delete F:workspacethingsboardthingsboarduitargetnodenode.exe -> [Help 1]

image.png

Server Tool编译失败

image.png

[ERROR] Failed to execute goal on project tools: Could not resolve dependencies for project org.thingsboard:tools:jar:2.4.3: Failed to collect dependencies at org.eclipse.paho:org.eclipse.paho.client.mqttv3:jar:1.1.0: Failed to read artifact descriptor for org.eclipse.paho:org.eclipse.paho.clien  t.mqttv3:jar:1.1.0: Could not transfer artifact org.eclipse.paho:org.eclipse.paho.client.mqttv3:pom:1.1.0 from/to aliyun_nexus (http://maven.aliyun.com/nexus/content/groups/public/): Failed to transfer file http://maven.aliyun.com/nexus/content/groups/public/org/eclipse/paho/org.eclipse.paho.cli  ent.mqttv3/1.1.0/org.eclipse.paho.client.mqttv3-1.1.0.pom with status code 502 -> [Help 1]

一般由于网络原因,IoTSchool小编至少编译了3次才成功,每次编译都重启电脑,并清理环境。

解决方案:如果使用的是mvn clean install -DskipTests命令进行编译,那么就多尝试几次,每次编译前,要清理环境。

参考:https://github.com/thingsboard/performance-tests/issues/10

JavaScript Executor编译失败

JavaScript Executor Microservice编译失败
image.png

[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.0:npm (npm install) on project js-executor: Failed to run task: 'npm install' failed. (error code 2) -> [Help 1]  [ERROR]  [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.  [ERROR] Re-run Maven using the -X switch to enable full debug logging.  [ERROR]  [ERROR] For more information about the errors and possible solutions, please read the following articles:  [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException  [ERROR]  [ERROR] After correcting the problems, you can resume the build with the command  [ERROR]   mvn <goals> -rf :js-executor

原因:本地缓存缺少fetched-v10.15.3-linux-x64和fetched-v10.15.3-win-x64这两个文件。

解决方案:
步骤1:下载这两个文件到本地,下载后记得重命名,下载地址:https://github.com/zeit/pkg-fetch/releases
image.png

步骤2: 将下载的两个文件放到:放到:C:Users你的用户名  .pkg-cachev2.6。并将名字分别修改为:fetched-v10.15.3-linux-x64和fetched-v10.15.3-win-x64

参考:https://github.com/thingsboard/thingsboard/issues/2084

License检查不通过

[ERROR] Failed to execute goal com.mycila:license-maven-plugin:3.0:check (default) on project thingsboard: Some files do not have the expected license header -> [Help 1]

解决方案:在根目录pom.xml中屏蔽license-maven-plugin

image.png

搜索license-maven-plugin,将整个plugin都注释掉
image.png

Web UI编译失败

Web UI编译失败请参考Server UI编译失败第一个原因

maven:Could not resolve dependencies for project org.thingsboard:application:

错误信息

[ERROR] Failed to execute goal on project application: Could not resolve dependencies for project org.thingsboard:application:jar:2.4.1: The following artifacts could not be resolved: org.thingsboard.rule-engine:rule-engine-components:jar:2.4.1, org.thingsboard:dao:jar:2.4.1: Could not find artifact org.thingsboard.rule-engine:rule-engine-components:jar:2.4.1 in jenkins (http://repo.jenkins-ci.org/releases) -> [Help 1]

解决方案:根目录下去maven编译,不要在每个单独编译,否则不能自动解决依赖,如果你已经在子模块进行了编译,请回到根目录先clean一下,再重新编译。

maven:Failed to delete tb-http-transport.rpm

错误信息:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-clean-plugin:2.5:clean (default-clean) on project http: Failed to clean project: Failed to delete D:my_projectthingsboardtransporthttptargettb-http-transport.rpm -> [Help 1]

解决方案:第一次编译失败,再次编译可能会提示该错误,可以手动到报错路径删除,如果提示文件正在使用,需要在任务管理器杀死java进程后再手动删除。

npm:npm:cb() never called!

错误信息:

npm ERR! cb() never called!    npm ERR! This is an error with npm itself. Please report this error at:  npm ERR!     <https://npm.community>    npm ERR! A complete log of this run can be found in:  npm ERR!     C:UsersyurenAppDataRoamingnpm-cache_logs2019-11-06T10_55_28_258Z-debug.log

解决方案:
尝试npm cache clean –force 后再次npm install 无果;
尝试更换淘宝镜像源后再次npm install 无果;
怀疑有些包下载需要翻墙,全局代理翻墙后问题依然存在;
参考网上关闭所有代理后问题依然存在;
通过log日志分析最后一个解包报错的地方,屏蔽需要的material-design-icons,新modules rxjs仍然报错;

extract [email protected] extracted to node_modules.stagingmaterial-design-icons-61b4d55e (72881ms)  extract [email protected] extracted to node_modules.stagingrxjs-e901ba4c (24280ms)

参考npm ERR cb() never called 执行

npm install --no-package-lock

之后提示npm ERR! path git,添加git 到环境变量后正常。

npm:npm ERR! path git

错误信息

npm ERR! path git  npm ERR! code ENOENT  npm ERR! errno ENOENT  npm ERR! syscall spawn git  npm ERR! enoent Error while executing:  npm ERR! enoent undefined ls-remote -h -t git://github.com/fabiobiondi/angular-

解决方案:添加git到环境变量。

No compiler is provided in this environment

错误信息:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.  1:compile (default-compile) on project netty-mqtt: Compilation failure  [ERROR] No compiler is provided in this environment. Perhaps you are running on  a JRE rather than a JDK?

需要在环境变量中设置java,包含%JAVA_HOME%bin;%JAVA_HOME%lib;

更多问题,请到社区解决:https://www.iotschool.com/topics/node8