SDN开放性增强Eclipse编程插件操作手册

1、SDN开放性增强Eclipse编程插件操作手册目 录1总体说明71.1软件要求71.2范围71.3发布目录结构92安装向导112.1Eclipse安装要求112.2安装Java编程环境113使用指南203.1创建SdnDev-java工程203.2修改SdnDev-Java工程属性273.2.1修改内置的模型存储路径283.2.2增加外置的模型文件(schema, yang, uml)283.3创建Restful Api代码293.4Request Body生成器353.5网络监视器423.6数据源管理473.7Welcome-SdnDev欢迎界面553.8查看SdnDev帮助系统573.9创

2、建ops driver文件593.10使用Restclient联调功能643.10.1打开Restclient643.10.2用户名与密码认证683.10.3向导生成Rest Request703.10.4Rest请求并回显结果861 总体说明1.1 软件要求软件名称软件版本Microsoft WindowsXP SP2，SER2003及其他兼容EclipseEclipse-sdk-3.7.1版本JRE1.7SdnDevSdnDev for Eclipse 1.0.1 版本重要说明: 插件提供SDNDEV_Java版本供用户使用。 1.2 范围华为SDN开放性增强Eclipse编程插件, 提供

3、给华为SDN编程开发者的北向Rest编程开发环境, 快速熟悉华为SDN控制器北向接口调用, 快速构建属于自己的SDN APP应用程序。 当前版本支持JAVA, PYTHON语言。主要功能: 1. 可视化的IDE编程环境，支持java编程环境 。2. 进行OPS数据源管理主要完成对数据源的添加，修改，删除，配置相关数据源。3. 进行数据接口加载。对数据接口进行配置加载。4. 提供网络监视器：提供对OPS中涉及网络访问的监视功能。5. Java IDE辅助编程提示：主要完成对java编辑，可视，调试，编译的功能的相关提示。6. 由ops规格schema文件，自动生成restfulApi文档。主要完

4、成接口代码的生成功能。7. 提供对api路径编程提示功能。8. 提供向导式生成OPS Driver（包括控制器的北向适配）。9. IDE与RouterVisio集成的界面，可展示sandbox的拓扑界面。10. 提供Welcome界面，并可以弹出新建工程界面, 集成API文档，给客户编程以在线即时帮助11. 提供YANG模型解析与转换功能12. 集成Restclient客户端，在用户编程的同时，可以调用restclient客户端进行联调与测试13. 增加eclipse console显示报错信息，可通过eclipse目录下面的SdnDev.log来查看日志。注意：1. yang 模型解析使用O

5、DL的JAR包，解析某个YANG文件时，会加载当前目录下面的所有的.yang文件，如果发现错误，会中断yang的解析。请保证yang模型的正确性。2. 需要eclipse 3.7.1以上的版本, java运行环境需要JDK 1.7以上。内存2G以上3. Eclipse插件依赖列表，请提前安装，否则依赖不满足，无法安装对应的编程环境JAVA环境依赖于eclipse的java插件python环境依赖于pydev插件。1.3 发布目录结构SdnDev插件发布目录结构：-|-workos.ops.core_015082107262210.jar|-workos.ops.device.no

6、rmal_015082107262210.jar|-workos.ops.device.sandbox_015082107262210.jar |- workos.ops.java_015082107262210.jar|-workos.ops.model.core_015082107262210.jar|-workos.ops.model.schema_015082107262210.jar|- workos.ops.model.uml_015082107262210.jar|-workos.ops.mode

7、l.yang_015082107262210.jar|- workos.ops.python_015082107262210.jar|-workos.ops.tool.restclient_015082107262210.jar|-workos.ops_015082107262210.jar 2 安装向导2.1 Eclipse安装要求下载安装Eclipse开发环境 ，推荐版本3.7.1， 可选择大于3.7.1版本以上。2.2 安装Java编程环境1. 从华为官网或者发布目录中获取SdnDev的本地安装包2. 打开eclipse开发环境，开

8、始安装插件3. 在eclipse菜单栏选择HelpInstall New Software，出现如下图界面。（图表1）图表 14. 点击Install New Software，出现如下图界面。（图表2）图表 25. 将下载的SdnDev本地安装包加入到Work with路径框里。（红色框1）(红色框3) 五个选项不钩选。(红色框3) 解释说明：Show only the latest versions of available software:显示最终版本。Group items by category:插件项目类别总和。Show only software applicable to t

9、arget environment:显示可用的软件。Contact all update sites during install to find required software:安装更新软件。Hide items that are already installed:隐藏项目插件已安装。 6. 再选择需要安装的SdnDev组件，点击Next。A. SdnDev for Eclipse :SdnDev核心组件，包含公共的UI界面, 必选B. SdnDev java for Eclipse Java编程环境支持，依赖于eclipse 内置的java插件，选择安装C. SdnDev pytho

