OpenDaylight Carbon二次开发实用指南

作者简介:林潇,同济大学SNLab(先进网络与系统联合中心),研三在读。热爱分享,有OpenDaylight开发经验,OpenDaylight ALTO项目contributor。

通过本文你将知道:

  1. Maven Archetype的基本原理以及如何使用Maven Archetype生成适用于不同版本的ODL子项目。
  2. 本文将着重讲解cli命令开发,以及Carbon Release中新引入的Blueprint的一些基本知识。OpenDaylight Carbon Release中模块运行的大致流程以及对于api和impl的开发可以参考ODL碳版本模块开发及流程梳理还有ODL controller官方开发指南(它对DataStore的描述相当不错)。
  3. 如何将编写好的应用添加到一个正在运行的OpenDaylight控制器中。

Maven Archetype的原理与其在OpenDaylight中的应用

Archetype[1]是一个Maven项目模板的工具。它提供了一种快速生成一致的Maven项目的方法。事实上OpenDaylight的Archetype存储在controller项目中。大家可以从github或者git.opendaylight.org中访问controller项目,并找到Archetype对应的位置。在作者编写本篇教程时,使用下述URI下载的Archetype源码(建议使用git clone下载该源码,方便后面使用git checkout切换源码版本)。

让我们看看Archetype的源文件,它与普通的文件并无很大区别,但它包含${package}、${classPrefix}等一些可被替换的参数。这些参数可以在用户利用Archetype生成自己的项目,使用mvn archetype:generate命令时被指定。

对于开发过之前版本的OpenDaylight用户而言,这些函数应该很眼熟,只不过原来的onSessionInitiated()变成init()。Carbon Release中使用Blueprint作为依赖注入Dependency Injection框架,关于Blueprint的细节详见第二章。

:Maven仓库[2]分为本地仓库远端仓库。之前的很多教程是直接从OpenDaylight Maven远端仓库(往往是一个通过一个URI指定)上拉取Archetype的artifact(Maven仓库里的货物可以被称为artifact或者project)然后生成自己的项目架构。但这个URI可能在作者撰写教程的时候存在,当OpenDaylight有了新的小版本更新后这个URI就失效了。因此本教程将说明如何利用OpenDaylight Archetype源码以及Maven本地仓库,生成任意版本的OpenDaylight子项目

既然有仓库,那么里面一定有货物(project或者叫做artifact),而且有不止一件货物。为了区分货物,每件货物都需要有自己的ID。而这个ID由groupId、artifactId、version构成

这些属性在命令mvn archetype:generate中用来指定即将要生成的项目是依赖于哪个Archetype的artifact。

为了使用Archectype,需要先将Archetype安装(maven install)到本地Maven仓库(在Ubuntu或者macOS下默认的本地Maven仓库路径为~/.m2)。具体操作如下:

1. 将Archetype的源码编译安装到本地仓库(在本地仓库生成了一个该Archetype对应的artifact),以下命令运行在控制台(Terminal)。

:其他版本格式均为”release/大版本号-小版本号”或者”release/大版本号”,大版本号为某一个元素全拼,小版本号为sr1、sr2等等。

2. 使用mvn archetype:generate命令,从本地仓库中获取安装过的Archetype的artifact,生成自己所需的子项目。以下命令运行在控制台(Terminal)。其中带有Darchetype的行代表即将生成的项目依赖于哪些已经存在仓库的Archetype的artifact,该信息可以在上文执行mvn clean install的目录下的pom.xml文件中得到。DgroupId和DartifactId是即将生成的项目的groupId和artifactId。关于groupId、artifactId和version的命名规范请见[3]。version可以不填写,默认的version为0.1.0-SNAPSHOT。

注:前面的空格不要漏掉!

3. 观察与编译依照OpenDaylight Carbon SR1 startup模板生成的项目helloworld

至此,你应该了解Maven Archtype生成的原理以及如何生成任意OpenDaylight版本的子项目。

Opendaylight Carbon release cli开发以及Blueprint基础知识介绍

OpenDaylight Carbon release的利用Archetype作为模板生成后的项目结构如下:

cli目录是Carbon版本里新出现的目录,它用于方便快捷地开发Karaf cli命令。它包含api、commands和impl三个子目录。api中主要是定义Karaf命令方法签名和Javadoc。在impl中,我们可以利用Java Annotation快速的定义了命令的格式,快速获得命令解析功能,以及实现相应命令对应的输出。具体而言,cli子模块的目录结构如下:

