SDN開放性增強Eclipse編程插件操作手冊

1、SDN開放性增強Eclipse編程插件操作手冊目 錄1總體說明71.1軟件要求71.2范圍71.3發(fā)布目錄結(jié)構(gòu)92安裝向?qū)?12.1Eclipse安裝要求112.2安裝Java編程環(huán)境113使用指南203.1創(chuàng)建SdnDev-java工程203.2修改SdnDev-Java工程屬性273.2.1修改內(nèi)置的模型存儲路徑283.2.2增加外置的模型文件(schema, yang, uml)283.3創(chuàng)建Restful Api代碼293.4Request Body生成器353.5網(wǎng)絡(luò)監(jiān)視器423.6數(shù)據(jù)源管理473.7Welcome-SdnDev歡迎界面553.8查看SdnDev幫助系統(tǒng)573.9創(chuàng)

2、建ops driver文件593.10使用Restclient聯(lián)調(diào)功能643.10.1打開Restclient643.10.2用戶名與密碼認(rèn)證683.10.3向?qū)蒖est Request703.10.4Rest請求并回顯結(jié)果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編程開發(fā)者的北向Rest編程開發(fā)環(huán)境, 快速熟悉華為SDN控制器北向接口調(diào)用, 快速構(gòu)建屬于自己的SDN APP應(yīng)用程序。 當(dāng)前版本支持JAVA, PYTHON語言。主要功能: 1. 可視化的IDE編程環(huán)境，支持java編程環(huán)境 。2. 進行OPS數(shù)據(jù)源管理主要完成對數(shù)據(jù)源的添加，修改，刪除，配置相關(guān)數(shù)據(jù)源。3. 進行數(shù)據(jù)接口加載。對數(shù)據(jù)接口進行配置加載。4. 提供網(wǎng)絡(luò)監(jiān)視器：提供對OPS中涉及網(wǎng)絡(luò)訪問的監(jiān)視功能。5. Java IDE輔助編程提示：主要完成對java編輯，可視，調(diào)試，編譯的功能的相關(guān)提示。6. 由ops規(guī)格schema文件，自動生成restfulApi文檔。主要完

4、成接口代碼的生成功能。7. 提供對api路徑編程提示功能。8. 提供向?qū)缴蒓PS Driver（包括控制器的北向適配）。9. IDE與RouterVisio集成的界面，可展示sandbox的拓?fù)浣缑妗?0. 提供Welcome界面，并可以彈出新建工程界面, 集成API文檔，給客戶編程以在線即時幫助11. 提供YANG模型解析與轉(zhuǎn)換功能12. 集成Restclient客戶端，在用戶編程的同時，可以調(diào)用restclient客戶端進行聯(lián)調(diào)與測試13. 增加eclipse console顯示報錯信息，可通過eclipse目錄下面的SdnDev.log來查看日志。注意：1. yang 模型解析使用O

5、DL的JAR包，解析某個YANG文件時，會加載當(dāng)前目錄下面的所有的.yang文件，如果發(fā)現(xiàn)錯誤，會中斷yang的解析。請保證yang模型的正確性。2. 需要eclipse 3.7.1以上的版本, java運行環(huán)境需要JDK 1.7以上。內(nèi)存2G以上3. Eclipse插件依賴列表，請?zhí)崆鞍惭b，否則依賴不滿足，無法安裝對應(yīng)的編程環(huán)境JAVA環(huán)境依賴于eclipse的java插件python環(huán)境依賴于pydev插件。1.3 發(fā)布目錄結(jié)構(gòu)SdnDev插件發(fā)布目錄結(jié)構(gòu)：-|-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 安裝向?qū)?.1 Eclipse安裝要求下載安裝Eclipse開發(fā)環(huán)境 ，推薦版本3.7.1， 可選擇大于3.7.1版本以上。2.2 安裝Java編程環(huán)境1. 從華為官網(wǎng)或者發(fā)布目錄中獲取SdnDev的本地安裝包2. 打開eclipse開發(fā)環(huán)境，開

