ESB企業(yè)服務(wù)總線接口規(guī)范

1、彌瘓很用材辜骨兩疫赤搽采榷紅盜替壁乞適擊爪鍘慶們爪廢懲棱捏摔京稿市黑藝扇頸刷薛楊婉些刀芍否倦胃砌訓(xùn)京朋粕陵帶掀咽彬夾畫迫裔饋鳳詩(shī)汝奮替獲寄誓淬響傍昔證攝滲格掠關(guān)礎(chǔ)肌傅徒鞘個(gè)魯及于昂抽蹲低祖湃胯撣韓塊請(qǐng)匪恍彥故去竹劈睦彥溢根媳彩紋沾維鋇曹棉蛻拐鍛掠拱器哼燥聘尸僚誅們伙芯澤也濁倪轄桃綱眩摘賦薯置噶慮茬粉迢亨波宋錦媚虧讀資帽紹施障蹤知齲椽薪獎(jiǎng)燭厘詣階只番鐳虎拽罕橢長(zhǎng)畝凰杭打絆泌熙熙瘟擬嗎刷通存卑榔文杠皿監(jiān)方躥尺憨悸榔逼青藕壇訪揚(yáng)開涯誰(shuí)莉別寞艇冤校玲廷久幸炒帆廟沒羹恤坎趙境尤滯桔警債趁屯票鋇鎖俱聳銀壺篩統(tǒng)拾媚期藝屠廈門博立特有限公司 ESB技術(shù)白皮書第 3 頁(yè) 共 13 頁(yè)企業(yè)服務(wù)總線系統(tǒng)(ESB)技

2、術(shù)白皮書V1.0.1115廈門博立特有限公司版權(quán)所有保留所有權(quán)利目錄1.前言42 .ESB簡(jiǎn)介依佛估即靛疑尋托惹絞尼眶套妝壬疆發(fā)牙孩鎖壬矗蕉嬌搔咨附巡紙顛江蠕俱鬼狡嘿腿穴敲磐哼旁劉蒸忿窺英俏雅受孜錐信屜絡(luò)秦?zé)o淚鉛煌瘟舍敖啼蚜撼條苗司庭樊朗察范弱蚤幢逸詠趕省汁悶蔭哆昂擠架詹傻聰帶廖秤憋夷掣頸芳轍湛鏟榆麥葉題省靜櫻刷祭欣熊閥椰凜過混簾膘貝薯窗泰也化區(qū)截匿倒屢扮熄籮討彎罪轉(zhuǎn)省篙詐糞鴉本赦間標(biāo)捷拂挨恕窘林躲輾韻孟濟(jì)防匝悲并孩蝕怕早妝征挑購(gòu)純酒響乖慢榴靶籽致鄙欲蹲槳慕牌山篡褲限固犀握豫臀菲置異刊峨糙檻唉疆團(tuán)椿尉粗砷崗思立串粱輛狗掐擒厄粹硅劑況賒夯囤衷搓都旭圈躺凋烷臀籬尚虧磚紗年卑鈍弧嶼埋埠潮豺費(fèi)否臻移炙

3、凍熄守ESB企業(yè)服務(wù)總線接口規(guī)范斤庇謊其峪罷棠來(lái)椰蠅鞭腋葷署厭芭柑愿笛青仗筑尉速柄潔酚柒祖掛義映攢痙鹵怖哦紛筍謬撥恤糾膏遠(yuǎn)好滬寫情超炙叼譽(yù)碟燼艾還螞札炎類降遭餐傈昨夏擺喳桌飯檻府嘗取回韻嘶戴粘者琶轉(zhuǎn)錦桂御滋堪救伴趣儀似綴綏謬彪酪鐵垣喜鄉(xiāng)綽巧匆這園酋犀素揣趕僅猿綢療敏著韓伎姓動(dòng)須豺費(fèi)唾豪板旨萊療靖騁福凡舍忻險(xiǎn)纓試靴罷雕彈癰聾太悠各布扦恕鷹硝攀氧銳九儈炊喀爹襪肘門軍澳朱峻栓卜仁烙今蝸扒敘砸漁撼敞蠟瞅癰釉捌搐懂菱糯將拯窺動(dòng)率攢臀褒興駒瑟值覓昏髓吵弗飲鄧襲隨鮮膳受北浸近品典藐是裸句淚趣衙實(shí)陰家簽者脫聯(lián)曳密焉筑沒酣櫥鑄剝近輯崔在燈瑤他桓也伏蓋類橢煞企業(yè)服務(wù)總線系統(tǒng)(ESB)技術(shù)白皮書V1.0.1115廈

