OA程序維護(hù)手冊(cè)

1、 OA系統(tǒng) 1.0程序維護(hù)手冊(cè)文件控制受控 不受控文檔編號(hào)OA-1201版本號(hào)1.0分冊(cè)名稱OA系統(tǒng)-程序維護(hù)手冊(cè)第1冊(cè)/共1冊(cè)總頁(yè)數(shù)10正文9附錄無(wú)編制江華審批譚璨生效日期2014-06-011 引言1.1 功能 本系統(tǒng)從業(yè)務(wù)功能上分為公文管理、個(gè)人郵箱、通知管理、個(gè)人事務(wù)等功能模塊。通用的業(yè)務(wù)模塊：根據(jù)多年的軟件開發(fā)經(jīng)驗(yàn)編寫一個(gè)應(yīng)用平臺(tái)，在這個(gè)平臺(tái)上可以進(jìn)行用戶的定制化配置，然后達(dá)到用戶實(shí)際運(yùn)行的要求。性能要求：遵循總體設(shè)計(jì)的性能設(shè)計(jì)要求。動(dòng)態(tài)提示：新郵件、新通知等都會(huì)以消息提示的形式，提示出來(lái)并且會(huì)播放提示聲音。1.2參考資料編號(hào)資料名稱作者日期1OA系統(tǒng)計(jì)劃任務(wù)書江華2014-02-2

2、52OA系統(tǒng)需求規(guī)格說(shuō)明江華2014-02-123OA創(chuàng)建規(guī)則需求規(guī)格說(shuō)明書江華2014-02-184OA項(xiàng)目解決方案江華2014-02-26 2 功能2.1總體說(shuō)明OA主要分為服務(wù)端和前端。服務(wù)端部署在專門的 OA服務(wù)器（機(jī)群）上，前端部署在各個(gè)電腦的信息系統(tǒng)之上。各OA前端主要完成數(shù)據(jù)收集工作，將企業(yè)提供的數(shù)據(jù)，按照一定校驗(yàn)規(guī)則進(jìn)行檢查，并把符合條件的數(shù)據(jù)放到相應(yīng)的文本中，為服務(wù)段提供數(shù)據(jù)上傳。服務(wù)端從若干個(gè)前端采集數(shù)據(jù)，并把采集來(lái)的數(shù)據(jù)按照一定的規(guī)則加以整理和儲(chǔ)存，最終通過(guò) Web Service提供 OA索引服務(wù)。同時(shí)，在服務(wù)端上運(yùn)行 OA管理程序，通過(guò) B/S方式提供 OA管理功能，

3、保證OA服務(wù)良好運(yùn)行。系統(tǒng)主要部門的內(nèi)部關(guān)系圖如下：2.2程序說(shuō)明OA系統(tǒng)各個(gè)組件特性如下。2.4.1 OA服務(wù)端OA服務(wù)端是一組服務(wù)的集合。其中包括如下組件：2.4.2 FTP服務(wù)用于接收前端信息的 FTP上傳。目前是明文傳輸，將來(lái)可能要升級(jí)為 SSL安全加密的 FTP傳輸。FTP服務(wù)將接收的 OA數(shù)據(jù)文件放在相應(yīng)的目錄，等待 OA管理程序處理。2.4.3 OA數(shù)據(jù)庫(kù)用來(lái)存儲(chǔ) OA海量信息。對(duì)數(shù)據(jù)容量和數(shù)據(jù)存/取速度有非常高的要求?？紤]用 Oracle企業(yè)版數(shù)據(jù)庫(kù)+In-memory數(shù)據(jù)庫(kù)，或者集群數(shù)據(jù)庫(kù)實(shí)現(xiàn)。 數(shù)據(jù)庫(kù)一方面由 OA管理程序維護(hù)，更新，一方面又為 Web Service提供

4、OA檢索服務(wù)。2.4.4 Web Service對(duì)外提供 OA信息索引服務(wù)。接收相關(guān)患者/人員信息，在 OA數(shù)據(jù)庫(kù)中檢索后，返回 OA ID。將來(lái)可能需要擴(kuò)展，檢索不到該條信息，則新建一條 OA ID，并返回該 OA ID給用戶。2.4.5 OA管理系統(tǒng)負(fù)責(zé)由信息文件生成 OA數(shù)據(jù)庫(kù)，和管理維護(hù) OA數(shù)據(jù)庫(kù)。系統(tǒng)分為兩個(gè)部分，一部分是在服務(wù)段運(yùn)行的一組 TOOLKIT，負(fù)責(zé)把 FTP上傳來(lái)的信息文件，經(jīng)過(guò) OA處理規(guī)則，新增到OA數(shù)據(jù)庫(kù)中。另外一方面，提供一個(gè) B/S結(jié)構(gòu)的管理程序，允許管理人員登錄到服務(wù)器，對(duì)OA系統(tǒng)的進(jìn)行手工維護(hù)。2.4.6 OA前端OA前段是部署在各個(gè)部門的多個(gè)組件的集合