8、始安裝插件3. 在eclipse菜單欄選擇HelpInstall New Software，出現(xiàn)如下圖界面。（圖表1）圖表 14. 點擊Install New Software，出現(xiàn)如下圖界面。（圖表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編程環(huán)境支持，依賴于eclipse 內(nèi)置的java插件，選擇安裝C. SdnDev pytho

10、n for EclipsePython 編程環(huán)境支持, 依賴于第三方的pydev插件, 選擇安裝 7. 進入安裝信息界面。點擊Next進入下一步圖表 3圖表 48. 如上圖所示，選擇紅色框，同意許可，點擊Finish完成。9. 點擊完成后，出現(xiàn)警告框，點擊OK鍵，繼續(xù)。圖表 510. 安裝完成后，提示Eclipse需要重啟。選擇Yes圖表 611. 接下來驗證插件是否完成安裝1) 重新啟動Eclipse后，選擇工作路徑圖表 72) 打開Eclipse，在菜單欄中選擇FileNew-Other如圖所示。(圖表8)圖表 8 3) 如果出現(xiàn)了SdnDev選項，說明安裝成功。圖表 9 SdnDev界面

11、安裝過程如果不出現(xiàn)錯誤，恭喜你插件已安裝完成！ 如果出現(xiàn)錯誤，一般是插件依賴的父插件不存在，或者eclipse版本低引起的。3 使用指南3.1 創(chuàng)建SdnDev-java工程Java編程環(huán)境支持需要新建一個java工程， 本節(jié)講述創(chuàng)建過程:1.新打開Eclipse，選擇FileNewOther。（圖表10）圖表 10 2.點擊Other后，選擇SdnDev Project for Java，點擊Next（圖表11）圖表 11創(chuàng)建SdnDev-java Project3. 設(shè)置SdnDev-Java Project項目，按向?qū)нM行選擇設(shè)置（圖表12）圖表 12 SdnDev-java Proje

12、ct 工程 Project Name：工程名Use Default location：默認(rèn)工程路徑。JRE：選擇JRE1.6圖表 133、默認(rèn)的SdnDev-java工程路徑配置。（圖表14）圖表 144、選擇SdnDev-java工程模板, 或者直接點擊Finish（圖表15）圖表 155、在SdnDev-java視圖中創(chuàng)建工程，具有相應(yīng)的工程結(jié)構(gòu)。（圖表16）圖表 166.圖表（16）為新建的工程。目錄結(jié)構(gòu)由工程主目錄ja01，src、file和lib三個文件夾組成。HandleInfoService.java: 配置OPS數(shù)據(jù)源相關(guān)信息。Mainfunction.java：Mainfun

13、ction.java文件。OpsRestCaller.java: 訪問OPS客戶端類。OpsServiceConfig.java: 配置OPS連接信息。OpsServiceManager.java: OPS訪問相關(guān)服務(wù)類。OpsServiceConfig.xml: OPS服務(wù)器配置信息。配置相關(guān)URL，端口號等。File：工程所需文件lib：SdnDev-java編輯環(huán)境相關(guān)jar包。3.2 修改SdnDev-Java工程屬性在創(chuàng)建工程基礎(chǔ)上，可以修改當(dāng)前工程的屬性設(shè)置在新建的SdnDev-java工程上右鍵選擇Properties。（圖表17）圖表 173.2.1 修改內(nèi)置的模型存儲路徑 在

14、SdnDev-OPSPATH欄中可以修改ops server、inner schema、user schema文件的路徑。（圖表18）圖表183.2.2 增加外置的模型文件(schema, yang, uml)可以在SdnDev-SchemaFile中添加、刪除用戶自定義的模型文件（schema / yang），并且可以通過Restful Api接口調(diào)用。(圖表19)圖表 193.3 創(chuàng)建Restful Api代碼通過解析華為提供的模型文件(schema/yang)，反向解析生成符合Rest協(xié)議的Rest API代碼。 API代碼包含以下功能函數(shù)：參數(shù)類型匹配檢查；讀寫權(quán)限檢查；參數(shù)范圍約束；