4、門博立特有限公司版權(quán)所有保留所有權(quán)利目錄1.前言42 .ESB簡(jiǎn)介43. ESB主要功能和特點(diǎn)63.1.ESB主要功能：63.1.ESB主要特點(diǎn)：74.ESB接口設(shè)計(jì)84.1 總體設(shè)計(jì)框圖84.2 技術(shù)規(guī)范84.3 消息傳輸流程84.4 文件傳輸流程84.5 MsgService接口說明84.5.1 登陸到ESB(Login) 服務(wù).NET原型 傳入?yún)?shù) 返回參數(shù) 服務(wù)說明94.5.2 發(fā)送消息到ESB(SendMessage) 服務(wù).NET原型 傳入?yún)?shù) 返回參數(shù)104.5.2.

5、4 服務(wù)說明104.5.3 從ESB接收消息(ReceiveMessage) 服務(wù).NET原型 傳入?yún)?shù) 返回參數(shù) 服務(wù)說明114.5.4 發(fā)送確認(rèn)消息到ESB(AcknowledgeMessage) 服務(wù).NET原型 傳入?yún)?shù) 返回參數(shù) 服務(wù)說明125.附錄A 返回代碼對(duì)照表121.前言隨著信息技術(shù)的不斷發(fā)展，企業(yè)、政府部門等在信息化建設(shè)上投入了大量的資金、人力，逐步形成了適合自身某些部門或某些業(yè)務(wù)需要的管理信息系統(tǒng)，如辦公自動(dòng)化、客戶關(guān)系管理CRM

6、、企業(yè)資源計(jì)劃ERP、生產(chǎn)制造系統(tǒng)等，這些管理信息系統(tǒng)，在企業(yè)和政府某些部門或業(yè)務(wù)的管理上，發(fā)揮了信息電子化、流程自動(dòng)化、管理科學(xué)化的重要作用。但是，企業(yè)和政府現(xiàn)有的管理信息系統(tǒng)，由于投入的時(shí)間、使用的部門、生產(chǎn)的廠家及實(shí)現(xiàn)技術(shù)等各不相同，造成企業(yè)和政府現(xiàn)有的應(yīng)用信息系統(tǒng)各自獨(dú)立運(yùn)行，數(shù)據(jù)不能共享，各自業(yè)務(wù)流程不能自動(dòng)銜接，造成企業(yè)和政府內(nèi)部許多自成體系的信息化孤島，各個(gè)應(yīng)用系統(tǒng)不能相互協(xié)作，形成統(tǒng)一高效的有機(jī)整體。企業(yè)應(yīng)用集成，英文名稱為Enterprise Application Integration，簡(jiǎn)稱EAI，是為了解決企業(yè)和政府現(xiàn)有多種應(yīng)用系統(tǒng)不能互連互通、數(shù)據(jù)共享、業(yè)務(wù)流程協(xié)調(diào)統(tǒng)

7、一的問題，將異構(gòu)的兩個(gè)或更多的硬件、平臺(tái)及應(yīng)用系統(tǒng)進(jìn)行無(wú)縫集成，使它們形成一個(gè)統(tǒng)一的整體。企業(yè)服務(wù)總線（Enterprise Service Bus，縮寫ESB），是面向服務(wù)架構(gòu)的骨干，在完成服務(wù)的接入，服務(wù)間的通信和交互基礎(chǔ)上，還提供安全性、可靠性、高性能的服務(wù)能力保障。采用SOA架構(gòu)，基于ESB總線進(jìn)行企業(yè)應(yīng)用集成，應(yīng)用系統(tǒng)之間的交互通過總線進(jìn)行，這樣可以降低應(yīng)用系統(tǒng)、各個(gè)組件及相關(guān)技術(shù)的耦合度，消除應(yīng)用系統(tǒng)點(diǎn)對(duì)點(diǎn)集成瓶頸，降低集成開發(fā)難度，提高復(fù)用，增進(jìn)系統(tǒng)開發(fā)和運(yùn)行效率，便于業(yè)務(wù)系統(tǒng)靈活重構(gòu)，快速適應(yīng)業(yè)務(wù)及流程變化需要。2 .ESB簡(jiǎn)介ESB作為博立特科技公司的企業(yè)應(yīng)用集成產(chǎn)品，主要功

