南車電機(jī)ESB項(xiàng)目開(kāi)發(fā)規(guī)范

南車電機(jī)ESB建設(shè)項(xiàng)目開(kāi)發(fā)規(guī)范南車株洲電機(jī)信息技術(shù)部 第17頁(yè)共20頁(yè)南車電機(jī)ESB建設(shè)項(xiàng)目開(kāi)發(fā)規(guī)范

文檔信息文檔版本號(hào)起草人陳波起草日期20150410審核人審核日期批準(zhǔn)人批準(zhǔn)日期預(yù)期接收人甲方：乙方：監(jiān)理方：修訂記錄版本日期作者說(shuō)明1.020150410陳波

目錄TOC\o"1-1"\h\z\t"標(biāo)題2,2,標(biāo)題3,3"1 前言 81.1背景 81.2目的 81.3范圍 81.4定義 81.5參考資料 81.6文檔約定 82 系統(tǒng)概述 92.1 技術(shù)總體架構(gòu) 93 功能性需求 103.1 功能概述 103.2 邏輯架構(gòu) 113.3 數(shù)據(jù)存儲(chǔ)方式 113.3.1 數(shù)據(jù)高速緩存 123.3.2 DataPower緩存 123.3.3 數(shù)據(jù)緩存 123.3.4 持久化數(shù)據(jù)存儲(chǔ)區(qū) 123.4 渠道發(fā)布 123.5 數(shù)據(jù)校驗(yàn) 123.6 數(shù)據(jù)轉(zhuǎn)換 133.7 錯(cuò)誤代碼轉(zhuǎn)換 133.8 通道資源 133.9 報(bào)文解析器 133.10 系統(tǒng)日志打印 173.11 交易流程 173.11.1 事務(wù)控制 173.11.2 并發(fā)執(zhí)行 173.11.3 異常處理 173.11.4 公共流程 183.12 技術(shù)構(gòu)件 193.12.1 基本構(gòu)件 193.12.2 數(shù)據(jù)處理 203.12.3 通訊處理構(gòu)件 243.12.4 文件處理構(gòu)件 253.12.5 安全處理構(gòu)件 293.12.6 數(shù)據(jù)庫(kù)構(gòu)件 303.12.7 數(shù)據(jù)緩存構(gòu)件(需要與緩存平臺(tái)廠商及普元確定方案) 473.12.8 任務(wù)管理構(gòu)件(需要整合業(yè)務(wù)需要進(jìn)一步確定方案) 493.12.9 業(yè)務(wù)交易構(gòu)件 543.13 單元測(cè)試 543.14 運(yùn)行管理 553.15 版本發(fā)布 553.16 交易平臺(tái)新增及優(yōu)化范圍 553.16.1 渠道服務(wù) 553.16.2 交易流程 553.16.3 技術(shù)構(gòu)件 553.16.4 通道資源 573.16.5 報(bào)文解析器 583.17 ESBIDE優(yōu)化 583.17.1 業(yè)務(wù)字典 583.17.2 數(shù)據(jù)模型導(dǎo)入 583.17.3 報(bào)文導(dǎo)入 593.17.4 增量版本發(fā)布 604 非功能性需求 604.1 交易平臺(tái) 604.1.1 測(cè)試需求 604.1.2 性能需求 614.1.3 安全性需求 614.1.4 擴(kuò)展性需求 615 運(yùn)行環(huán)境 625.1 設(shè)備 625.2 支持軟件 62PAGE1前言背景南車株洲電機(jī)接口整合在基于PrimetonESB平臺(tái)的基礎(chǔ)上進(jìn)行開(kāi)發(fā)，整合南車電機(jī)多個(gè)外圍系統(tǒng)和核心系統(tǒng)。為了便于在后期的開(kāi)發(fā)及維護(hù)，必須制定一整套符合框架的的開(kāi)發(fā)規(guī)范。文檔目的本文試圖提供一套開(kāi)發(fā)高效可靠ESB程序的標(biāo)準(zhǔn)、約定和指導(dǎo)。它們以安全可靠的軟件工程原則為基礎(chǔ)，使代碼易于理解、維護(hù)和增強(qiáng)。通過(guò)遵循和改進(jìn)這些程序設(shè)計(jì)標(biāo)準(zhǔn)，使各項(xiàng)目產(chǎn)生的代碼有更好的一致性，并提高軟件開(kāi)發(fā)團(tuán)隊(duì)的生產(chǎn)效率。本規(guī)范適用于采用J2EE規(guī)范的項(xiàng)目，所有項(xiàng)目中的命名、渠道、渠道服務(wù)、交易服務(wù)、通道、通道服務(wù)、業(yè)務(wù)字典、數(shù)據(jù)模型及Java代碼（含JAVABEAN，開(kāi)發(fā)工具生成的代碼框架等）均應(yīng)遵守這個(gè)規(guī)范。同時(shí)，也可作為其它項(xiàng)目的參考。要求項(xiàng)目都要遵循，并作為項(xiàng)目評(píng)審與驗(yàn)收依據(jù)。規(guī)范原則：遵循業(yè)界標(biāo)準(zhǔn)可讀性強(qiáng)，意義清楚整潔嚴(yán)謹(jǐn)、風(fēng)格統(tǒng)一文檔預(yù)期讀者本文檔的預(yù)期讀者包括ESB建設(shè)項(xiàng)目開(kāi)發(fā)組全體成員：技術(shù)管理人員、系統(tǒng)設(shè)計(jì)人員、系統(tǒng)開(kāi)發(fā)人員、系統(tǒng)測(cè)試人員、系統(tǒng)維護(hù)人員、推廣培訓(xùn)人員及其他相關(guān)人員。文檔適用范圍本文檔適用于所有與南車電機(jī)ESB建設(shè)項(xiàng)目的相關(guān)的開(kāi)發(fā)ESB開(kāi)發(fā)詳解ESB開(kāi)發(fā)工具調(diào)整PrimetonESB設(shè)置作者：設(shè)置為開(kāi)發(fā)人員姓名部門(mén)：南車電機(jī)信息技術(shù)管理部默認(rèn)Module名稱：設(shè)置為com.南車電機(jī)Java代碼樣式新建南車電機(jī)(南車電機(jī)信息技術(shù)部)代碼樣式?？瞻仔?N):第一個(gè)聲明前面(F)：設(shè)為1。其余默認(rèn)。新行：在空的枚舉聲明中(E)不選中。其余默認(rèn)。自動(dòng)換行：最大行寬設(shè)為200。其余默認(rèn)。Java代碼開(kāi)發(fā)過(guò)程中使用Ctrl+Shift+F進(jìn)行代碼格式化。服務(wù)定制包（平臺(tái)組建立）創(chuàng)建原則按業(yè)務(wù)域劃分，如：任務(wù)管理器（公共、任務(wù)、業(yè)務(wù)域）命名原則com.南車電機(jī)+系統(tǒng)域名稱，使用有意義的英文單詞，全部使用小寫(xiě)字母，如：com.csr.motor.pdm命名規(guī)則通訊協(xié)議(大寫(xiě))+工程名稱，全部使用大寫(xiě)字母，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：HTTP_pdm。渠道創(chuàng)建HTTP(JSON)渠道HTTP(JSON)渠道參數(shù)使用下面表格的認(rèn)定的值。屬性值說(shuō)明編號(hào)HTTP_pdm名稱HTTP服務(wù)主機(jī)名localhost端口號(hào)10000上下文pdm協(xié)議類型HTTP最小實(shí)例數(shù)10用于指定對(duì)象池的最小實(shí)例數(shù)。最大實(shí)例數(shù)1000用于指定對(duì)象池的最大實(shí)例數(shù)。實(shí)例遞增數(shù)1有新請(qǐng)求且對(duì)象池沒(méi)有空閑實(shí)例時(shí)，每次創(chuàng)建多少新的空閑實(shí)例。實(shí)例空閑時(shí)間60用于指定實(shí)例的空閑時(shí)間，單位秒。

