Opentcs 光灵开发手册 (一)

序言：

光会刺痛你的双眼，而黑暗不会，但是我光灵愿意牺牲自己以成就黑暗

1、opentcs系统需求

1.1、系统需求openTCS源代码是用Java编写的。要编译它，我们开发人员需要一个Java开发工具包(JDK) 1.8或更高版本。要运行生成的二进制文件，您需要一个Java运行时环境(JRE) 1.8或更高。所有其他所需的库都包含在openTCS分发版中，或者在从源代码构建时自动下载。

1.2、可用工件和API兼容性

【我们可以联系到maven、gradle相关知识】

openTCS项目通过JCenter发布发布工件，因此我们开发人员可以轻松地将它们与诸如Gradle或Maven之类的构建系统集成。例如，在Gradle构建脚本中，使用下面这样的东西来集成openTCS库：

设置我们实际想要使用的openTCS版本的版本号，并从下表中选择合适的${工件}名称:

表1、由openTCS项目发布的工件

注意，只有基本的API库提供了一个文档化的API，openTCS开发人员试图在小版本之间保持兼容。(对于这些库，应用了语义版本控制规则。)所有其他工件的内容都可以并且将会改变，而不考虑任何兼容性问题，因此如果您使用这些并切换到不同版本的openTCS，我们开发人员可能需要调整和重新编译我们的代码。

1.3、第三方依赖

1.3.1、内核和客户机应用程序（The kernel and the client applications ）依赖于以下外部框架和库：

• SLF4J (https://www.slf4j.org/): 一个简单的日志外观，以保持实际日志实现的可替换性。

• Google Guice (https://github.com/google/guice): 轻量级依赖注入框架

• Cfg4j (http://www.cfg4j.org/): 支持绑定接口的配置库

• Google Guava (https://github.com/google/guava): 细节上，具有帮助性的类和方法的集合。

1.3.2、内核应用程序（The kernel application）还依赖于以下库：

•JGraphT (http://jgrapht.org/):用于处理图形并在其上使用算法的库。

•Spark (http://sparkjava.com/):用于创建web应用程序的框架。

•Jackson (https://github.com/FasterXML/jackson):为Java对象提供JSON绑定。

•JDOM (http://www.jdom.org/):用于读写XML数据的库。

1.3.3、工厂概述应用程序（The plant overview application）有以下附加的依赖：

•JHotDraw (http://www.jhotdraw.org/):绘制图形结构的框架(如车辆行驶课程的模型)。

•对接框架(http://www.docking-frames.org/):一个GUI面板停靠对接和卸载的框架

1.3.4、对于自动测试，使用以下依赖项:

•JUnit (http://junit.org/junit4/):一个简单的单元测试框架。

•JUnitParams (https://pragmatists.github.io/JUnitParams/):为JUnit提供了改进的参数化测试支持。

•Mockito (http://mockito.org/):用于创建模拟对象的框架。

•Hamcrest (http://hamcrest.org/):用于断言匹配器的框架，可用于测试。

在构建应用程序时，会自动下载这些依赖项的构件。

1.4、模块化和可扩展性

openTCS项目严重依赖于Guice进行依赖注入和组件连接，以及提供插件式扩展机制。在注入API中，相关类可以在包org.opentcs. customize中找到。例如，请参见定制和扩展内核应用程序、定制和扩展工厂概览应用程序以及定制和扩展控制中心应用程序。openTCS项目严重依赖于Guice进行依赖注入和组件连接，以及提供插件式扩展机制。在注入API中，相关类可以在包org.opentcs.customizations中找到。例如，请参见定制和扩展内核应用程序（the kernel application）、定制和扩展工厂概览应用程序（ plant overview application ）以及定制和扩展控制中心应用程序（ control center application）。

1.5、日志记录

官方openTCS发行版中的代码使用SLF4J进行日志记录。因此，通过将SLF4J绑定替换到各自应用程序的类路径中，实际的日志实现是很容易互换的。内核和工厂概述客户端应用程序（The kernel and plant overview client applications），在缺省情况下，附带了SLF4J的（java.util.logging）绑定日志记录。有关如何更改实际日志实现的更多信息，例如使用log4j，我们开发人员可以参阅SLF4J文档。

1.6、使用openTCS源代码（重点学会使用）

openTCS项目本身使用Gradle作为它的构建管理工具。要从源代码构建openTCS，只需从源分布的主目录运行gradlew构建。有关如何使用Gradle的详细信息，请参阅其文档。这些是我们开发人员需要知道的根项目的主要级别任务:

1.6.1、构建:编译所有子项目的源代码。

1.6.2、发布:构建并将所有系统组件打包到构建中。

1.6.3、清理:清理其他任务产生的所有东西，要在IDE中使用源代码，请参阅IDE的文档，以进行渐变集成。对于任何特定的IDE，都没有通用的建议。但是请注意，openTCS源代码包含了使用NetBeans GUI构建器创建的GUI组件。如果我们开发人员想要编辑这些，我们可能想要使用NetBeans IDE。如果我们使用NetBeans，请从NetBeans插件门户安装Gradle支持插件。

然后，您应该能够将源分布的根目录作为一个Gradle项目打开，并从NetBeans中编译和运行组件。