5、，通常各個(gè)部門會(huì)有不同的結(jié)構(gòu)，需要單獨(dú)定制。其差異性主要在通過(guò)一個(gè) Spring配置文件來(lái)維護(hù)。前端服務(wù)：前端服務(wù)部署在各部門信息系統(tǒng)之上，由一組 Tool Kit組成，主要有如下功能。a)數(shù)據(jù)校驗(yàn)：對(duì)各部門數(shù)據(jù)源的數(shù)據(jù)進(jìn)行過(guò)濾，使得不符合 OA要求的信息不進(jìn)入系統(tǒng)。并將有問(wèn)題的數(shù)據(jù)另存在日志文件。b)數(shù)據(jù)采集：將各部門數(shù)據(jù)轉(zhuǎn)換成 OA導(dǎo)入可以識(shí)別的文本。數(shù)據(jù)采集程序不斷檢索各部門數(shù)據(jù)源，一旦發(fā)現(xiàn)由需要處理的任務(wù)，就開始處理。出于對(duì)各部門數(shù)據(jù)源的壓力考慮，數(shù)據(jù)采集程序可以配置運(yùn)行，避免對(duì)各部門數(shù)據(jù)源帶來(lái)過(guò)多壓力。c)數(shù)據(jù)上傳：將可識(shí)別的文本上傳到 OA服務(wù)端的 FTP服務(wù)器。具有 FTP上傳客

6、戶端功能，經(jīng)過(guò)配置，將存放在特定位置的 OA信息，通過(guò) FTP將數(shù)據(jù)上傳到 OA FTP服務(wù)器上。輔助工具：幫助開發(fā)/測(cè)試系統(tǒng)。a)數(shù)據(jù)分析：對(duì)各部門數(shù)據(jù)源各個(gè)字段進(jìn)行分析和統(tǒng)計(jì)，得出可以評(píng)價(jià)各部門數(shù)據(jù)源的有效結(jié)論。數(shù)據(jù)分析程序能有效幫助我們對(duì)各部門數(shù)據(jù)源進(jìn)行個(gè)性化處理。避免采集的OA信息出現(xiàn)重大問(wèn)題。b)數(shù)據(jù)生成：模擬各部門數(shù)據(jù)供開發(fā)測(cè)試。跟據(jù)數(shù)據(jù)分析結(jié)果產(chǎn)生一組相應(yīng)數(shù)據(jù)，檢查OA處理程序能否對(duì)數(shù)據(jù)進(jìn)行符合期望的處理。數(shù)據(jù)生成程序和數(shù)據(jù)分析程序相互印證。系統(tǒng)應(yīng)該提供友好的操作界面，滿足客戶易用性要求。3操作環(huán)境3.1.1設(shè)備 OA系統(tǒng)設(shè)備主要包括 OA中心服務(wù)器和各個(gè)前端系統(tǒng)的工作站。OA中

7、心服務(wù)器推薦配置：Core CPU；8G內(nèi)存；G硬盤。OA前端系統(tǒng)工作站推薦配置：Core CPU；4G內(nèi)存；G硬盤。3.1.2支持軟件OA中心服務(wù)器使用支持軟件如下：操作系統(tǒng)：推薦使用 Windows Server 2011 Datacenter；可選 Red Hat ES 5.0；企業(yè)系統(tǒng)平臺(tái)：要求 JDK 5.0以上；數(shù)據(jù)庫(kù)系統(tǒng)：參見 3.2；FTP服務(wù)器：推薦使用 Serv-U FTP Server 7.0以上；可選 IIS FTP Server 5.0以上；Web服務(wù)器：推薦使用 Apache Jetspeed 2以上OA前端系統(tǒng)工作站使用支持軟件如下：操作系統(tǒng)：推薦使用 Windo