當(dāng)空閑的實(shí)例數(shù)超過(guò)最小實(shí)例數(shù)時(shí)，超出的實(shí)例在屬性指定的時(shí)間后被回收。處理器獲取超時(shí)時(shí)間5用于指定獲取渠道處理器的超時(shí)時(shí)間，單位秒。備注：WebService(SOAP)渠道WebService(SOAP)渠道參數(shù)使用下面表格的認(rèn)定的值。屬性值說(shuō)明編號(hào)WEBSERVICE_pdm名稱WebService服務(wù)主機(jī)名localhost端口號(hào)10001上下文pdm協(xié)議類型HTTP最小實(shí)例數(shù)10用于指定對(duì)象池的最小實(shí)例數(shù)。最大實(shí)例數(shù)1000用于指定對(duì)象池的最大實(shí)例數(shù)。實(shí)例遞增數(shù)1有新請(qǐng)求且對(duì)象池沒(méi)有空閑實(shí)例時(shí)，每次創(chuàng)建多少新的空閑實(shí)例。實(shí)例空閑時(shí)間60用于指定實(shí)例的空閑時(shí)間，單位秒。

當(dāng)空閑的實(shí)例數(shù)超過(guò)最小實(shí)例數(shù)時(shí)，超出的實(shí)例在屬性指定的時(shí)間后被回收。處理器獲取超時(shí)時(shí)間5用于指定獲取渠道處理器的超時(shí)時(shí)間，單位秒。備注：數(shù)據(jù)轉(zhuǎn)換必須在架構(gòu)設(shè)計(jì)目錄下的java文件夾下創(chuàng)建擴(kuò)展實(shí)現(xiàn)類所屬包必須為com.csr.motor.architecture.transport.dataexchange擴(kuò)展實(shí)現(xiàn)類必須以DataExchange結(jié)束。其他請(qǐng)?jiān)斠?jiàn)JAVA開(kāi)發(fā)規(guī)范擴(kuò)展實(shí)現(xiàn)必須在架構(gòu)設(shè)計(jì)目錄下的java文件夾下創(chuàng)建。擴(kuò)展實(shí)現(xiàn)類所屬包必須為com.csr.motor.architecture.transport。擴(kuò)展實(shí)現(xiàn)類必須以Transport結(jié)束。其他請(qǐng)?jiān)斠?jiàn)JAVA開(kāi)發(fā)規(guī)范攔截器開(kāi)發(fā)主機(jī)服務(wù)攔截器必須在架構(gòu)設(shè)計(jì)目錄下的java文件夾下創(chuàng)建攔截器包：com.csr.motor.architecture.handler.transport.+渠道名稱(以小寫(xiě)字母開(kāi)頭，其他單詞首字母大寫(xiě)，其他為小寫(xiě)字母)，如：com.csr.motor.architecture.handler.transport.httpReceive攔截器類名必須以Receive結(jié)束。Send攔截器類名必須以Send結(jié)束。Request攔截器類名必須以Request結(jié)束。注冊(cè)攔截器類名必須以Launch結(jié)束。其他請(qǐng)?jiān)斠?jiàn)JAVA開(kāi)發(fā)規(guī)范通道命名規(guī)則OA+“_”+目標(biāo)主機(jī)簡(jiǎn)稱，全部使用大寫(xiě)字母，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：OA_ESBESB通道ESB通道除紅色字體參數(shù)外的參數(shù)使用下面表格的認(rèn)定的值。屬性值說(shuō)明編號(hào)OA_ESB名稱ESB通道請(qǐng)求URLhttp://待定最小線程數(shù)500用于指定對(duì)象池的最小實(shí)例數(shù)。最大線程數(shù)500用于指定線程池的最大線程數(shù)。存活時(shí)間60用于指定實(shí)例的空閑時(shí)間，單位秒。