15、類似游標(biāo)遂行數(shù)據(jù)讀?。簧煽蛇\行的main函數(shù)1、在工程的resource包中右擊，選擇NewOther（圖表20）圖表 202、在Java中的SdnDev中選擇Restful Api for Java（圖表21）圖表213、顯示inner和user的schema文件樹。（圖表22）圖表224、選擇列表樹中的模型文件（圖表23）圖表 235、選擇需要生成的報文格式，即可生成JSON或者XML格式的報文。（圖表24）圖表 246、在相應(yīng)的包中生成.java文件。（圖表25）圖表 25上圖（圖表25）為新建的工程。目錄結(jié)構(gòu)由工程主目錄ja01，src中由service,main和util三個包組成

16、。StaticrtSroute.java：工程自動生成的示例模板。3.4 Request Body生成器 Restful 包含以下三個部分，URL, METHOD, BODY, 本節(jié)將使用向?qū)лo助生成Request body相關(guān)的代碼。向?qū)降腷ody代碼生成器具有以下功能：1）參數(shù)取值范圍的自動檢查與提示；2）提供body, url, method等多種代碼表現(xiàn)形式1、在代碼的適當(dāng)位置右擊，選擇Add Post Body菜單。（圖表26）圖表 262、顯示inner和user的schema文件樹。（圖表27）圖表 273、在文件樹中選擇schema文件。（圖表28）圖表 284、填寫必填的參

17、數(shù)*號為必填參數(shù)。（圖表29）圖表295、選擇body則生成String格式的報文，String中顯示的是json形式.（圖表30）圖表 306、選擇method則生成body格式的報文（圖表31）圖表31圖表 32紅框部分為生成的Body體（圖表32）3.5 網(wǎng)絡(luò)監(jiān)視器通過http/https代理，將正常的Rest請求，重定向到eclipse的SdnDev插件內(nèi)部，以完成REST請求與響應(yīng)的數(shù)據(jù)分析與匯總。網(wǎng)絡(luò)監(jiān)視器具有以下的功能：1）、時時監(jiān)控debug與release程序發(fā)出的請求2）、樹狀形式展示中間傳遞的xml請求與回應(yīng)報文1、在Window中選擇Show View（圖表33），和S

18、dnDev-Python類似，在這不作重復(fù)描述。圖表 332、在SdnDev中打開OPS NetworkMonitor（圖表34）圖表34圖表 353、打開網(wǎng)絡(luò)監(jiān)視的開關(guān)，在MonitorConfig中選中對應(yīng)工程的Enable Monitor勾選框，用來選擇該工程是否需要進行監(jiān)聽（打鉤則進行監(jiān)聽，不打鉤則取消監(jiān)聽）（圖表36）圖表364、打開監(jiān)視器開關(guān)，并且勾選上該工程的Enable Monitor勾選框，則會在OpsRestCaller.java文件中會打開服務(wù)器的監(jiān)聽端口。（圖表37）圖表 375、在SystemSystemInfo.java文件中右擊，選擇Run As Java App

19、lication運行。（圖表38）圖表386、可以在監(jiān)視器視圖中的Response中監(jiān)視Restful Api文件運行情況，顯示基本的請求統(tǒng)計數(shù)據(jù)，獲取相關(guān)URL、發(fā)送的請求和響應(yīng)的次數(shù)、請求方式等信息。（圖表39）圖表 393.6 數(shù)據(jù)源管理新建JAVA工程的操作來源于控制器北向接口，設(shè)備北向接口等。而這些都由OPS提供開放平臺，這里就對插件的數(shù)據(jù)源進行管理，提供增加控制器，設(shè)備等能力, 具有以下的功能：1) 注冊并管理多個Rest訪問 2) 提供對配置的數(shù)據(jù)源進行在線測試能力, 對Request與Response進行可視化展示3) 提供web client，直接提供對指定數(shù)據(jù)源的訪問代碼,