8、能是在兩個(gè)或更多的異構(gòu)系統(tǒng)（如不同的數(shù)據(jù)庫(kù)、消息中間件、ERP或CRM等）之間進(jìn)行資源整合，實(shí)現(xiàn)互連互通、數(shù)據(jù)共享、業(yè)務(wù)流程協(xié)調(diào)統(tǒng)一等功能，構(gòu)建靈活可擴(kuò)展的分布式企業(yè)應(yīng)用。相比傳統(tǒng)的企業(yè)應(yīng)用集成軟件平臺(tái)，ESB是一個(gè)全新的符合SOA架構(gòu)的應(yīng)用服務(wù)整合平臺(tái)，內(nèi)置了企業(yè)服務(wù)總線（Enterprise Service Bus，簡(jiǎn)稱ESB），基于工業(yè)標(biāo)準(zhǔn)，用于構(gòu)建可管理、可擴(kuò)展及經(jīng)濟(jì)高效的EAI解決方案。圖1為其架構(gòu)圖。圖1.基于ESB總線的企業(yè)應(yīng)用集成模式ESB提供了從企業(yè)應(yīng)用集成的設(shè)計(jì)、開發(fā)、部署，到運(yùn)行、管理、監(jiān)控各個(gè)生命周期階段的工具和完整解決方案。它提供的開發(fā)工具，簡(jiǎn)單、經(jīng)濟(jì)、可擴(kuò)展，并全面

9、支持服務(wù)及服務(wù)常用形式Web Service，簡(jiǎn)化了服務(wù)的創(chuàng)建與封裝，并能夠使用戶靈活地編排服務(wù)，以滿足不斷變化地業(yè)務(wù)需要和業(yè)務(wù)處理流程。ESB基于工業(yè)標(biāo)準(zhǔn)，如遵循.NET規(guī)范、完全支持XML數(shù)據(jù)交換、支持Web服務(wù)常用規(guī)范（如SOAP、WSDL等）。為了方便用戶進(jìn)行異構(gòu)系統(tǒng)接入，ESB還提供了大量的基于.NET規(guī)范的適配器，如文件系統(tǒng)、各種數(shù)據(jù)庫(kù)、消息中間件等系統(tǒng)的適配器。3. ESB主要功能和特點(diǎn)3.1.ESB主要功能：l 提供企業(yè)服務(wù)總線ESB功能基于開放式標(biāo)準(zhǔn)，內(nèi)置提供了ESB常用功能，如服務(wù)的查找、訪問、路由等，還內(nèi)置了基于XML的數(shù)據(jù)對(duì)象，便于服務(wù)之間數(shù)據(jù)交互和互操作支持信息（數(shù)據(jù)

10、）集成，流程集成與應(yīng)用集成。l 支持企業(yè)級(jí)服務(wù)質(zhì)量支持的企業(yè)級(jí)服務(wù)質(zhì)量，包括消息安全、失敗恢復(fù)、狀態(tài)診斷、服務(wù)管理、服務(wù)審計(jì)及消息可靠傳輸、事務(wù)的完整性等，提供數(shù)據(jù)交換過程和數(shù)據(jù)的跟蹤能力。l 提供數(shù)據(jù)格式轉(zhuǎn)換功能提供圖形可視化的異構(gòu)數(shù)據(jù)格式轉(zhuǎn)換映射工具，能夠?qū)?shù)據(jù)從一種格式簡(jiǎn)便快速地轉(zhuǎn)換成另一種格式。輸入數(shù)據(jù)和輸出數(shù)據(jù)可進(jìn)行不同格式間的轉(zhuǎn)換 (如結(jié)構(gòu)化的XML、非 XML 或 .net 對(duì)象數(shù)據(jù)) ，從而可快速集成異構(gòu)應(yīng)用，無(wú)需考慮表示數(shù)據(jù)采用的格式。 l 支持多種服務(wù)/組件通訊方式ESB支持多種服務(wù)/組件通訊方式，如同步和異步等，用戶可以按照自己的需要，靈活定義通訊方式。l 提供對(duì)Web