當(dāng)空閑的實(shí)例數(shù)超過(guò)最小實(shí)例數(shù)時(shí)，超出的實(shí)例在屬性指定的時(shí)間后被回收。隊(duì)列大小100當(dāng)線程池最小線程數(shù)被全部用完后，新的處理請(qǐng)求會(huì)被丟入隊(duì)列，當(dāng)隊(duì)列滿時(shí)，會(huì)創(chuàng)建新的線程處理請(qǐng)求，但不會(huì)超過(guò)最大線程數(shù)。當(dāng)隊(duì)列已滿并且也達(dá)到了最大線程數(shù)后，會(huì)調(diào)用拒絕策略拒絕新的處理請(qǐng)求。最小實(shí)例數(shù)500用于指定對(duì)象池的最小實(shí)例數(shù)。最大實(shí)例數(shù)500用于指定對(duì)象池的最大實(shí)例數(shù)。實(shí)例遞增數(shù)1當(dāng)對(duì)象池中沒(méi)有空閑實(shí)例的時(shí)候，每次創(chuàng)建多少新的空閑實(shí)例。實(shí)例空閑時(shí)間60用于指定實(shí)例的空閑時(shí)間，單位秒。

當(dāng)有大于最小實(shí)例數(shù)的實(shí)例存在時(shí)，該屬性生效。訪問(wèn)器獲取超時(shí)5用于指定獲取通道訪問(wèn)器的超時(shí)時(shí)間，單位秒。備注：MQ通道MQ通道除紅色字體參數(shù)外的參數(shù)使用下面表格的認(rèn)定的值。屬性值說(shuō)明編號(hào)OA_MQ名稱MQ通道IP地址待定MQ接收隊(duì)列名待定最小線程數(shù)500用于指定對(duì)象池的最小實(shí)例數(shù)。最大線程數(shù)500用于指定線程池的最大線程數(shù)。存活時(shí)間60用于指定實(shí)例的空閑時(shí)間，單位秒。

