为什么要自定义规则节点？

Thingsboard中为我们提供了很多规则节点，使用这些规则节点我们能完成大部分的配置任务，但是可能会有一些比较特殊的需求我们无法使用Thingsboard中提供的节点完成，例如外部节点中只有国外与一些国外厂商或框架交互的节点，而我们需要与国内厂商或者自己开发的系统进行交互就需要自定义节点了。

如何自定义节点?

一、创建项目

自定义节点是需要我们新建一个Java 项目然后编辑jar包引入到Thingsboard安装目录下的 **extensions** 目录的，所以我们需要新建一个项目来自定义节点。注意：并不是定义一个自定义节点即需要新建一个项目，每个项目都可以又N个自定义节点，为了便于管理，我们通常会将实现某个功能所需要的节点在一个项目内编写。
我们可以使用Maven或Gradle来管理项目，当然也可以不使用任何包管理工具，但是不建议这么做，因为官方的Demo使用Maven来管理的。
我们创建项目需要添加包依赖才能进行自定义节点的编写，因此我们需要在**pom.xml**或gradle.build文件中添加依赖项下面列出两种包管理工具所需要添加的内容。
Maven
版本信息

  1. <properties>
  2.     <!--Thingsboard版本,你使用的版本是多少就写多少-->
  3.     <thingsboard.version>3.1.1</thingsboard.version>
  4.     <!--Lombok版本-->
  5.     <lombok.version>1.16.18</lombok.version>
  6.     <!--Guava版本-->
  7.     <guava.version>21.0</guava.version>
  8. </properties>

引入依赖包

  1.     <dependencies>
  2.         <dependency>
  3.             <groupId>org.thingsboard.common</groupId>
  4.             <artifactId>data</artifactId>
  5.             <scope>provided</scope>
  6.             <version>${thingsboard.version}</version>
  7.         </dependency>
  8.         <dependency>
  9.             <groupId>org.thingsboard.common</groupId>
  10.             <artifactId>message</artifactId>
  11.             <scope>provided</scope>
  12.             <version>${thingsboard.version}</version>
  13.         </dependency>
  14.         <dependency>
  15.             <groupId>org.thingsboard.common</groupId>
  16.             <artifactId>util</artifactId>
  17.             <scope>provided</scope>
  18.             <version>${thingsboard.version}</version>
  19.         </dependency>
  20.         <dependency>
  21.             <groupId>org.thingsboard.common</groupId>
  22.             <artifactId>dao-api</artifactId>
  23.             <scope>provided</scope>
  24.             <version>${thingsboard.version}</version>
  25.         </dependency>
  26.         <dependency>
  27.             <groupId>org.thingsboard.rule-engine</groupId>
  28.             <artifactId>rule-engine-api</artifactId>
  29.             <scope>provided</scope>
  30.             <version>${thingsboard.version}</version>
  31.         </dependency>
  32.         <dependency>
  33.             <groupId>org.projectlombok</groupId>
  34.             <artifactId>lombok</artifactId>
  35.             <scope>provided</scope>
  36.             <version>${lombok.version}</version>
  37.         </dependency>
  38.         <dependency>
  39.             <groupId>com.google.guava</groupId>
  40.             <artifactId>guava</artifactId>
  41.             <scope>provided</scope>
  42.             <version>${guava.version}</version>
  43.         </dependency>
  44.     </dependencies>