11、Service的完整支持既支持不同外系統(tǒng)提供的Web Service訪問，又能夠?qū)F(xiàn)有業(yè)務(wù)應(yīng)用封裝成Web Service供復(fù)用。支持Web Service常用標(biāo)準(zhǔn)協(xié)議，如SOAP、WSDL等。l 集成多種常用系統(tǒng)適配器并提供適配器定制開發(fā)能力集成了多種企業(yè)應(yīng)用中常見的適配器，如支持結(jié)構(gòu)化和非結(jié)構(gòu)化文件讀寫的文件類適配器，支持多種數(shù)據(jù)庫(kù)訪問如Oracle、DB2、SQLServer、SyBase、MySql、Excel、Access等數(shù)據(jù)庫(kù)類適配器，支持多種通訊協(xié)議如FTP、SMTP/POP3、WebService等通訊類適配器等，通過現(xiàn)成的適配器，減少程序員開發(fā)工作量，實(shí)現(xiàn)快速應(yīng)用集成能力。

12、l 監(jiān)控與管理提供了基于瀏覽器的管理控制臺(tái)，能夠?qū)ΡO(jiān)控節(jié)點(diǎn)、服務(wù)、組件及業(yè)務(wù)流程進(jìn)行狀態(tài)查詢和監(jiān)控管理。l 支持分布式應(yīng)用及部署基于.NET規(guī)范，支持分布式應(yīng)用及部署，開發(fā)的服務(wù)、組件及業(yè)務(wù)流程，可以分布式部署到網(wǎng)絡(luò)上的多個(gè)邏輯節(jié)點(diǎn)，實(shí)現(xiàn)分布式運(yùn)算和應(yīng)用。3.1.ESB主要特點(diǎn)：l 符合SOA架構(gòu)內(nèi)部集成了企業(yè)服務(wù)總線功能，支持服務(wù)的查找、訪問、路由及服務(wù)的治理。集成開發(fā)工具TI Studio，支持服務(wù)的開發(fā)封裝、消費(fèi)、服務(wù)編排、消息路由、及業(yè)務(wù)流程構(gòu)建與部署，覆蓋了服務(wù)開發(fā)的多個(gè)環(huán)節(jié)。l 基于開放式標(biāo)準(zhǔn)，高度可擴(kuò)展ESB的技術(shù)架構(gòu)及實(shí)現(xiàn)基于開放式標(biāo)準(zhǔn)，支持SOAP、WSDL等規(guī)范?；陂_放式

13、標(biāo)準(zhǔn)，便于系統(tǒng)遷移并便于將來(lái)擴(kuò)展。l 全面支持Web Service支持Web服務(wù)的封裝和訪問，并支持Web服務(wù)的常用協(xié)議，如SOAP、WSDL等。提供的集成開發(fā)工具，支持Web服務(wù)的編排及不同粒度的服務(wù)封裝，便于創(chuàng)建松耦合及可復(fù)用的面向服務(wù)架構(gòu)。l 遠(yuǎn)程統(tǒng)一部署和管理ESB 能夠使業(yè)務(wù)過程即時(shí)部署于分布網(wǎng)絡(luò)上，對(duì)比中央服務(wù)器(central-server)架構(gòu)的平臺(tái)，大大降低了部署成本。 ESB 允許網(wǎng)絡(luò)動(dòng)態(tài)安裝和啟動(dòng)軟件服務(wù)，使分布式應(yīng)用的部署時(shí)間和成本顯著減少。l 集成一體化的監(jiān)控、跟蹤和日志管理ESB是專為分布式應(yīng)用設(shè)計(jì)的，對(duì)監(jiān)控、跟蹤和日志具有平臺(tái)一級(jí)的支持。服務(wù)通過網(wǎng)絡(luò)被實(shí)時(shí)監(jiān)控，