20、可嵌入到任何對象中 1、在OPS Devices中選擇工程，在工程上右擊，選擇Test Configure。(圖表40)圖表 402、點擊Add按鈕（圖表41）圖表 413、填寫處理方法的名稱、請求方法以及返回的信息格式，并且選擇一個schema文件（圖表42）圖表 424、選中添加的方法，點擊Config按鈕，對方法就行配置。（圖表43）圖表 435、選擇body體的屬性參數(shù)。（圖表44）圖表 446、在添加好的方法中右擊，選擇Test。（圖表45）圖表 457、填寫參數(shù)值，點擊Test按鈕。（圖表46）圖表 468、在樹中返回獲取到的信息。（圖表47）圖表 47說明：SdnDev-java

21、工程中對數(shù)據(jù)源的增，刪，改方法和SdnDev-python中的方法一致，在這不做重復(fù)說明。3.7 Welcome-SdnDev歡迎界面1.運行插件工程，右擊工程，Run As ->Eclipse Application。2.選擇主菜單，SdnDev > SdnDev Help ，即可打開Welcome-SdnDev歡迎界面。圖表 48圖表 493.8 查看SdnDev幫助系統(tǒng)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 創(chuàng)建ops driver文件OPS Driver用于擴展OPS2.0的北向功能，此處生成的driver只是一個模板文件，用戶填充功能后，上傳到ops2.0上，加載后，就可以運行，具體見OPS2.0幫助。1.運行插件工程，右擊工程，Run As ->Eclipse Application。2.在工程、工程包、文件夾、或者已打開文件內(nèi)部，右擊鼠標(biāo)，選擇Add Ops Driver ->New Ops Driver。圖表 523.選擇文

23、件保存路徑，和文件名。圖表 534.單擊選擇生成文件的模板。圖表 545.選擇附加功能，單擊完成。圖表 553.10 使用Restclient聯(lián)調(diào)功能3.10.1 打開Restclient1、運行插件工程。2、選擇主菜單，SdnDev > Restclient, 或者點擊圖標(biāo)，即可打開Restclient界面。圖表 563、打開后所示界面。圖表 573.10.2 用戶名與密碼認(rèn)證1、 打開Authentication鏈接圖表 582、 輸入用戶名和密碼后點擊【OK】。圖表 59 3.10.3 向?qū)蒖est RequestRest主要由四部分組成， URL, METHOD, BODY,

24、 Header組成，向?qū)еС稚蒑ethod, Url, Body，以下的基礎(chǔ)Rest描述。對REST支持方法有：GET、PUT、POST和DELETE四種，這四種操作對應(yīng)如下所示：方法說明GET查詢操作，查詢指定的管理對象, 可帶內(nèi)容過濾PUT修改操作，修改指定的管理對象POST創(chuàng)建操作，創(chuàng)建指定的管理對象，并可實現(xiàn)類似netconf的action能力DELETE刪除操作，刪除指定的管理對象1) 控制器的設(shè)備管理接口：http:/serverIp:port/devices通過管理接口進行當(dāng)前設(shè)備查看，增加，修改，與刪除操作。管理接口僅支持Json格式的報文。 serverIp：控制器對外服務(wù)

25、IP地址。port：服務(wù)端口號2) Rest API的URL組成: http:/serverIp:port/devices/deviceId/API_PATHserverIp：控制器對外服務(wù)IP地址。port：服務(wù)端口號deviceId：為方便訪問，控制器會給所管理的設(shè)備進行ID編號，通過設(shè)備編號，可以訪問指定的設(shè)備。API_PATH: 華為控制器對外提供的北向REST管理對象。各管理對象使用URI來標(biāo)識。對象標(biāo)識索引KEY需要在URL上體現(xiàn)。如查詢接口名稱/ifm/interfaces/interface?ifName=NULL, 如果是多級對象標(biāo)識索引查詢, 請使用嵌套的查詢/serviceflow/serviceflowInstances/serviceflowInstance?id=groupid/flows/flow?flowId=UDPService3) Rest API支持采用XML/JSON格式的Body