由于默认的maven仓库中并没有Thingsboard的依赖库,所以我们还需要配置使用Thingsboard的依赖库
**

  1.         <repositories>
  2.         <repository>
  3.             <id>thingsboard-repo</id>
  4.             <url>https://repo.thingsboard.io/artifactory/libs-release-public</url>
  5.             <snapshots>
  6.                 <enabled>true</enabled>
  7.             </snapshots>
  8.         </repository>
  9.     </repositories>

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>top.zczhen</groupId>
  8.     <artifactId>CustomRuleNodes</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  11.     <properties>
  12.         <!--Thingsboard版本,你使用的版本是多少就写多少-->
  13.         <thingsboard.version>3.1.1</thingsboard.version>
  14.         <!--Lombok版本-->
  15.         <lombok.version>1.16.18</lombok.version>
  16.         <!--Guava版本-->
  17.         <guava.version>21.0</guava.version>
  18.         <maven.compiler.source>8</maven.compiler.source>
  19.         <maven.compiler.target>8</maven.compiler.target>
  20.     </properties>
  22.     <dependencies>
  23.         <dependency>
  24.             <groupId>org.thingsboard.common</groupId>
  25.             <artifactId>data</artifactId>
  26.             <scope>provided</scope>
  27.             <version>${thingsboard.version}</version>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>org.thingsboard.common</groupId>
  31.             <artifactId>message</artifactId>
  32.             <scope>provided</scope>
  33.             <version>${thingsboard.version}</version>
  34.         </dependency>
  35.         <dependency>
  36.             <groupId>org.thingsboard.common</groupId>
  37.             <artifactId>util</artifactId>
  38.             <scope>provided</scope>
  39.             <version>${thingsboard.version}</version>
  40.         </dependency>
  41.         <dependency>
  42.             <groupId>org.thingsboard.common</groupId>
  43.             <artifactId>dao-api</artifactId>
  44.             <scope>provided</scope>
  45.             <version>${thingsboard.version}</version>
  46.         </dependency>
  47.         <dependency>
  48.             <groupId>org.thingsboard.rule-engine</groupId>
  49.             <artifactId>rule-engine-api</artifactId>
  50.             <scope>provided</scope>
  51.             <version>${thingsboard.version}</version>
  52.         </dependency>
  53.         <dependency>
  54.             <groupId>org.projectlombok</groupId>
  55.             <artifactId>lombok</artifactId>
  56.             <scope>provided</scope>
  57.             <version>${lombok.version}</version>
  58.         </dependency>
  59.         <dependency>
  60.             <groupId>com.google.guava</groupId>
  61.             <artifactId>guava</artifactId>
  62.             <scope>provided</scope>
  63.             <version>${guava.version}</version>
  64.         </dependency>
  65.     </dependencies>
  67.     <repositories>
  68.         <repository>
  69.             <id>thingsboard-repo</id>
  70.             <url>https://repo.thingsboard.io/artifactory/libs-release-public</url>
  71.             <snapshots>
  72.                 <enabled>true</enabled>
  73.             </snapshots>
  74.         </repository>
  75.     </repositories>
  77. </project>

Gradle
版本信息

  1. ext {
  2.     tb_version = '3.1.1'
  3.     lombok_version = '1.16.18'
  4.     guava_version = '21.0'
  5. }

引入依赖包

  1. dependencies {
  2.     compileOnly  "org.thingsboard.common:data:$tb_version"
  3.     compileOnly  "org.thingsboard.common:message:$tb_version"
  4.     compileOnly  "org.thingsboard.common:util:$tb_version"
  5.     compileOnly  "org.thingsboard.common:dao-api:$tb_version"
  6.     compileOnly  "org.thingsboard.rule-engine:rule-engine-api:$tb_version"
  7.     compileOnly  "org.projectlombok:lombok:$lombok_version"
  8.     compileOnly  "com.google.guava:guava:$guava_version"
  9. }

配置依赖库

  1. repositories {
  2.     ......
  3.     maven {
  4.         url 'https://repo.thingsboard.io/artifactory/libs-release-public'
  5.     }
  6. }

gradle.build

  1. plugins {
  2.     id 'java'
  3. }
  5. group 'top.zczhen'
  6. version '1.0-SNAPSHOT'
  8. ext {
  9.     tb_version = '3.1.1'
  10.     lombok_version = '1.16.18'
  11.     guava_version = '21.0'
  12. }
  14. repositories {
  15.     mavenCentral()
  16.     maven {
  17.         url 'https://repo.thingsboard.io/artifactory/libs-release-public'
  18.     }
  19. }
  21. dependencies {
  22.     compileOnly  "org.thingsboard.common:data:$tb_version"
  23.     compileOnly  "org.thingsboard.common:message:$tb_version"
  24.     compileOnly  "org.thingsboard.common:util:$tb_version"
  25.     compileOnly  "org.thingsboard.common:dao-api:$tb_version"
  26.     compileOnly  "org.thingsboard.rule-engine:rule-engine-api:$tb_version"
  27.     compileOnly  "org.projectlombok:lombok:$lombok_version"
  28.     compileOnly  "com.google.guava:guava:$guava_version"
  29.     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
  30.     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
  31. }
  33. test {
  34.     useJUnitPlatform()
  35. }

开始编码

要自定义规则节点我们需要实现TbNode接口,该接口的源码如下:

  1. public interface TbNode {
  3.     void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException;
  5.     void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException;
  7.     void destroy();
  9.     default void onPartitionChangeMsg(TbContext ctx, PartitionChangeMsg msg) {}
  11. }

该接口有四个接口方法,其中init()、onMsg()、destory()三个方法是必须实现的，onPartitionChangeMsg()方法是默认实现的，从方法名我们可以看出，init()方法是在节点初始化时调用，onMsg()方法是在节点处理信息时调用，而destroy()方法是在节点销毁时调用，但是这样并不好理解，我们并不知道这些方法究竟时在什么时候回被调用，因此我们编写如下代码进行测试。