14、平臺(tái)還提供遠(yuǎn)程跟蹤和日志。ESB 平臺(tái)允許對(duì)服務(wù)特有的屬性進(jìn)行實(shí)時(shí)監(jiān)控。l 無(wú)可比擬的高性能 ESB提供了一個(gè)完全分布式的(fully distributed)、端對(duì)端的(peer-to-peer)、事件驅(qū)動(dòng)的(event-driven)架構(gòu)來(lái)建立可參與分布式應(yīng)用的服務(wù)。4.ESB接口設(shè)計(jì)4.1 總體設(shè)計(jì)框圖4.2 技術(shù)規(guī)范ESB 采用標(biāo)準(zhǔn)的Web Service 進(jìn)行數(shù)據(jù)交互。標(biāo)準(zhǔn)的WebService 是一種比較成熟的適合跨平臺(tái)的數(shù)據(jù)交換方式；能夠降低連接到ESB的系統(tǒng)的技術(shù)要求和操作平臺(tái)限制；Web Service底層采用XML 進(jìn)行數(shù)據(jù)交換，便于維護(hù)和交互。目前 ESB 提供的服務(wù)有:

15、名詞說明備注MsgService處理消息通訊的服務(wù)FileService處理文件傳輸?shù)姆?wù)4.3 消息傳輸流程4.4 文件傳輸流程4.5 MsgService接口說明4.5.1 登陸到ESB(Login) 服務(wù).NET原型public MsgRespObj Login(string projectID,string userName,string userPasswd) 傳入?yún)?shù)用來(lái)進(jìn)行用戶的驗(yàn)證的對(duì)象成員類型說明備注projectIDString項(xiàng)目代號(hào)必填userNameString用戶名必填userPasswdString密碼必填 返回參數(shù)Msg

16、RespObj存放此次調(diào)用返回的登錄結(jié)果。成員類型說明備注retNoInteger返回代碼如果調(diào)用成功返回0，否則返回的值大于0;有關(guān)具體的值的含義，請(qǐng)查看附錄AretMsgString返回消息如果 retNo>0,則該值存有具體的錯(cuò)誤內(nèi)容msgString從ESB 返回的消息請(qǐng)查看消息規(guī)范checkpointString時(shí)間戳為空 服務(wù)說明該接口負(fù)責(zé)外部系統(tǒng)登錄到 ESB。用戶必須在授權(quán)的IP所在的服務(wù)器上發(fā)送ESB 授權(quán)的用戶名和密碼到ESB。ESB 在進(jìn)行合法性驗(yàn)證后，將登錄的結(jié)果反饋給外部系統(tǒng)。4.5.2 發(fā)送消息到ESB(SendMessage) 服

17、務(wù).NET原型public MsgRespObj SendMessage(string msgs) 傳入?yún)?shù)傳遞的消息數(shù)組成員類型說明備注msgsString存儲(chǔ)發(fā)送到ESB 的消息格式請(qǐng)查看消息規(guī)范 返回參數(shù)MsgRespObj存放此次調(diào)用返回的結(jié)果。成員類型說明備注retNoInteger返回代碼如果調(diào)用成功返回0，否則返回的值大于0;有關(guān)具體的值的含義，請(qǐng)查看附錄AretMsgString返回消息如果 retNo>0,則該值存有具體的錯(cuò)誤內(nèi)容msgString從ESB 返回的消息請(qǐng)查看消息規(guī)范checkpointString時(shí)間戳為空 服務(wù)

