銀行企業(yè)服務總線和服務接口規(guī)范

1、.wd.wd.wd.銀行企業(yè)服務總線和服務接口標準版本：v1.0目錄 TOC o 1-3 h z u HYPERLINK l _Toc330890398 第1章服務標準 PAGEREF _Toc330890398 h 3 HYPERLINK l _Toc330890399 1.1 基本標準 PAGEREF _Toc330890399 h 3 HYPERLINK l _Toc330890400 1.2SOAP格式標準 PAGEREF _Toc330890400 h 3 HYPERLINK l _Toc330890401 1.3報文總體組成 PAGEREF _Toc330890401 h 4 HY

2、PERLINK l _Toc330890402 固定字段 PAGEREF _Toc330890402 h 5 HYPERLINK l _Toc330890403 擴展字段 PAGEREF _Toc330890403 h 5 HYPERLINK l _Toc330890404 請求報文 PAGEREF _Toc330890404 h 6 HYPERLINK l _Toc330890405 響應報文 PAGEREF _Toc330890405 h 7 HYPERLINK l _Toc330890406 出錯報文 PAGEREF _Toc330890406 h 8 HYPERLINK l _Toc3

3、30890407 1.4XML格式標準 PAGEREF _Toc330890407 h 9 HYPERLINK l _Toc330890408 請求報文 PAGEREF _Toc330890408 h 10 HYPERLINK l _Toc330890409 響應報文 PAGEREF _Toc330890409 h 11 HYPERLINK l _Toc330890410 第2章接口標準 PAGEREF _Toc330890410 h 12 HYPERLINK l _Toc330890411 2.1服務操作定義 PAGEREF _Toc330890411 h 12 HYPERLINK l _T

4、oc330890412 2.2消息定義 PAGEREF _Toc330890412 h 13 HYPERLINK l _Toc330890413 2.3字段定義 PAGEREF _Toc330890413 h 13 HYPERLINK l _Toc330890414 2.5命名空間定義 PAGEREF _Toc330890414 h 14服務標準 基本標準消息格式：SOAPSOAP綁定模式：document/literal字符編碼：UTF-8SOAP格式標準先看一個SOAP報文例如：100000000000A6002200310010009999200809290950501110331004

5、198808222239011weikaiSOAP消息的根元素是信封，信封報文主要由報文頭Header和報文本Body構(gòu)成，ESB的Web-Service將不使用Header，服務調(diào)用者可以忽略對Header的關注。因此，ESB的有效載荷在SOAP的Body內(nèi)，每個Body都只有一個元素為了便于描述，我們稱它為ESB報文元素，這個元素的內(nèi)部的XMLinnerXML即為要關注的實際報文。如果要了解ESB的接口規(guī)格只需簡單了解ESB報文元素即可。接口文檔的定義，也是針對ESB報文元素進展定義的。上例中的報文元素為：100000000000200310010009999200809290950501

6、110331004198808222239011weikai該報文本中，最上面幾個元素黑體標注為固定字段，所有服務報文都有這些字段。固定字段之后是可變字段，可變字段對于每個服務來說都是不一樣的，具體規(guī)格由服務接口定義標準定義，其中中間的幾個元素斜體標注為擴展字段，主要作用是解決各系統(tǒng)對報文公共頭信息的特殊要求。報文總體組成報文體字段由三局部組成：固定字段：每個服務都具備的字段，用來描述和標識請求與響應報文。擴展字段：由于固定字段不能保證滿足所有交易的請求與響應信息，各系統(tǒng)可以根據(jù)需要對報文進展擴展。服務相關字段：每個服務的請求與響應字段，即業(yè)務字段。固定字段固定字段是服務的元數(shù)據(jù)類型，在模式文

7、件esb.xsd文件中定義，包含了交易所用到的頭信息內(nèi)容，所有通過ESB發(fā)布的WebService服務，必須繼承固定字段。ESB固定字段定義文件：擴展字段擴展字段是為了滿足服務提供者的請求報文和響應報文中特殊的報文頭信息而設定的。各業(yè)務系統(tǒng)可以根據(jù)需要定制擴展字段模式文件，并包含固定字段模式文件。需要注意的是，擴展字段模式文件中的命名空間必須保持與固定字段模式文件中的命名空間一致。建議一個服務提供者的擴展字段模式文件只定義一個。擴展字段模式文件定義例如：請求報文固定字段中文名稱英文名稱必填備注交易流水號SEQ_NON交易流水交易號SERVICE_IDN服務交易編號，細粒度交易無需填寫渠道代號C

8、HANNEL_IDY請求渠道號機構(gòu)號BANK_CODEY請求機構(gòu)號操作員USER_IDY請求操作員號授權(quán)操作員AUTH_IDN授權(quán)操作員號請求日期TRAN_DATEY格式Y(jié)YYYMMDD，如20110810請求時間TRAN_TIMEY格式HHMMSSNNN，如092031218認證信息AUTH_CONTEXTN認證信息，暫不使用例如100000000000200310010009999200809290950501110331004198808222239011weikai響應報文固定字段中文名稱英文名稱必填備注交易流水號SEQ_NON交易流水服務號SERVICE_IDN即交易號，對于細粒度服