10、n for EclipsePython 编程环境支持, 依赖于第三方的pydev插件, 选择安装 7. 进入安装信息界面。点击Next进入下一步图表 3图表 48. 如上图所示，选择红色框，同意许可，点击Finish完成。9. 点击完成后，出现警告框，点击OK键，继续。图表 510. 安装完成后，提示Eclipse需要重启。选择Yes图表 611. 接下来验证插件是否完成安装1) 重新启动Eclipse后，选择工作路径图表 72) 打开Eclipse，在菜单栏中选择FileNew-Other如图所示。(图表8)图表 8 3) 如果出现了SdnDev选项，说明安装成功。图表 9 SdnDev界面

11、安装过程如果不出现错误，恭喜你插件已安装完成！ 如果出现错误，一般是插件依赖的父插件不存在，或者eclipse版本低引起的。3 使用指南3.1 创建SdnDev-java工程Java编程环境支持需要新建一个java工程， 本节讲述创建过程:1.新打开Eclipse，选择FileNewOther。（图表10）图表 10 2.点击Other后，选择SdnDev Project for Java，点击Next（图表11）图表 11创建SdnDev-java Project3. 设置SdnDev-Java Project项目，按向导进行选择设置（图表12）图表 12 SdnDev-java Proje

12、ct 工程 Project Name：工程名Use Default location：默认工程路径。JRE：选择JRE1.6图表 133、默认的SdnDev-java工程路径配置。（图表14）图表 144、选择SdnDev-java工程模板, 或者直接点击Finish（图表15）图表 155、在SdnDev-java视图中创建工程，具有相应的工程结构。（图表16）图表 166.图表（16）为新建的工程。目录结构由工程主目录ja01，src、file和lib三个文件夹组成。HandleInfoService.java: 配置OPS数据源相关信息。Mainfunction.java：Mainfun

13、ction.java文件。OpsRestCaller.java: 访问OPS客户端类。OpsServiceConfig.java: 配置OPS连接信息。OpsServiceManager.java: OPS访问相关服务类。OpsServiceConfig.xml: OPS服务器配置信息。配置相关URL，端口号等。File：工程所需文件lib：SdnDev-java编辑环境相关jar包。3.2 修改SdnDev-Java工程属性在创建工程基础上，可以修改当前工程的属性设置在新建的SdnDev-java工程上右键选择Properties。（图表17）图表 173.2.1 修改内置的模型存储路径 在

14、SdnDev-OPSPATH栏中可以修改ops server、inner schema、user schema文件的路径。（图表18）图表183.2.2 增加外置的模型文件(schema, yang, uml)可以在SdnDev-SchemaFile中添加、删除用户自定义的模型文件（schema / yang），并且可以通过Restful Api接口调用。(图表19)图表 193.3 创建Restful Api代码通过解析华为提供的模型文件(schema/yang)，反向解析生成符合Rest协议的Rest API代码。 API代码包含以下功能函数：参数类型匹配检查；读写权限检查；参数范围约束；

15、类似游标遂行数据读取；生成可运行的main函数1、在工程的resource包中右击，选择NewOther（图表20）图表 202、在Java中的SdnDev中选择Restful Api for Java（图表21）图表213、显示inner和user的schema文件树。（图表22）图表224、选择列表树中的模型文件（图表23）图表 235、选择需要生成的报文格式，即可生成JSON或者XML格式的报文。（图表24）图表 246、在相应的包中生成.java文件。（图表25）图表 25上图（图表25）为新建的工程。目录结构由工程主目录ja01，src中由service,main和util三个包组成

16、。StaticrtSroute.java：工程自动生成的示例模板。3.4 Request Body生成器 Restful 包含以下三个部分，URL, METHOD, BODY, 本节将使用向导辅助生成Request body相关的代码。向导式的body代码生成器具有以下功能：1）参数取值范围的自动检查与提示；2）提供body, url, method等多种代码表现形式1、在代码的适当位置右击，选择Add Post Body菜单。（图表26）图表 262、显示inner和user的schema文件树。（图表27）图表 273、在文件树中选择schema文件。（图表28）图表 284、填写必填的参

17、数*号为必填参数。（图表29）图表295、选择body则生成String格式的报文，String中显示的是json形式.（图表30）图表 306、选择method则生成body格式的报文（图表31）图表31图表 32红框部分为生成的Body体（图表32）3.5 网络监视器通过http/https代理，将正常的Rest请求，重定向到eclipse的SdnDev插件内部，以完成REST请求与响应的数据分析与汇总。网络监视器具有以下的功能：1）、时时监控debug与release程序发出的请求2）、树状形式展示中间传递的xml请求与回应报文1、在Window中选择Show View（图表33），和S