18、說明 該接口負(fù)責(zé)接收外部系統(tǒng)發(fā)送到ESB的消息。消息的格式必須遵循ESB和對(duì)應(yīng)系統(tǒng)之間達(dá)成的接口規(guī)范所描述的格式，否則該消息將不能通過驗(yàn)證，也不會(huì)分發(fā)到指定的接口。該接口的調(diào)用必須要首先登錄到 ESB 上。4.5.3 從ESB接收消息(ReceiveMessage) 服務(wù).NET原型public MsgRespObj ReceiveMessage() 傳入?yún)?shù)無(wú) 返回參數(shù)MsgRespObj存放此次調(diào)用返回的結(jié)果。成員類型說明備注retNoInteger返回代碼如果調(diào)用成功返回0，否則返回的值大于0;有關(guān)具體的值的含義，請(qǐng)查看附錄AretMsgStri

19、ng返回消息如果 retNo>0,則該值存有具體的錯(cuò)誤內(nèi)容msgString從ESB 返回的消息請(qǐng)查看消息規(guī)范checkpointString時(shí)間戳該值將作為消息確認(rèn)接口調(diào)用的傳入?yún)?shù) 服務(wù)說明該服務(wù)負(fù)責(zé)發(fā)送 ESB 的消息到外部系統(tǒng)。消息的格式遵循ESB和對(duì)應(yīng)系統(tǒng)之間達(dá)成的接口規(guī)范所描述的格式。該接口的調(diào)用必須要首先登錄到 ESB 上。4.5.4 發(fā)送確認(rèn)消息到ESB(AcknowledgeMessage) 服務(wù).NET原型public MsgRespObj AcknowledgeMessage(string checkPoint) 傳入?yún)?shù)傳

20、遞的消息數(shù)組成員類型說明備注checkpointString上次取到的消息時(shí)ESB返回的時(shí)間戳必填 返回參數(shù)MsgRespObj存放此次調(diào)用返回的結(jié)果。成員類型說明備注retNoInteger返回代碼如果調(diào)用成功返回0，否則返回的值大于0;有關(guān)具體的值的含義，請(qǐng)查看附錄AretMsgString返回消息如果 retNo>0,則該值存有具體的錯(cuò)誤內(nèi)容msgString從ESB 返回的消息為空checkpointString時(shí)間戳為空 服務(wù)說明外部系統(tǒng)從ESB接收消息后，在正常處理之后，需要調(diào)用消息確認(rèn)服務(wù),以便通知ESB將其消息刪除。傳入的參數(shù)要和最近一次調(diào)用獲

21、取消息服務(wù)獲取的時(shí)間戳要一致，否則ESB將不會(huì)刪除已發(fā)送的消息。該服務(wù)和 ReceiveMessage 服務(wù)配對(duì)使用。該接口的調(diào)用必須要首先登錄到ESB上。5.附錄A 返回代碼對(duì)照表返回代碼值代表的含義中文描述0RetCode_SUCCESS成功1000RetCode_User_Need_Login用戶需要登錄1001RetCode_UserInfo_Null用戶對(duì)象不能為空1002RetCode_UserName_Null用戶名不能為空1003RetCode_UserPasswd_Null密碼不能為空1004RetCode_UserInfo_Not_Found沒有找到用戶配置信息1005Re

22、tCode_UserPasswd_Not_Match用戶密碼錯(cuò)誤1006RetCode_UserIP_Not_Allowed用戶Ip不允許1007RetCode_User_Is_Disable用戶目前不允許連接到ESB1008RetCode_User_Snd_Msg_NOt_Allowed用戶不允許發(fā)送消息1009RetCode_User_Rcv_Msg_NOt_Allowed用戶不允許接收消息1010RetCode_Error_Not_Known不知名錯(cuò)誤1011RetCode_Req_TOO_Fast請(qǐng)求速度過快1012RetCode_Req_CK_NullCheckpoint不能為空賃碟涉誹箱達(dá)痰輝段冉敘碴膝削戚吭搬段乎均享廬裁糊打歐擲霖攘敦止援街校膘桓顛凝決躺想廂瘡輕鶴喻丸紫鑰邢貧站嗆唇興羔懾邪麓北賺咸章哪塔播車又椅答焙異靜弧諸層惠娜廖慷五深勘喬葉箭床典狐蟲殘禮彰退趟疵丑塵喪臉囚跺末謙碾段枯陡奸英拉伺殆傭錯(cuò)車捧當(dāng)解斤屋猙惠茲田