逐个查看各个java文件。
HelloworldCliCommands.java中定义了一个我们想要实现的接口方法。

HelloworldCliTestCommand.java中定义了这个命令的格式,以及对应输出应该如何处理。例如本示例中定义了一个command,它以”test-command”开头,并且接受-tA的参数(在Karaf控制台中使用这个command的例子opendaylight-user@root> test-command -tA 123)。参考文献[6]中给出了更加详细的介绍。

HelloworldCliCommandsImpl继承了HelloworldCliCommands,并实现了testCommand方法。

上面列出了代码实现的部分,下面将介绍这个模块是如何被加载的。这与helloworld/impl/是一样的,使用Blueprint做Denpendency Injection。

Blueprint是一个为OSGi容器设计的Dependency Injection系统[4, 5]。Karaf包含了Apache Aries Blueprint的实现以及它的基本特色。

当一个bundle包含一个或者多少Blueprint XML文件时,会被认为是Blueprint bundles。这些Blueprint XML位于OSGI-INF/blueprint/目录下。Blueprint使用一个extender bundle来监视其他bundle的状态。一旦extender决定一个bundle是Blueprint bundle,它就为这个bundle创建一个Blueprint Container。

Bluepinrt Container负责以下的事情:

  • 解析Blueprint XML文件
  • 初始化组件
  • 将组件连接在一起
  • 注册services
  • 查找service reference

Blueprint的配置文件会被用来创建命令并将其注册到OSGi注册表中,这使得命令可以用于Karaf的控制台。cli模块的Blueprint xml文件位于cli/src/main/resources/下。reference标签让我们的子模块获取到了ODL本身最重要的模块DataBroker,通过它我们能够读写ODL中的DataStore。id为cliCommandsImpl的标签bean,告诉系统cliCommandsImpl这个模块需要从ODL中获取dataBroker。service标签告诉系统cliCommandsImpl这个bean是一个OSGi service。command-bundle标签是cli中相对最重要的,它把Karaf控制台输入的命令,前端处理类HelloworldCliTestCommands,以及对应的后端处理的类cliCommandsImpl联系到一起。

OpenDaylight Karaf目录结构以及向运行中的Karaf载入外部Kar包

OpenDaylight Karaf的目录包含以下几个部分,具体每个部分的配置选项的含义,可以直接进入对应文件夹,查看对应文件的注释部分:

1. 下载OpenDaylight控制器,本例中为Carbon SR1。

2. 解压后,进入./distribution-karaf-0.6.1-Carbon/etc目录,在文件org.ops4j.pax.url.mvn.cfg文件,添加一行:

3. 启动karaf,并在karaf中执行以下命令,将位于helloworld/features/target下的kar包安装到正在运行的OpenDaylight控制器上。

写在最后

我相信乐于分享能够使得大家共同进步!想要了解更多最前沿SDN技术相关的内容(相关论文、相关软件)可以访问我们实验室全体成员共同收集的awesome-sdn列表:https://github.com/snlab-freedom/awesome-sdn 。欢迎各位乐于分享的小伙伴帮助我们共同完善这份列表!

参考文献

[1] https://maven.apache.org/guides/mini/guide-creating-archetypes.html

[2] https://maven.apache.org/guides/introduction/introduction-to-repositories.html

[3] https://maven.apache.org/guides/mini/guide-naming-conventions.html

[4] https://wiki.opendaylight.org/view/Using_Blueprint

[5] http://aries.apache.org/modules/blueprint.html

[6] https://karaf.apache.org/manual/latest-2.x/developers-guide/extending-console.html


  • 本站原创文章仅代表作者观点,不代表SDNLAB立场。所有原创内容版权均属SDNLAB,欢迎大家转发分享。但未经授权,严禁任何媒体(平面媒体、网络媒体、自媒体等)以及微信公众号复制、转载、摘编或以其他方式进行使用,转载须注明来自 SDNLAB并附上本文链接。 本站中所有编译类文章仅用于学习和交流目的,编译工作遵照 CC 协议,如果有侵犯到您权益的地方,请及时联系我们。
  • 本文链接https://www.sdnlab.com/19931.html
分享到:
相关文章
条评论

登录后才可以评论

林潇 发表于17-09-29
2