當(dāng)空閑的實(shí)例數(shù)超過(guò)最小實(shí)例數(shù)時(shí)，超出的實(shí)例在屬性指定的時(shí)間后被回收。隊(duì)列大小100當(dāng)線程池最小線程數(shù)被全部用完后，新的處理請(qǐng)求會(huì)被丟入隊(duì)列，當(dāng)隊(duì)列滿時(shí)，會(huì)創(chuàng)建新的線程處理請(qǐng)求，但不會(huì)超過(guò)最大線程數(shù)。當(dāng)隊(duì)列已滿并且也達(dá)到了最大線程數(shù)后，會(huì)調(diào)用拒絕策略拒絕新的處理請(qǐng)求。最小實(shí)例數(shù)500用于指定對(duì)象池的最小實(shí)例數(shù)。最大實(shí)例數(shù)500用于指定對(duì)象池的最大實(shí)例數(shù)。實(shí)例遞增數(shù)1當(dāng)對(duì)象池中沒(méi)有空閑實(shí)例的時(shí)候，每次創(chuàng)建多少新的空閑實(shí)例。實(shí)例空閑時(shí)間60用于指定實(shí)例的空閑時(shí)間，單位秒。

當(dāng)有大于最小實(shí)例數(shù)的實(shí)例存在時(shí)，該屬性生效。訪問(wèn)器獲取超時(shí)5用于指定獲取通道訪問(wèn)器的超時(shí)時(shí)間，單位秒。備注：數(shù)據(jù)轉(zhuǎn)換必須在架構(gòu)設(shè)計(jì)目錄下的java文件夾下創(chuàng)建擴(kuò)展實(shí)現(xiàn)類所屬包必須為com.csr.motor.architecture.endpoint.dataexchange擴(kuò)展實(shí)現(xiàn)類必須以DataExchange結(jié)束。其他請(qǐng)?jiān)斠?jiàn)JAVA開(kāi)發(fā)規(guī)范擴(kuò)展實(shí)現(xiàn)必須在架構(gòu)設(shè)計(jì)目錄下的java文件夾下創(chuàng)建。擴(kuò)展實(shí)現(xiàn)類所屬包必須為com.csr.motor.architecture.endpoint.handler。擴(kuò)展實(shí)現(xiàn)類必須以Handler結(jié)束。其他請(qǐng)?jiān)斠?jiàn)JAVA開(kāi)發(fā)規(guī)范攔截器開(kāi)發(fā)主機(jī)服務(wù)攔截器必須在架構(gòu)設(shè)計(jì)目錄下的java文件夾下創(chuàng)建攔截器包：com.csr.motor.architecture.handler.endpoint.+通道名稱(以小寫(xiě)字母開(kāi)頭，其他單詞首字母大寫(xiě)，其他為小寫(xiě)字母)，如：com.csr.motor.architecture.handler.endpoint.httpReceive攔截器類名必須以Receive結(jié)束。Send攔截器類名必須以Send結(jié)束。Request攔截器類名必須以Request結(jié)束。注冊(cè)攔截器類名必須以Launch結(jié)束。其他請(qǐng)?jiān)斠?jiàn)JAVA開(kāi)發(fā)規(guī)范業(yè)務(wù)建模數(shù)據(jù)類型命名規(guī)則數(shù)據(jù)類型：使用有意義的英文單詞簡(jiǎn)寫(xiě)，英語(yǔ)單詞首字母使用大寫(xiě),其他使用小寫(xiě)字母，字符長(zhǎng)度不能超過(guò)20個(gè)字符。如：PdmString數(shù)據(jù)類型包：自定義數(shù)據(jù)類型必須創(chuàng)建在包c(diǎn)om.csr.motor.datatype下。實(shí)現(xiàn)規(guī)范第一步：擴(kuò)展com.primeton.ESB.api.data.AbstractDatatype類，在com.csr.motor.datatype包下增加以DataTypeDefinition為參數(shù)的構(gòu)造函數(shù)，實(shí)現(xiàn)doInFormat，doInParse和getJavaType方法。第二步：修改數(shù)據(jù)類型配置文件。完成自定義數(shù)據(jù)類型定義后，將數(shù)據(jù)類型定義添加到業(yè)務(wù)建模->數(shù)據(jù)類型->data-type.xml文件中，在XML標(biāo)簽<configuration></configuration>中增加如下內(nèi)容：<data-typename="長(zhǎng)整形"id="long_type"impl-class="com.csr.motor.impl.data.type.CustDataType"