8、ws Server 2003；可選 Windows XP SP2；企業(yè)系統(tǒng)平臺(tái)：要求 JDK 5.0以上；數(shù)據(jù)庫(kù)系統(tǒng)：MS SQL Server 2000，MS SQL Server 2005；3.2數(shù)據(jù)庫(kù)OA系統(tǒng)使用 Oracle 11g數(shù)據(jù)庫(kù)，同時(shí)使用 H2作為可替代的開源版本數(shù)據(jù)庫(kù)，兩種數(shù)據(jù)庫(kù)可根據(jù)具體應(yīng)用的不同分開或協(xié)同工作。 4維護(hù)過(guò)程4.1約定一、OA系統(tǒng) Java編碼風(fēng)格必須符合 OA軟件界面設(shè)計(jì)及編碼標(biāo)準(zhǔn)規(guī)范中的如下幾個(gè)約定（詳細(xì)信息參考 OA軟件界面設(shè)計(jì)及編碼標(biāo)準(zhǔn)規(guī)范文檔）：1、對(duì)象命名約定；2、注釋約定；3、結(jié)構(gòu)化編碼約定；4、數(shù)據(jù)源的約定及訪問(wèn)約定；5、其他約定。二、OA

9、系統(tǒng)數(shù)據(jù)設(shè)計(jì)編碼風(fēng)格必須符合 SQL標(biāo)準(zhǔn)編碼規(guī)范。三、OA系統(tǒng)維護(hù)、開發(fā)、測(cè)試引用以下規(guī)范性指導(dǎo)文件：1、GB/T17544: 1998軟件質(zhì)量要求和測(cè)試；2、GB/T18492: 2001系統(tǒng)及軟件完整性級(jí)別。4.2驗(yàn)證過(guò)程OA系統(tǒng)開發(fā)過(guò)程中的修改，按照開發(fā)流程，必須提交修改報(bào)告，根據(jù)修改報(bào)告做出相應(yīng)修改后，由專門測(cè)試人員對(duì)修改內(nèi)容進(jìn)行測(cè)試。測(cè)試完成后，根據(jù)測(cè)試分析報(bào)告完成修改報(bào)告，并發(fā)布 OA系統(tǒng)的更新版本。測(cè)試的過(guò)程為：1、根據(jù)修改報(bào)告制定測(cè)試需求；2、設(shè)計(jì)測(cè)試用例；3、準(zhǔn)備測(cè)試數(shù)據(jù)；4、按計(jì)劃執(zhí)行測(cè)試用例；5、記錄執(zhí)行過(guò)程；6、提出糾正建議措施；7、記錄、報(bào)告所發(fā)現(xiàn)的缺陷；8、發(fā)布到

10、JIRA上；9、分析測(cè)試結(jié)果 10、編寫成測(cè)試分析報(bào)告。4.3出錯(cuò)及糾正方法一、程序出錯(cuò)及糾正方法 1、對(duì)于 UI輸入錯(cuò)誤通過(guò)在UI代碼中增加輸入校驗(yàn)?zāi)K，對(duì)用戶輸入進(jìn)行校驗(yàn)，如果用戶輸入錯(cuò)誤則提示用戶出錯(cuò)信息，要求用戶必須重新輸入。2、對(duì)于 UI操作錯(cuò)誤通過(guò)在UI代碼中增加操作校驗(yàn)?zāi)K，對(duì)用戶操作進(jìn)行校驗(yàn)或者限制，一旦發(fā)現(xiàn)用戶有非法操作，提示用戶正確的操作流程信息或者限制用戶進(jìn)行非法操作。3、對(duì)于程序運(yùn)行時(shí)捕獲到的異常在程序關(guān)鍵代碼里異常捕捉塊，對(duì)異常進(jìn)行捕捉并進(jìn)行處理，并將異常產(chǎn)生的詳細(xì)信息記入日志文件，方便糾錯(cuò)排錯(cuò)。如果是普通異常則處理后程序流程繼續(xù)往下走不終止；如果是致命性異常或者錯(cuò)誤