18、dnDev-Python类似，在这不作重复描述。图表 332、在SdnDev中打开OPS NetworkMonitor（图表34）图表34图表 353、打开网络监视的开关，在MonitorConfig中选中对应工程的Enable Monitor勾选框，用来选择该工程是否需要进行监听（打钩则进行监听，不打钩则取消监听）（图表36）图表364、打开监视器开关，并且勾选上该工程的Enable Monitor勾选框，则会在OpsRestCaller.java文件中会打开服务器的监听端口。（图表37）图表 375、在SystemSystemInfo.java文件中右击，选择Run As Java App

19、lication运行。（图表38）图表386、可以在监视器视图中的Response中监视Restful Api文件运行情况，显示基本的请求统计数据，获取相关URL、发送的请求和响应的次数、请求方式等信息。（图表39）图表 393.6 数据源管理新建JAVA工程的操作来源于控制器北向接口，设备北向接口等。而这些都由OPS提供开放平台，这里就对插件的数据源进行管理，提供增加控制器，设备等能力, 具有以下的功能：1) 注册并管理多个Rest访问 2) 提供对配置的数据源进行在线测试能力, 对Request与Response进行可视化展示3) 提供web client，直接提供对指定数据源的访问代码,

20、可嵌入到任何对象中 1、在OPS Devices中选择工程，在工程上右击，选择Test Configure。(图表40)图表 402、点击Add按钮（图表41）图表 413、填写处理方法的名称、请求方法以及返回的信息格式，并且选择一个schema文件（图表42）图表 424、选中添加的方法，点击Config按钮，对方法就行配置。（图表43）图表 435、选择body体的属性参数。（图表44）图表 446、在添加好的方法中右击，选择Test。（图表45）图表 457、填写参数值，点击Test按钮。（图表46）图表 468、在树中返回获取到的信息。（图表47）图表 47说明：SdnDev-java

21、工程中对数据源的增，删，改方法和SdnDev-python中的方法一致，在这不做重复说明。3.7 Welcome-SdnDev欢迎界面1.运行插件工程，右击工程，Run As ->Eclipse Application。2.选择主菜单，SdnDev > SdnDev Help ，即可打开Welcome-SdnDev欢迎界面。图表 48图表 493.8 查看SdnDev帮助系统1、 运行插件工程，右击工程，Run As ->Eclipse Application。2、按F1建，点击contents，选择SdnDev Help ->SdnDev For Java；图表 50

22、或者选择主菜单Help ->Help contents->SdnDev Help ->SdnDev For Java。图表 513.9 创建ops driver文件OPS Driver用于扩展OPS2.0的北向功能，此处生成的driver只是一个模板文件，用户填充功能后，上传到ops2.0上，加载后，就可以运行，具体见OPS2.0帮助。1.运行插件工程，右击工程，Run As ->Eclipse Application。2.在工程、工程包、文件夹、或者已打开文件内部，右击鼠标，选择Add Ops Driver ->New Ops Driver。图表 523.选择文

23、件保存路径，和文件名。图表 534.单击选择生成文件的模板。图表 545.选择附加功能，单击完成。图表 553.10 使用Restclient联调功能3.10.1 打开Restclient1、运行插件工程。2、选择主菜单，SdnDev > Restclient, 或者点击图标，即可打开Restclient界面。图表 563、打开后所示界面。图表 573.10.2 用户名与密码认证1、 打开Authentication链接图表 582、 输入用户名和密码后点击【OK】。图表 59 3.10.3 向导生成Rest RequestRest主要由四部分组成， URL, METHOD, BODY,

24、 Header组成，向导支持生成Method, Url, Body，以下的基础Rest描述。对REST支持方法有：GET、PUT、POST和DELETE四种，这四种操作对应如下所示：方法说明GET查询操作，查询指定的管理对象, 可带内容过滤PUT修改操作，修改指定的管理对象POST创建操作，创建指定的管理对象，并可实现类似netconf的action能力DELETE删除操作，删除指定的管理对象1) 控制器的设备管理接口：http:/serverIp:port/devices通过管理接口进行当前设备查看，增加，修改，与删除操作。管理接口仅支持Json格式的报文。 serverIp：控制器对外服务

25、IP地址。port：服务端口号2) Rest API的URL组成: http:/serverIp:port/devices/deviceId/API_PATHserverIp：控制器对外服务IP地址。port：服务端口号deviceId：为方便访问，控制器会给所管理的设备进行ID编号，通过设备编号，可以访问指定的设备。API_PATH: 华为控制器对外提供的北向REST管理对象。各管理对象使用URI来标识。对象标识索引KEY需要在URL上体现。如查询接口名称/ifm/interfaces/interface?ifName=NULL, 如果是多级对象标识索引查询, 请使用嵌套的查询/serviceflow/serviceflowInstances/serviceflowInstance?id=groupid/flows/flow?flowId=UDPService3) Rest API支持采用XML/JSON格式的Body