上篇文章介绍了如何对 ThingsBoard 进行无缝二次开发,在进一步集成 Spring Data Jpa 时,导致依赖注入问题,经过几十个小时的不懈努力,终于得到解决。参考了官方代码,只需要简单一个 Config 配置文件即可解决。

问题

  • 不多说,看图,你估计会遇到
    error.png

必要条件

正常开发模式

  • Controller
  • Entity,Pojo,Domain
  • Dao,Repository
  • Service
  • AutoConfig

解决方案

  • 官方参考
    tb.png
@Configuration
@EnableAutoConfiguration
@ComponentScan("org.thingsboard.server.dao.sql")
@EnableJpaRepositories("org.thingsboard.server.dao.sql")
@EntityScan("org.thingsboard.server.dao.model.sql")
@EnableTransactionManagement
public class JpaDaoConfig {

}
  • 依葫芦画瓢
    eco.png
@Configuration
@ComponentScan({ "cn.yiqisoft.ecolabanalysis.controller", "cn.yiqisoft.ecolabanalysis.services" })
@EnableJpaRepositories("cn.yiqisoft.ecolabanalysis.dao")
@EntityScan("cn.yiqisoft.ecolabanalysis.domain")
public class ReportAutoConfiguration {
}
  • ThingsboardServerApplication 扫描自己的 namespace

    @ComponentScan({"org.thingsboard.server","cn.yiqisoft.ecolabanalysis"})
    
  • 验证结果
    result.jpeg

**

至此,完全独立扩展 ThingsBoard!

**

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

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

新建 Spring Boot Starter 项目

  • 名称定义为了方便识别: xxx-xxx-spring-boot-starter
    project.png
  • 增加依赖,看需求,自己的项目需要,spring-boot-autoconfigure,必不可少!
    depends.png
  • 完整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>
    
    </project>

新建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

运行 ThingsBoard application 工程

  • 打开 swagger ,我们二次开发的模块已经被成功载入
    swagger.png

扩展

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

设计 jrxml 文件

使用 Jaspersoft Studio 图形化设计报表,或使用文本文件

集成 JasperReports 和 JasperReports Font Extension

pom.xml 中新增

<dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports</artifactId>
    <version>6.15.0</version>
</dependency>
<dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports-fonts</artifactId>
    <version>6.15.0</version>
</dependency>

PDF 中文支持

文件列表

jasperreports_extension.properties

src/main/resources 下新建文件

net.sf.jasperreports.awt.ignore.missing.font=true
net.sf.jasperreports.extension.registry.factory.simple.font.families=net.sf.jasperreports.engine.fonts.SimpleFontExtensionsRegistryFactory
net.sf.jasperreports.extension.simple.font.families.dejavu=fonts/fonts.xml

fonts.xml

src/main/resources/fonts 目录下新建

<?xml version="1.0" encoding="UTF-8"?>
<fontFamilies>
    <fontFamily name="宋体">
        <normal><![CDATA[fonts/simsun.ttf]]></normal>
        <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
        <exportFonts/>
    </fontFamily>
</fontFamilies>

simsun.ttf

从Windows电脑拷贝文件到 src/main/resources/fonts 下

修改 /usr/share/thingsboard/conf/thingsboard.yml, 将 false 改成 true;

# Enable/disable SSL support
enabled: "${SSL_ENABLED:true}"

新建 /usr/share/thingsboard/conf/keystore 目录,且此目录下,增加自己的证书 keystore.p12,并授权 thingsboard 用户和组,命令行输入

mkdir /usr/share/thingsboard/conf/keystore 

keytool -genkey -alias tomcat \
-keystore keystore.p12 \
-storetype PKCS12 \
-keyalg RSA \
-validity 730 \
-keysize 2048

chown -R thingsboard:thingsboard /usr/share/thingsboard/conf/keystore

重启 thingsboard 即可

systemctl restart thingsboard

Chrome 下,无法访问自己制作的证书网站,方法在此

关于 Chrome 无法打开自定义的网站证书网站方法