分类 ThingsBoard 下的文章

众所周知,ThingsBoard 核心采用 Spring Boot 开发,当然,很多人已经在 Spring Boot 之上平步青云,那如何无缝扩展 ThingsBoard 功能,而不改变原有代码结构,且将来无缝升级?

如果你有 ThingsBoard 服务需求或二次开发需求,请与我们联系: 18616669123

关注我们

关注 ThingsBoard 微信公众号

手动增加微信公众号:thingsboard_cn
2023-10-26T01:09:12.png

访问 ThingsBoard 中文社区网站

访问网址:http://www.thingsboard.club
2023-10-26T01:08:23.png

创建自定义 Spring Boot Starter,实现功能模块

新建 Spring Boot Starter 项目

  • 名称定义为了方便识别: xxx-xxx-spring-boot-starter
    ![project.png][3]

  • 增加依赖,看需求,自己的项目需要,spring-boot-autoconfigure,必不可少!
    ![depends.png][4]

  • 完整pom.xml,自己细品

    
    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    
      <modelVersion>4.0.0</modelVersion>
      <parent>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-parent</artifactId>
          <version>2.3.4.RELEASE</version>
          <relativePath /> <!-- lookup parent from repository -->
      </parent>
      <groupId>cn.yiqisoft</groupId>
      <artifactId>report-spring-boot-starter</artifactId>
      <version>0.0.1</version>
      <name>EcolabReport</name>
      <description>Ecolab Report</description>
    
      <properties>
          <java.version>1.8</java.version>
      </properties>
    
      <dependencies>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-web</artifactId>
          </dependency>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-web-services</artifactId>
          </dependency>
    
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-devtools</artifactId>
              <scope>runtime</scope>
              <optional>true</optional>
          </dependency>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-configuration-processor</artifactId>
              <optional>true</optional>
          </dependency>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-autoconfigure</artifactId>
          </dependency>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-test</artifactId>
              <scope>test</scope>
              <exclusions>
                  <exclusion>
                      <groupId>org.junit.vintage</groupId>
                      <artifactId>junit-vintage-engine</artifactId>
                  </exclusion>
              </exclusions>
          </dependency>
    
      </dependencies>
    
      <build>
          <plugins>
              <plugin>
                  <groupId>org.springframework.boot</groupId>
                  <artifactId>spring-boot-maven-plugin</artifactId>
              </plugin>
          </plugins>
      </build>


## 新建controller,为了方便测试,简单即可
- 新建 controller 文件


    package cn.yiqisoft.ecolabanalysis.controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    @RestController
    public class ReportController {
        @RequestMapping(value = "/api/report", method = RequestMethod.GET)
        public String reportList() {
            return "Report List";
        }
    }

## 自动装载工程
- 新建 src/main/resources/META-INF/spring.factories 文件

    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    cn.yiqisoft.ecolabanalysis.controller.ReportController

- 通知 Spring Boot 启动时自动装载我们的 Controller

## 打包,jar 包输出
命令行编译,并安装到本地 maven 库

    mvn clean install

生成 ~/.m2/repository/cn/yiqisoft/report-spring-boot-starter/0.0.1/ecolab-report-spring-boot-starter-0.0.1.jar,这样本地其他项目依赖此 jar 包即可。

## 【可选】本地运行项目,独立测试都没问题
命令行启动项目

    mvn spring-boot:run

效果

    jiekechoo@jiekechoo ~ % curl http://localhost:8080/api/report
    Report List
    jiekechoo@jiekechoo ~ % 

# 融入 ThingsBoard ,实现无缝二次开发
## 自定义 starter 分析
- 我们的 maven 库
    <groupId>cn.yiqisoft</groupId>
    <artifactId>report-spring-boot-starter</artifactId>
    <version>0.0.1</version>

- 加入 ThingsBoard application 工程依赖,在 application/pom.xml 加入我们的 maven 库即可
![pom.png][5]

## 运行 ThingsBoard application 工程
- 打开 swagger ,我们二次开发的模块已经被成功载入
![swagger.png][6]

## 扩展
- 即使 ThingsBoard 升级,我们单独 jar 包也相应升级即可;
- 独立使用自己的二次开发数据库表,不影响 TB 本身;
- 如果有能力,将自定义 jar 做成动态加载,实现更高级别。

# 关于 亿琪软件
上海亿琪软件有限公司成立于2016年,专注于 5G 通信、AI 人工智能、边缘计算和大数据网络安全多项技术领域,致力于物联网领域前沿技术的创新,为用户提供全方位、智能化和安全的物联网解决方案。

2023年,公司发布“YiFUSION|工业边缘智能融合一体机”产品,为工业客户提供一整套的边缘计算+AI能力:高性能数据采集、多类型数据融合、AI算法集成、云端业务对接。在边缘网关的基础上,集成了 IoT 平台的边缘协同能力、本地Web SCADA 和 HMI 功能、本地数据存储、边缘 AI 视频分析、行业应用集成等。

2022年公司推出 “YiCLOUD|亿琪云”一站式物联网应用解决方案。公司的业务涵盖了智慧城市、智慧农业、智能工厂和智慧园区等多个领域,公司软硬件产品和解决方案获得华为技术认证,得到中国移动OCP认证,公司还是边缘计算产业联盟ECC成员。

感知物联,畅快无限。

联系我们
网站:http://yiqisoft.cn
邮件:support@yiqisoft.cn
电话:021-68863086
手机:186-1666-9123


  [1]: https://www.yiqisoft.cn/blogs/usr/uploads/2023/10/2404940997.png
  [2]: https://www.yiqisoft.cn/blogs/usr/uploads/2023/10/2925476062.png
  [3]: https://yiqisoft.cn/blogs/usr/uploads/2020/11/1800199431.png
  [4]: https://yiqisoft.cn/blogs/usr/uploads/2020/11/2247303675.png
  [5]: https://yiqisoft.cn/blogs/usr/uploads/2020/11/3476619080.png
  [6]: https://yiqisoft.cn/blogs/usr/uploads/2020/11/1780987658.png