xsd-type="long">

<description>長(zhǎng)整型，基于java.lang.Long</description>

</data-type>其中name，id，impl-class和xsd-type為必填項(xiàng)，其含義分別如下：屬性名稱屬性描述name數(shù)據(jù)類型的名稱id數(shù)據(jù)類型的標(biāo)識(shí)impl-class數(shù)據(jù)類型的實(shí)現(xiàn)類xsd-type本數(shù)據(jù)類型映射的xsd類型數(shù)據(jù)字典命名規(guī)則數(shù)據(jù)字典分類目錄：設(shè)定為工程名稱。數(shù)據(jù)字典名稱：META_DICT元數(shù)據(jù)：D_+使用有意義的英文單詞簡(jiǎn)寫(xiě)，名字必須以一個(gè)小寫(xiě)字母開(kāi)頭，后面的單詞用大寫(xiě)字母開(kāi)頭，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：D_custName數(shù)據(jù)字典通過(guò)ESB向?qū)?chuàng)建數(shù)據(jù)字典。數(shù)據(jù)字典元素維護(hù)通過(guò)數(shù)據(jù)字典的配置功能進(jìn)行配置維護(hù)。導(dǎo)入元數(shù)據(jù)信息，導(dǎo)入的表格舉例如下：類別字典編號(hào)字典名稱字典描述校驗(yàn)規(guī)則范圍KEYVALUECSRsex性別性別validType:'length[6,6]'M男F女?dāng)?shù)據(jù)模型命名規(guī)則數(shù)據(jù)集合名稱：按業(yè)務(wù)域?qū)M(jìn)行分類，業(yè)務(wù)域名稱全部使用大寫(xiě)，如：PUB、CSR等數(shù)據(jù)模型名稱：使用有意義的英文單詞全拼或簡(jiǎn)寫(xiě)，英文單詞首字母使用大寫(xiě)字母，其他使用小寫(xiě)字母，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：CustInfo數(shù)據(jù)模型通過(guò)ESB向?qū)?chuàng)建數(shù)據(jù)模型集通過(guò)ESB的可視化操作界面進(jìn)行數(shù)據(jù)模型維護(hù)工作。通過(guò)表格方式進(jìn)行數(shù)據(jù)模型導(dǎo)入。表格模板如下：中文名英文名唯一索引非唯一索引描述字段序號(hào)數(shù)據(jù)字典編號(hào)字段英文名字段中文名字段類型長(zhǎng)度主鍵否空值驗(yàn)證備注報(bào)文定義命名規(guī)則渠道報(bào)文：報(bào)文類型簡(jiǎn)稱(J/X)+Req/Res(請(qǐng)求/響應(yīng))+交易碼，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：HCustSrvOnLineRdu通道報(bào)文：目標(biāo)系統(tǒng)簡(jiǎn)稱(大寫(xiě)字母開(kāi)頭)+Req/Res(請(qǐng)求/響應(yīng))+目標(biāo)主機(jī)交易碼，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：CoreReqCstSrvRdu報(bào)文分類目錄渠道報(bào)文分類目錄：報(bào)文類型簡(jiǎn)稱(J/X)+_+業(yè)務(wù)域，全部使用大寫(xiě)字母，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：J_CSR,X_CSR通道報(bào)文分類目錄：目標(biāo)主機(jī)簡(jiǎn)稱+目標(biāo)系統(tǒng)的簡(jiǎn)稱，如：與核心對(duì)接=ESB_CORE報(bào)文配置通過(guò)ESB向?qū)?chuàng)建報(bào)文信息通過(guò)ESB報(bào)文編輯界面進(jìn)行報(bào)文定義及維護(hù)通過(guò)表格導(dǎo)入的方式創(chuàng)建報(bào)文，導(dǎo)入的表格模板如下：所屬分類交易碼交易名稱描述英文名稱報(bào)文Key中文名稱是否必輸備注輸入數(shù)據(jù)字典名稱報(bào)文節(jié)點(diǎn)名稱卡號(hào)N數(shù)據(jù)模型名稱(START)報(bào)文節(jié)點(diǎn)名稱起始日期Y數(shù)據(jù)字典名稱報(bào)文節(jié)點(diǎn)名稱結(jié)束日期Y數(shù)據(jù)模型名稱(END)報(bào)文節(jié)點(diǎn)名稱交易金額N輸出數(shù)據(jù)字典報(bào)文節(jié)點(diǎn)名稱卡號(hào)N數(shù)據(jù)模型名稱(START)報(bào)文節(jié)點(diǎn)名稱起始日期Y數(shù)據(jù)字典名稱報(bào)文節(jié)點(diǎn)名稱結(jié)束日期Y數(shù)據(jù)模型名稱(END)報(bào)文節(jié)點(diǎn)名稱交易金額N服務(wù)定制主機(jī)服務(wù)命名規(guī)范主機(jī)服務(wù)分類目錄：目標(biāo)主機(jī)簡(jiǎn)稱+“_”+目標(biāo)系統(tǒng)簡(jiǎn)稱，全部使用大寫(xiě)字母，字符長(zhǎng)度不能超過(guò)20個(gè)字符，如：ESB_CORE。主機(jī)服務(wù)名稱：目標(biāo)系統(tǒng)簡(jiǎn)稱+_+主機(jī)交易碼，目標(biāo)系統(tǒng)使用有意義的英文單詞全拼或簡(jiǎn)寫(xiě)，英文單詞首字母使用大寫(xiě)字母，其