J2EE架構(gòu)需求說(shuō)明書(shū)

內(nèi)網(wǎng)J2EE架構(gòu)需求說(shuō)明書(shū)15/15J2EE架構(gòu)需求說(shuō)明書(shū)架構(gòu)需求說(shuō)明總體架構(gòu)圖架構(gòu)時(shí)序圖架構(gòu)基本需求說(shuō)明該章節(jié)描述每一層都需要的考慮和注意的問(wèn)題，及一些必須遵循的原則。命名規(guī)范需求詳見(jiàn)pvcs上的“java命名規(guī)范.doc”異常處理需求在任何地方出現(xiàn)致命異常，都要中止執(zhí)行，回滾事物、并以友好的方式提示用戶、將錯(cuò)誤軌跡寫(xiě)入日志，允許的話，要將錯(cuò)誤以郵件或者短信提示系統(tǒng)管理員。異常處理必須遵循以下幾個(gè)原則：不能丟棄異常既然捕獲了異常，就要對(duì)它進(jìn)行適當(dāng)?shù)奶幚?。不要捕獲異常之后又把它丟棄，不予理睬。捕獲了異常卻不作任何處理，可以算得上Java編程中的殺手。如果你看到了這種丟棄（而不是拋出）異常的情況，可以百分之九十九地肯定代碼存在問(wèn)題（在極少數(shù)情況下，這段代碼有存在的理由，但最好加上完整的注釋?zhuān)悦庖饎e人誤解）。異?？偸且馕吨承┦虑椴粚?duì)勁了，或者說(shuō)至少發(fā)生了某些不尋常的事情，我們不應(yīng)該對(duì)程序發(fā)出的求救信號(hào)保持沉默和無(wú)動(dòng)于衷。調(diào)用一下printStackTrace算不上“處理異常”。不錯(cuò)，調(diào)用printStackTrace對(duì)調(diào)試程序有幫助，但程序調(diào)試階段結(jié)束之后，printStackTrace就不應(yīng)再在異常處理模塊中擔(dān)負(fù)主要責(zé)任了。正確對(duì)待異常方式主要有四種：1）處理異常。針對(duì)該異常采取一些行動(dòng)，例如修正問(wèn)題、提醒某個(gè)人或進(jìn)行其他一些處理，要根據(jù)具體的情形確定應(yīng)該采取的動(dòng)作。調(diào)用printStackTrace算不上已經(jīng)“處理好了異?！?。2）重新拋出異常。處理異常的代碼在分析異常之后，認(rèn)為自己不能處理它，重新拋出異常也不失為一種選擇。3）把該異常轉(zhuǎn)換成另一種異常。大多數(shù)情況下，這是指把一個(gè)低級(jí)的異常轉(zhuǎn)換成應(yīng)用級(jí)的異常（其含義更容易被用戶了解的異常）。4）不要捕獲異常。方法必須有throws來(lái)拋出異常。必須指定具體的異常在catch語(yǔ)句中盡可能指定具體的異常類(lèi)型，必要時(shí)使用多個(gè)catch。不要試圖處理所有可能出現(xiàn)的異常。占用資源必須釋放保證所有資源都被正確釋放。充分運(yùn)用finally關(guān)鍵詞。finally是樣好東西：不管是否出現(xiàn)了異常，F(xiàn)inally保證在try/catch/finally塊結(jié)束之前，執(zhí)行清理任務(wù)的代碼總是有機(jī)會(huì)執(zhí)行。當(dāng)然，編寫(xiě)finally塊應(yīng)當(dāng)多加小心，特別是要注意在finally塊之內(nèi)拋出的異常，這是執(zhí)行清理任務(wù)的最后機(jī)會(huì)，盡量不要再有難以處理的錯(cuò)誤。必須說(shuō)明異常的詳細(xì)信息在出現(xiàn)異常時(shí)，最好能夠提供一些文字信息，例如當(dāng)前正在執(zhí)行的類(lèi)、方法和其他狀態(tài)信息，使其易于理解和閱讀。不能使用過(guò)于龐大的try塊把大量的代碼放入單個(gè)try塊，然后再在catch語(yǔ)句中聲明Exception，而不是分離各個(gè)可能出現(xiàn)異常的段落并分別捕獲其異常。這種做法為分析程序拋出異常的原因帶來(lái)了困難，因?yàn)橐淮蠖未a中有太多的地方可能拋出Exception。輸出數(shù)據(jù)不完整不完整的數(shù)據(jù)是Java程序的隱形殺手?？紤]一下如果循環(huán)的中間拋出了異常，會(huì)發(fā)生什么事情。循環(huán)的執(zhí)行當(dāng)然是要被打斷的，其次，catch塊會(huì)執(zhí)行，就這些，再也沒(méi)有其他動(dòng)作了。已經(jīng)輸出的數(shù)據(jù)怎么辦？使用這些數(shù)據(jù)的人或設(shè)備將收到一份不完整的（因而也是錯(cuò)誤的）數(shù)據(jù)，卻得不到任何有關(guān)這份數(shù)據(jù)是否完整的提示。對(duì)于有些系統(tǒng)來(lái)說(shuō)，數(shù)據(jù)不完整可能比系統(tǒng)停止運(yùn)行帶來(lái)更大的損失。較為理想的處置辦法是向輸出設(shè)備寫(xiě)一些信息，聲明數(shù)據(jù)的不完整性；另一種可能有效的辦法是，先緩沖要輸出的數(shù)據(jù)，準(zhǔn)備好全部數(shù)據(jù)之后再一次性輸出。日志管理需求日志管理模塊可以產(chǎn)生便于最終用戶、系統(tǒng)管理員、故障維護(hù)工程師以及軟件開(kāi)發(fā)團(tuán)隊(duì)進(jìn)行分析的事件記錄，它為軟件的開(kāi)發(fā)調(diào)試和維護(hù)提供便利的手段。它能捕獲操作系統(tǒng)平臺(tái)和執(zhí)行程序的安全故障、配置錯(cuò)誤、執(zhí)行瓶頸和（或）Bug等數(shù)據(jù)信息，以純文本、XML或程序員自定的某種方式將其格式化成日志記錄，然后傳遞給內(nèi)存、系統(tǒng)輸出流、控制臺(tái)、文件、Sockets等多種系統(tǒng)資源進(jìn)行緩存和輸出。日志管理必須遵循幾個(gè)原則：1)級(jí)別輸出日志，定義一組標(biāo)準(zhǔn)的記錄級(jí)別，可用于控制記錄的輸出。可以把程序配置為只輸出某些級(jí)別的記錄，而忽略其他級(jí)別的輸出。2)提供多種輸出方式，包括內(nèi)存、數(shù)據(jù)庫(kù)、輸出流、控制臺(tái)、文件和套接字等。3)避免直接使用System.out.print來(lái)輸出日志。建議：通過(guò)封裝log4j來(lái)實(shí)現(xiàn)日志管理權(quán)限控制所有的權(quán)限控制都必須在控制層中進(jìn)行，不能只在頁(yè)面中控制，這樣可以避免非法用戶通過(guò)URI來(lái)獲取或者操作數(shù)據(jù)，導(dǎo)致系統(tǒng)的不夠安全和健壯。具體的權(quán)限控制實(shí)現(xiàn)必須使用權(quán)限體系提供的統(tǒng)一的權(quán)限控制，如下文描述。權(quán)限控制實(shí)現(xiàn)判斷用戶是否擁有某個(gè)權(quán)限，只需要將權(quán)限的權(quán)限碼作為權(quán)限體系對(duì)外API的參數(shù)來(lái)調(diào)用該API即可。如判斷用戶是否擁有權(quán)限A（其權(quán)限碼是Acode），只需如下判斷語(yǔ)句：com.szhome.security.ext.SecurityExtApi.checkPermission(request,“Acode”)；其中request為當(dāng)前請(qǐng)求，返回true表示擁有權(quán)限，否則不擁有。這里的權(quán)限標(biāo)識(shí)碼的命名非常重要，要讓程序員一看便知是哪個(gè)業(yè)務(wù)類(lèi)別，哪個(gè)系統(tǒng)、哪個(gè)模塊、哪種操作。權(quán)限碼層次的表現(xiàn)方式如下：業(yè)務(wù)類(lèi)別_應(yīng)用名_模塊名_（2..n）級(jí)模塊名_操作名比如：p_hrms_employee_edit表示p（規(guī)劃）業(yè)務(wù)類(lèi)別hrms（人事系統(tǒng)）應(yīng)用的employee（人員）模塊的edit(編輯)操作，根據(jù)需要權(quán)限碼的層次可以增加相應(yīng)的層數(shù)。應(yīng)用項(xiàng)目組應(yīng)該把應(yīng)用的所有權(quán)限的權(quán)限碼放在一個(gè)或幾個(gè)類(lèi)中，作為這些類(lèi)的靜態(tài)屬性來(lái)維護(hù)。注：每個(gè)權(quán)限的權(quán)限碼需要權(quán)限管理員的審核和注冊(cè)，才能被使用。數(shù)據(jù)驗(yàn)證包括前端的（客戶端）js的驗(yàn)證和后端（服務(wù)器控制層端）的java驗(yàn)證，對(duì)數(shù)據(jù)的驗(yàn)證主要包括：1)數(shù)據(jù)格式（字符格式、日期格式、整型數(shù)字格式、浮點(diǎn)數(shù)格式等）是否正確。2)是否要區(qū)分大小寫(xiě)。3、值是否為空。4、字符是否超長(zhǎng)。盡可能在前端做好所有的數(shù)據(jù)合法性驗(yàn)證，出現(xiàn)非法數(shù)據(jù)時(shí)在前端就能檢查出來(lái)，并給用戶友好的提示。在后端檢查出數(shù)據(jù)非法，并拋出異常提示對(duì)性能有一定的影響。如果前端和后端都沒(méi)有做數(shù)據(jù)合法性檢查，在持久層因?yàn)閿?shù)據(jù)非法而拋出異常，代價(jià)將會(huì)更大。注意：對(duì)于安全較高或者在外網(wǎng)使用的程序，前端和后端的驗(yàn)證都必須做，因?yàn)榍岸蓑?yàn)證很容易被繞過(guò)的,進(jìn)而危機(jī)到程序的安全。對(duì)于在內(nèi)網(wǎng)使用的、安全性不是太高的程序可以只做前端的驗(yàn)證。MVC架構(gòu)層次需求說(shuō)明每一層都要履行該層對(duì)應(yīng)的職責(zé)，視圖層不能實(shí)現(xiàn)控制層的功能，控制層不能實(shí)現(xiàn)模型層的功能等待，否則會(huì)造成各層之間的高耦合性，進(jìn)而加大系統(tǒng)維護(hù)、移植的風(fēng)險(xiǎn)和成本。V層（視圖層）主要包括jsp、html、圖片等，沒(méi)有任何業(yè)務(wù)邏輯。一般是從request中取得相應(yīng)數(shù)據(jù)。該層主要負(fù)責(zé)：1）提供用戶請(qǐng)求的入口。2）客戶端的數(shù)據(jù)合法性驗(yàn)證。3）顯示用戶請(qǐng)求的結(jié)果。C層（控制層）主要包括struts的action、Servlet等，只有控制邏輯，沒(méi)有任何業(yè)務(wù)邏輯。常見(jiàn)的誤用是在該層（例如，在Struts的ActionBean中）實(shí)現(xiàn)了所有的業(yè)務(wù)邏輯。使用該層的正確方法是調(diào)用適當(dāng)?shù)臉I(yè)務(wù)層服務(wù)（或?qū)ο螅┎⒔Y(jié)果發(fā)送到視圖層（viewlayer）。該層主要負(fù)責(zé)：1）權(quán)限控制，首先判斷用戶是否登錄，然后判斷用戶是否有權(quán)限執(zhí)行該操作，如果沒(méi)有登錄或者無(wú)權(quán)操作提示相應(yīng)的錯(cuò)誤信息。2）服務(wù)器端的數(shù)據(jù)合法性驗(yàn)證。3）處理請(qǐng)求數(shù)據(jù)的格式，將請(qǐng)求數(shù)據(jù)轉(zhuǎn)換成相應(yīng)的DTO（數(shù)據(jù)傳輸對(duì)象）。4）調(diào)用業(yè)務(wù)代理，將DTO作為業(yè)務(wù)代理方法的參數(shù)來(lái)調(diào)用代理方法。5）重定向頁(yè)面，如果調(diào)用業(yè)務(wù)代理成功后，定向到指定頁(yè)面；否則定向到錯(cuò)誤顯示頁(yè)面。M層（模型層）主要包括javaBean、ejb、jms、jmail、jts、自己封裝的組件等，主要可以分為兩個(gè)子層：代理層、DAO層（持久層）。代理層業(yè)務(wù)代理（BusinessDelegate），在Servlet和非servlet環(huán)境下都可以調(diào)用該層的方法，BusinessDelegate起到客戶端業(yè)務(wù)抽象化的作用。它抽象化，進(jìn)而隱藏業(yè)務(wù)服務(wù)的實(shí)現(xiàn)。使用BusinessDelegate，可以降低表示層客戶端和系統(tǒng)的業(yè)務(wù)服務(wù)之間的耦合程度。根據(jù)實(shí)現(xiàn)策略不同，BusinessDelegate可以在業(yè)務(wù)服務(wù)API的實(shí)現(xiàn)中，保護(hù)客戶端不受可能的變動(dòng)性影響。這樣，在業(yè)務(wù)服務(wù)API或其底層實(shí)現(xiàn)變化時(shí)，可以潛在地減少必須修改表示層客戶端代碼的次數(shù)。該層一般沒(méi)有實(shí)際的業(yè)務(wù)邏輯、只是對(duì)業(yè)務(wù)邏輯做了一次包裝。通?？梢杂脕?lái)調(diào)用Ejb(主要是SessionBean)，或者直接調(diào)用DAO。該層主要負(fù)責(zé)：1）封裝業(yè)務(wù)邏輯，方便控制層調(diào)用。將控制層和模型層的耦合降到最低。2）使業(yè)務(wù)邏輯脫離Servlet環(huán)境能正常運(yùn)行。DAO層（數(shù)據(jù)訪問(wèn)層或持久層）該層實(shí)現(xiàn)主要的業(yè)務(wù)邏輯，并與持久性數(shù)據(jù)(數(shù)據(jù)庫(kù)、xml文件、word或excel文檔等)交互。持久層的常用操作（如：增加、修改、查找、刪除、生成列表等）可以封裝在以個(gè)通用的DAO中，實(shí)際業(yè)務(wù)實(shí)現(xiàn)的時(shí)候只需要繼承這個(gè)通用DAO就可以實(shí)現(xiàn)常用的業(yè)務(wù)功能。該層主要負(fù)責(zé)：1）處理業(yè)務(wù)邏輯。2）業(yè)務(wù)權(quán)限判斷3）操作數(shù)據(jù)庫(kù)或文件（如：增加、修改、查找、刪除）。4）事務(wù)處理。DAO層必須滿足以下四個(gè)標(biāo)準(zhǔn)：一、具有透明性業(yè)務(wù)對(duì)象在不知道數(shù)據(jù)源實(shí)現(xiàn)的具體細(xì)節(jié)情況下，可以使用數(shù)據(jù)源。由于實(shí)現(xiàn)細(xì)節(jié)隱藏在數(shù)據(jù)訪問(wèn)層的內(nèi)部，所以訪問(wèn)是透明的。二、易于遷移數(shù)據(jù)訪問(wèn)層使應(yīng)用程序很容易遷移到其他數(shù)據(jù)庫(kù)實(shí)現(xiàn)。業(yè)務(wù)對(duì)象不了解底層的數(shù)據(jù)實(shí)現(xiàn)，所以遷移僅僅涉及到修改數(shù)據(jù)訪問(wèn)層。進(jìn)一步地說(shuō)，如果您正在部署某種工廠策略，您可以為每個(gè)底層的存儲(chǔ)實(shí)現(xiàn)提供具體的工廠實(shí)現(xiàn)。如果是那樣的話，遷移到不同的存儲(chǔ)實(shí)現(xiàn)意味著為應(yīng)用程序提供一個(gè)新的工廠實(shí)現(xiàn)。三、盡量減少業(yè)務(wù)對(duì)象中代碼復(fù)雜性因?yàn)閿?shù)據(jù)訪問(wèn)層管理著所有的數(shù)據(jù)訪問(wèn)復(fù)雜性，所以它可以簡(jiǎn)化業(yè)務(wù)對(duì)象和使用數(shù)據(jù)訪問(wèn)層的其他數(shù)據(jù)客戶端的代碼。數(shù)據(jù)訪問(wèn)層，而不是業(yè)務(wù)對(duì)象，含有許多與實(shí)現(xiàn)相關(guān)的代碼（例如SQL語(yǔ)句）。這樣給開(kāi)發(fā)人員帶來(lái)了更高的效率、更好的可維護(hù)性、提高了代碼的可讀性等一系列好處。四、把所有的數(shù)據(jù)訪問(wèn)集中在單獨(dú)的層上由于所有的數(shù)據(jù)訪問(wèn)操作現(xiàn)在都委托給數(shù)據(jù)訪問(wèn)層，所以您可以將這個(gè)單獨(dú)的數(shù)據(jù)訪問(wèn)層看做能夠?qū)?yīng)用程序的其他部分與數(shù)據(jù)訪問(wèn)實(shí)現(xiàn)相互隔離的層。這種集中化可以使應(yīng)用程序易于維護(hù)和管理。注意：這些標(biāo)準(zhǔn)都不