11、則立即終止程序的執(zhí)行。4、在程序中增加檢查點(diǎn)為了增加代碼的可維護(hù)性，方便查錯(cuò)糾錯(cuò)，在源代碼中易出錯(cuò)的地方增加檢查點(diǎn)，這樣方便在程序出錯(cuò)時(shí)進(jìn)行跟蹤調(diào)試5、內(nèi)存溢出對(duì)運(yùn)行時(shí)內(nèi)存溢出錯(cuò)誤應(yīng)仔細(xì)檢查代碼中引用數(shù)組的上下標(biāo)，變量的定義。6、資源釋放及時(shí)對(duì)各種不再運(yùn)行的資源進(jìn)行有效釋放，如數(shù)據(jù)庫(kù)連接對(duì)象，防止產(chǎn)生并發(fā)問(wèn)題。二、對(duì)于數(shù)據(jù)庫(kù)錯(cuò)誤由數(shù)據(jù)庫(kù)管理員定期對(duì)數(shù)據(jù)庫(kù)數(shù)據(jù)進(jìn)行分析，每隔一段時(shí)間對(duì)索引進(jìn)行重建，每天某個(gè)時(shí)段對(duì)數(shù)據(jù)庫(kù)文件在多個(gè)服務(wù)器間進(jìn)行同步備份。三、對(duì)于容錯(cuò)設(shè)置冷后備系統(tǒng)，當(dāng)聯(lián)機(jī)系統(tǒng)出現(xiàn)故障或者停機(jī)時(shí)，后備系統(tǒng)自動(dòng)接管工作成為聯(lián)機(jī)系統(tǒng)。四、對(duì)于持久層設(shè)置的二級(jí)緩存不同步問(wèn)題如果頻繁出現(xiàn)不同步問(wèn)

12、題，可暫時(shí)將二級(jí)緩存關(guān)閉。4.4專門維護(hù)過(guò)程一、系統(tǒng)配置信息的維護(hù)：本系統(tǒng)設(shè)計(jì)一個(gè)單獨(dú)的“系統(tǒng)設(shè)置”，用于修改人員的基本信息和權(quán)限，管理員還可通過(guò)本系統(tǒng)提供的外部應(yīng)用程序直接修改系統(tǒng)的配置文件，部分配置的更改應(yīng)具有熱部署功能，即在修改程序配置后不需要重新啟動(dòng)程序。二、源代碼的維護(hù)：從增加源代碼的可讀性，可修改性，可維護(hù)性，可適應(yīng)性入手。1、增加代碼的可讀性，統(tǒng)一代碼的命名規(guī)則，給源代碼添加必要的注釋。2、增加代碼的可修改性，將源代碼放在SVN上方便團(tuán)隊(duì)修改3、 增加代碼的可維護(hù)性，在源代碼中增加檢測(cè)點(diǎn)，方便在程序出錯(cuò)時(shí)進(jìn)行跟蹤調(diào)試4、增加代碼的可適應(yīng)性，在保證不影響可讀性和性能的前提下，盡可能

13、增大代碼的復(fù)用度，預(yù)留若干接口，降低模塊間的藕合度，以適應(yīng)未來(lái)由于需求變動(dòng)。三、引入工作流在OA系統(tǒng)開發(fā)過(guò)程中引入Jira工作流，開發(fā)過(guò)程嚴(yán)格按照J(rèn)ira的工作流程走，這樣可以方便地進(jìn)行源代碼的review和重構(gòu)，也可以方便地對(duì)系統(tǒng)的BUG和ISSUE進(jìn)行管理。4.5專用維護(hù)程序一、BUG和 ISSUE維護(hù)程序。采用 JIRA對(duì)系統(tǒng) BUG和 ISSUE進(jìn)行管理和跟蹤，以下是一個(gè) OA系統(tǒng)開發(fā)遵循的 JIRA完整工作流程：二、源代碼維護(hù)程序。采用 SVN對(duì)源代碼進(jìn)行管理和維護(hù)，但開發(fā)人員對(duì)代碼進(jìn)行修改后，需將修改提交至 SVN服務(wù)器。開發(fā)人員也可將最新的源代碼從服務(wù)器上簽出，以更新本機(jī)源碼。通過(guò) SVN對(duì)源代碼進(jìn)行管理，可以方便地進(jìn)行團(tuán)隊(duì)開發(fā)。三、系統(tǒng)配置維護(hù)程序。在 OA管理程序中增加了一個(gè)叫“系統(tǒng)配置”的程序，通過(guò)該程序可以對(duì)系統(tǒng)的使用權(quán)限進(jìn)行管理，可以增加，刪除用戶，設(shè)置用戶密碼和使用權(quán)限。另外通過(guò)系統(tǒng)配置還可以對(duì)系統(tǒng)的配置進(jìn)行增刪改。其中部分配置修改后有熱部署功能，不需要重啟應(yīng)用。四、數(shù)據(jù)庫(kù)維護(hù)程序。采用 Oracle客戶端工具