9、務不需要填寫機構(gòu)號BANK_CODEN請求操作員所屬機構(gòu)號響應日期TRAN_DATEY格式Y(jié)YYYMMDD，如20110810響應時間TRAN_TIMEY格式HHMMSSNNN，如092031218交易狀態(tài)TRAN_STATUSYCOMPLETE表示成功，F(xiàn)AIL表示失敗失敗碼ERROR_CODEN交易失敗時填寫失敗描述ERROR_MSGN交易失敗時填寫交易返回碼RET_CODEN交易成功，同時需要返回響應碼時，可填寫交易返回信息描述RET_MSGN交易成功，同時需要返回響應碼時，可填寫例如100000000000000string20080929095050COMPLETEststrings

10、tring張飛ZhangFei出錯報文ESB系統(tǒng)內(nèi)部錯誤，全部通過SOAP Fault返回出錯報文，包含以下信息：Faultcode：錯誤碼Faultstring：錯誤信息描述服務調(diào)用者可以通過捕獲SOAPFaultException，獲取錯誤信息。返回出錯報文100000000000000string20080929095050FAILCIF5557客戶不存在ststringstringSOAP出錯報文E001the fault stringXML格式標準先看一個XML報文例如： 101000059173 0202 ECIF 9957 99957018 20111108 152859843

11、1025919289 該報文本中，HEAD標簽中上面幾個元素黑體標注為固定字段，所有服務報文都有這些字段。固定字段之后是可擴展字段，可擴展字段對于每個服務來說都是不一樣的，具體規(guī)格由服務接口定義標準定義，其中中間的幾個元素斜體標注為擴展字段，主要作用是解決各系統(tǒng)對報文頭信息的特殊要求。BODY標簽中的字段為業(yè)務字段，具體的構(gòu)造和內(nèi)容由服務接口定義。請求報文固定字段中文名稱英文名稱必填備注交易流水號SEQ_NON交易流水交易代碼SERVICE_IDY服務交易代碼渠道代號CHANNEL_IDY請求渠道號機構(gòu)號BANK_CODEY請求機構(gòu)號請求日期TRAN_DATEY格式Y(jié)YYYMMDD，如2011

12、0810請求時間TRAN_TIMEY格式HHMMSSNNN，如092031218擴展信息EXT_HEADN擴展信息，特殊需要的時候添加，由ESB做特殊處理例如 101000059173 0202 ECIF 9957 99957018 20111108 152859843 1025919289 響應報文固定字段中文名稱英文名稱必填備注交易流水號SEQ_NON交易流水交易代碼SERVICE_IDN交易代碼機構(gòu)號BANK_CODEN請求操作員所屬機構(gòu)號響應日期TRAN_DATEY格式Y(jié)YYYMMDD，如20110810響應時間TRAN_TIMEY格式HHMMSSNNN，如092031218交易狀態(tài)T

13、RAN_STATUSYCOMPLETE表示成功，F(xiàn)AIL表示失敗擴展信息EXT_HEADN公共擴展信息失敗碼ERROR_CODEN交易失敗時填寫失敗描述ERROR_MSGN交易失敗時填寫交易返回碼RET_CODEN交易成功，同時需要返回響應碼時，可填寫交易返回信息描述RET_MSGN交易成功，同時需要返回響應碼時，可填寫例如1010000591730202995720111108152859843COMPLETE接口標準接口標準是對服務報文元素SOAP體中的元素的定義和說明，為了便于查閱，接口定義文件由Excel文件編寫。一個服務代表一組相關操作的集合，一個服務包含多個操作，服務操作包含如下內(nèi)

14、容：服務操作定義操作ID操作名稱操作描述所屬的Web-Service的EndPoint URI原子服務定義方式為：應用路徑/表名+Service例如對公客戶 基本信息維護服務： :/ip:port/EsbService/PSNBaseInfoServiceWeb-Service操作名稱(Operation Name)查詢客戶清單操作：queryPersonList輸入消息定義操作輸入消息名：PersonListRequest類型名定義：業(yè)務信息首字母大寫，詞組組合的首字母大寫+Request.輸出消息定義操作輸出消息名：PersonListResponse類型名定義：業(yè)務信息首字母大寫，詞組組

15、合的首字母大寫+Response相關完成代碼備注消息定義消息包含如下定義不需要列出固定字段：消息名稱，即報文元素的名稱。報文元素的名命空間各個子元素報文字段說明字段定義字段說明包含如下內(nèi)容字段名稱：原那么上是帶有業(yè)務含義的字段名稱，為了便于Java系統(tǒng)使用，可以采用java對象字段的書寫習慣，小寫開場、單詞間隔用大寫字母，同時為了增加ESBWebService易維護性，對于非WebService服務的WebService服務化，盡量保持與原字段名稱一致。類型：可以采用XML-Schema的類型。長度：如果是字符串類型，應說明支持的最大長度。不寫，為不限制長度。是否允許空值。格式：對于日期類型，應該說明日期的格式。其它類型如果有特殊格式要求，應在此標注。備注：對字段的附加說明。2.5命名空間定義Schema命名空間定義：服務對應的數(shù)據(jù)類型命名空間： HYPERLINK :/ njcb .cn/系統(tǒng)名稱/type/ :/ njcb .cn/系統(tǒng)名稱/type/服務名/WSDL命名空間定義： HYPERLINK :/ njcb .cn/系統(tǒng)名稱/ :/ njcb .cn/