opendaylight hello solium-sr2

截止目前2021年8月，opendaylight已经发布了氢hydrogen版本、硅silicon版本等10多个版本。氖neon版本之前，ODL的java版本为8系列，氖neon版本之后为java11版本。考虑到java的版权问题，考虑使用java8版本。

hello project

参考教程Developing Apps on the OpenDaylight controller

第一部分获取项目框架

1.首先将https://github.com/opendaylight/odlparent/setting.xml文件拷贝到本地maven仓库目录下。

2.项目框架生成命令，1.1.3为neon-sr3版本(真实是1.2.2版本，solium-sr2版本（java-8))

mvn archetype:generate -DarchetypeGroupId=org.opendaylight.archetypes -DarchetypeArtifactId=opendaylight-startup-archetype -DarchetypeCatalog=remote -DarchetypeVersion=1.1.3

3.输入项目坐标属性

Define value for property 'groupId': : org.opendaylight.hello
Define value for property 'artifactId': : hello
Define value for property 'version':  1.0-SNAPSHOT: : 1.0.0-SNAPSHOT
Define value for property 'package':  org.opendaylight.hello: :
Define value for property 'classPrefix':
Define value for property 'copyright': : chyi

4.编译

cd hello
mvn clean install -DskipTests  -Dcheckstyle.skip

5.运行

cd karaf\target\assembly\bin
.\karaf.bat

6.使用eclipse导入hello代码（File->import->existing maven project)

添加helloworld rpc API

7.修改文件api/src/main/yang/hello.yang代码如下：

module hello {yang-version 1;namespace "urn:opendaylight:params:xml:ns:yang:hello";prefix "hello";revision "2015-01-05" {description "Initial revision of hello model";}//add snippetrpc hello-world {input {leaf name {type string;}}output {leaf greeting {type string;}}}//add end
}

在hello/api目录下使用命令mvn clean install -DskipTests -Dcheckstyle.skip编译，odl会基于这个yang文件生成相应的接口函数，下面实现接口函数

8.在目录impl/src/main/java/org/opendaylight/hello/impl/下创建文件HelloWorldImpl.java，内容如下：

package org.opendaylight.hello.impl;import com.google.common.util.concurrent.ListenableFuture;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev180517.HelloService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev180517.HelloWorldInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev180517.HelloWorldOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev150105.HelloWorldOutputBuilder;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.opendaylight.yangtools.yang.common.RpcResultBuilder;public class HelloWorldImpl implements HelloService {@Overridepublic ListenableFuture<RpcResult<HelloWorldOutput>> helloWorld(HelloWorldInput input) {HelloWorldOutputBuilder helloBuilder = new HelloWorldOutputBuilder();helloBuilder.setGreeting("Hello " + input.getName());return RpcResultBuilder.success(helloBuilder.build()).buildFuture();}
}

9.在目录impl/src/main/java/org/opendaylight/hello/修改文件HelloProvider.java内容如下：

/** Copyright © 2018 chyi and others.  All rights reserved.** This program and the accompanying materials are made available under the* terms of the Eclipse Public License v1.0 which accompanies this distribution,* and is available at http://www.eclipse.org/legal/epl-v10.html*/
package org.opendaylight.hello.impl;import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.binding.api.RpcProviderService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev180517.HelloService;
import org.opendaylight.yangtools.concepts.ObjectRegistration;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class HelloProvider {private static final Logger LOG = LoggerFactory.getLogger(HelloProvider.class);private final DataBroker dataBroker;private ObjectRegistration<HelloService> helloService;private RpcProviderService rpcProviderService;public HelloProvider(final DataBroker dataBroker, final RpcProviderService rpcProviderService) {this.dataBroker = dataBroker;this.rpcProviderService = rpcProviderService;}/*** Method called when the blueprint container is created.*/public void init() {LOG.info("HelloProvider Session Initiated");helloService = rpcProviderService.registerRpcImplementation(HelloService.class, new HelloWorldImpl());}/*** Method called when the blueprint container is destroyed.*/public void close() {LOG.info("HelloProvider Closed");if (helloService != null) {helloService.close();}}
}

10.在hello/impl目录下使用命令mvn clean install -DskipTests -Dcheckstyle.skip编译impl，再在hello目录下使用同样的命令编译整个工程。

11.编译成功后，运行程序

cd hello\karaf\target\assembly\bin
.\karaf.bat

第三部分测试与解决问题

12.使用postman(chrome浏览器)下发http://localhost:8181/restconf/operations/hello:hello-world下发rpc请求，内容为{"input":{"name":"lalala"}},但是返回失败。

13.使用命令log:dispaly|grep --ignore-case hello查询到当前运行错误Unable to find a matching constructor on class org.opendaylight.hello.impl.HelloProvider。

通过查找到资料Opendaylight Hello World RPC throw “Unable to find a matching constructor” error以及，Missing Dependency for OpenDaylight controller app (Sodium SR1)，分析得知，错误是由于没有修改blueprint.xml文件导致无法注册helloprovider新的构造函数导致的。

修改\impl\src\main\resources\OSGI-INF\blueprint.xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- vi: set et smarttab sw=4 tabstop=4: -->
<!--
Copyright © 2018 chyi and others. All rights reserved.This program and the accompanying materials are made available under the
terms of the Eclipse Public License v1.0 which accompanies this distribution,
and is available at http://www.eclipse.org/legal/epl-v10.html
-->
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"xmlns:odl="http://opendaylight.org/xmlns/blueprint/v1.0.0"odl:use-default-for-reference-types="true"><reference id="dataBroker"interface="org.opendaylight.mdsal.binding.api.DataBroker"odl:type="default" /><reference id="RpcProvider"interface="org.opendaylight.mdsal.binding.api.RpcProviderService"odl:type="default" /><bean id="provider"class="org.opendaylight.hello.impl.HelloProvider"init-method="init" destroy-method="close"><argument ref="dataBroker" /><argument ref="RpcProvider" /></bean></blueprint>

这里修改了三个地方，一是dataBroker的interface，将md.sal修改为了mdsal；二是添加了RpcProvider的reference；三是添加了provider的argument RpcProvider。

14.重复步骤10-12，得到的结果如下：