1、基于EOS平臺(tái)開(kāi)發(fā)應(yīng)用系統(tǒng)命名規(guī)范版本 青島大學(xué)信息工程學(xué)院修訂歷史日期版本描述作者 2009-02-08 草案 目錄1.簡(jiǎn)介 1.1目的1.2范圍1.3定義、首字母縮寫(xiě)和縮寫(xiě)1.4參考資料1.5概述2.一般用例建模準(zhǔn)則2.1一般風(fēng)格2.2 關(guān)系的使用2.3 和 關(guān)系的使用。2.3.1 關(guān)系的使用。2.3.2 關(guān)系的使用。2.4參與者泛化關(guān)系的使用2.5交互圖的使用2.6活動(dòng)圖的使用 3.如何描述用例 3.1參與者準(zhǔn)則 3.1.1每個(gè)具體用例至少涉及一個(gè)參與者3.1.2直觀、描述性的參與者名稱3.1.3參與者名稱的一致使用3.2用例名稱3.3用例簡(jiǎn)短描述3.3.1至少 1 個(gè)段落3.3.2示例

2、（可選）3.4祈使語(yǔ)氣的一致使用：需要3.5詞匯表術(shù)語(yǔ)的使用3.6“操作”術(shù)語(yǔ)的使用 3.6.1定義系統(tǒng)負(fù)責(zé)在何處提供操作選項(xiàng)3.6.2術(shù)語(yǔ)在整個(gè)用例中的一致使用3.7參與者和系統(tǒng)行為的獨(dú)立段落3.8備選流和子流3.9前置條件和后置條件3.10對(duì)于缺少的詳細(xì)信息使用占位符（待定） 3.11補(bǔ)充規(guī)范的定義和引用3.12使用 UI 原型設(shè)計(jì)進(jìn)行交叉檢查3.13異常流（可選） 3.13.1發(fā)生什么異常？ 1. 簡(jiǎn)介 1.1 目的 此組準(zhǔn)則的目的是確保應(yīng)用系統(tǒng)命名的一致性。1.2 范圍 這些準(zhǔn)則可以按原樣使用，或者進(jìn)行定制，以滿足大部分項(xiàng)目的需求。1.3 定義、首字母縮寫(xiě)和縮寫(xiě) EOS： 上海普元公司

3、提供的面向構(gòu)件的中間件平臺(tái)，作為本項(xiàng)目應(yīng)用軟件的技術(shù)平臺(tái)構(gòu)件： 本規(guī)范所提到的構(gòu)件及構(gòu)件包的概念，均指EOS中的構(gòu)件與構(gòu)件包。FBFRAME： 基礎(chǔ)業(yè)務(wù)框架1.4 參考資料 EOS項(xiàng)目開(kāi)發(fā)規(guī)范.doc2. 系統(tǒng)的描述 一項(xiàng)目可包含多個(gè)子系統(tǒng)，為了區(qū)分出各個(gè)子系統(tǒng)課分別命名，名稱為中文全稱名稱加附在括號(hào)內(nèi)的3個(gè)小寫(xiě)字母表示的縮寫(xiě)名稱?？s寫(xiě)名稱，主要用于在構(gòu)件名稱中標(biāo)識(shí)構(gòu)件包和數(shù)據(jù)庫(kù)表命名，對(duì)應(yīng)于用例模型中的包。如：財(cái)富管理系統(tǒng)（wms）資金管理系統(tǒng)（cms）定價(jià)管理系統(tǒng)（pms）3. 統(tǒng)一英文縮寫(xiě)或名詞約定列表本項(xiàng)目中，無(wú)論數(shù)據(jù)庫(kù)設(shè)計(jì)、程序文件命名、文檔文件命名，對(duì)于同一概念，如果需要使用縮寫(xiě)，

4、統(tǒng)一使用如下定義。詞語(yǔ)/縮寫(xiě)英文描述中文描述EOS普元面向構(gòu)件中間件平臺(tái)DocDocument文檔SrcSource Code源碼FeaFeature功能點(diǎn)，指經(jīng)過(guò)設(shè)計(jì)后分解的功能ReqRequirement需求點(diǎn)，指需求調(diào)研后形成的用戶需求Query查詢，在定義程序文件名稱時(shí)，“查詢”功能使用的英文為Query，例如AccountQuery.jspAdd增加，在定義程序文件名稱時(shí)，“增加”功能使用的英文名稱為”Add”，例如AccountAdd.jspUpdate編輯，在定義程序文件名稱時(shí)，“修改”功能使用的英文名稱為“Update”，例如AccountUpdate.jspDeleteDel

5、ete刪除，在定義程序文件名稱時(shí)，“刪除”功能使用的英文名稱為“Delete”，例如Account Delete.jspList結(jié)果列表使用英文名稱，例如AccountList.jspReturnReturn返回，系統(tǒng)中表示返回的英文縮寫(xiě)Success系統(tǒng)中表示成功的英文單詞均使用SuccessFault系統(tǒng)中表示失敗的英文單詞均使用FaultErrorError系統(tǒng)中表示錯(cuò)誤的英文縮寫(xiě)業(yè)務(wù)字典系統(tǒng)中與業(yè)務(wù)相關(guān)的代碼及對(duì)代碼的描述，例如，用Authlevel表示用戶認(rèn)證等級(jí)，而0：所有用戶，1：登錄用戶，2：產(chǎn)品綁定用戶等。EOS提供了對(duì)業(yè)務(wù)字典的管理，通過(guò)EOS業(yè)務(wù)字典功能，為系統(tǒng)實(shí)現(xiàn)提供的

6、大量構(gòu)件，方便開(kāi)發(fā)。4. 開(kāi)發(fā)目錄編排與命名4.1 文檔目錄 遵循RUP的組織方式，強(qiáng)制配置。4.2 文檔規(guī)范文檔命名規(guī)范：系統(tǒng)全稱+“_”+中文文檔名。如：財(cái)富管理系統(tǒng)（WMS）概要設(shè)計(jì)說(shuō)明書(shū).doc文檔編寫(xiě)要求：Word XP（項(xiàng)目組必須統(tǒng)一文檔工具的版本）所繪圖形要求提供原始文件在Word中的插圖盡可能使用JPG格式，以降低WORD文檔的大小文檔一旦初步定稿之后，評(píng)審者采用修正模式修改文檔4.3 需求/功能編排規(guī)范 軟件需求采用用例模型，用例名稱的命名為：系統(tǒng)縮寫(xiě)名稱+“_”+若干英文單詞組成的業(yè)務(wù)描述,對(duì)應(yīng)于用例, 名稱單詞第一個(gè)字母用大寫(xiě)其余使用英文小寫(xiě)。如：創(chuàng)建計(jì)劃wms_Crea

7、tePlan)用例定義與EOS構(gòu)件包命名一致：子系統(tǒng)UC包名客戶管理（crm）客戶信息管理crm_CustInfo客戶關(guān)系維護(hù)crm_CustAssign大客戶管理crm_VipCust客戶服務(wù)crm_CustServ項(xiàng)目公共構(gòu)件庫(kù)注：系統(tǒng)管理部分的權(quán)限管理和機(jī)構(gòu)管理在EOS提供的構(gòu)件包基礎(chǔ)上修改，并作為項(xiàng)目中的一部分4.4 程序目錄命名EOS Server文件目錄及說(shuō)明說(shuō)明：1、對(duì)于業(yè)務(wù)邏輯、展現(xiàn)邏輯和數(shù)據(jù)實(shí)體文件，是由EOS提供發(fā)布時(shí)自動(dòng)上傳注冊(cè)，不需要手工COPY文件到相應(yīng)目錄2、上圖中除標(biāo)注外的其余目錄均為非必要目錄4.5 JBOSS Server 文件目錄及說(shuō)明5. 數(shù)據(jù)庫(kù)命名規(guī)范表

8、命名規(guī)范l 表名構(gòu)成：系統(tǒng)縮寫(xiě)+_+對(duì)象名稱（英文單詞或英文縮寫(xiě)）+數(shù)據(jù)庫(kù)對(duì)象后綴，例如業(yè)務(wù)標(biāo)準(zhǔn)系統(tǒng)的某個(gè)表名：BSS_ACCOUNT_TDl 表名全部使用大寫(xiě)l 表名建議不要太長(zhǎng)（15個(gè)字符以內(nèi)），如果太長(zhǎng)，請(qǐng)使用單詞的縮寫(xiě)l 對(duì)象名稱不能使用漢字l 對(duì)象名稱不能使用中文拼音或中文拼音的首字母l 對(duì)象名稱盡可能不使用阿拉伯?dāng)?shù)字l 必須保證你的對(duì)象名稱沒(méi)有和保留詞、數(shù)據(jù)庫(kù)系統(tǒng)或者常用訪問(wèn)方法沖突l 絕對(duì)不要在對(duì)象名稱的字符之間留空格l 如果對(duì)象的名稱僅有一個(gè)單詞，則不使用縮寫(xiě)對(duì)象名稱對(duì)象類別命名規(guī)則（加前綴）表業(yè)務(wù)數(shù)據(jù)表BSS_對(duì)象名_TD代碼表BSS_對(duì)象名_TC關(guān)聯(lián)表BSS_對(duì)象名_TJ系

9、統(tǒng)定義表BSS_對(duì)象名_TS鍵和索引主鍵BSS_對(duì)象名_PK外鍵BSS_對(duì)象名_FK索引BSS_對(duì)象名_IX視圖BSS_對(duì)象名_VIEW包BSS_對(duì)象名_PACK存儲(chǔ)過(guò)程BSS_對(duì)象名_PROC函數(shù)BSS_對(duì)象名_FUNC觸發(fā)器BSS_對(duì)象名_TRI字段命名規(guī)范l 字段名全部大寫(xiě)l 不同單詞之間使用“_”l 不同表的同一個(gè)業(yè)務(wù)字段類型、長(zhǎng)度、字段名稱保持統(tǒng)一，例如，客戶編號(hào)可能存在于多個(gè)表中，要求采用同樣的字段名，并且類型、長(zhǎng)度一致l 字段名建議不要太長(zhǎng)（15個(gè)字符以內(nèi)），如果太長(zhǎng)，請(qǐng)使用單詞的縮寫(xiě)屬性默認(rèn)類型定義（Oracle參考）屬性類別類型長(zhǎng)度備注人的姓名Varchar220電話號(hào)碼Va

10、rchar230部門Varchar290單位/機(jī)構(gòu)名稱Varchar2100地址Varchar2100判斷字CHAR10：否 1：是時(shí)間、日期DATE意見(jiàn)、理由、描述、簡(jiǎn)介、備注Varchar22000CLOB大于4000請(qǐng)采用CLOB類型圖片BLOB金額NUMBER8,2比例NUMBER3,2設(shè)計(jì)規(guī)范一般必須滿足三個(gè)數(shù)據(jù)庫(kù)設(shè)計(jì)范式l 范式一：表結(jié)構(gòu)中不能含有任何重復(fù)的數(shù)據(jù)字段。違反該范式的例子：求職人員表：求職人員編號(hào)求職人員姓名聯(lián)系電話1聯(lián)系電話2C001張三C002李四問(wèn)題：若增加一個(gè)“聯(lián)系電話3”則要修改表結(jié)構(gòu)，原來(lái)的應(yīng)用程序也將重新修改。 正確處理：求職人員表： 求職人員編號(hào)求職人員

11、姓名C001張三C002李四求職人員聯(lián)系表：求職人員編號(hào)序號(hào)聯(lián)系電話C00101C00102C00201C00202l 范式二：要求每一列均函數(shù)性地依賴于主關(guān)鍵字。違反該范式的例子：物業(yè)分布表：分布點(diǎn)編號(hào)所在地址所在城市H001蒲匯塘路上海H002漕寶路上海H003漢中路上海主要服務(wù)表：服務(wù)編碼服務(wù)收費(fèi)P0170.99P0221.00P03502.54服務(wù)記錄表：分布點(diǎn)編號(hào)服務(wù)編碼所在地址任務(wù)描述日期H002P02漕寶路樹(shù)木修剪1997/11/15H002P03漕寶路上油1997/12/01H003P01漢中路熔爐1997/12/03問(wèn)題：服務(wù)記錄表是以“分布點(diǎn)編號(hào)”和“服務(wù)編碼”作為主關(guān)鍵字

12、?！八诘刂贰焙汀叭蝿?wù)描述”兩列不完全函數(shù)性地依賴于主關(guān)鍵字。顯然服務(wù)期間地址通常是不變的，不管在什么地方執(zhí)行任務(wù)，特定任務(wù)的描述應(yīng)該是一樣的。正確處理：主要服務(wù)表：服務(wù)編碼服務(wù)收費(fèi)任務(wù)描述P0170.99熔爐P0221.00樹(shù)木修剪P03502.54上油服務(wù)記錄表：分布點(diǎn)編號(hào)服務(wù)編碼日期H002P021997/11/15H002P031997/12/01H003P011997/12/03l 范式三：表中記錄符合第二范式且不存在傳遞依賴，當(dāng)表中含有一定其他列的非主列時(shí)，存在傳遞依賴。違反該范式的例子：學(xué)生考試成績(jī)表學(xué)號(hào)課程考試日期成績(jī)累計(jì)平均S001CIS0911997/10/178481S0

13、02MGT1001997/10/177277S003CIS0911997/10/179390問(wèn)題：“學(xué)號(hào)”，“課程”和“考試日期”為主關(guān)鍵字?！袄塾?jì)平均”列代表該學(xué)生所有課程成績(jī)的平均，這列傳遞依賴于“學(xué)號(hào)”列，因此不符合第三范式。正確處理：學(xué)生個(gè)人信息表學(xué)號(hào)姓名累計(jì)平均S001張三91S002李四80S003王五78學(xué)生考試成績(jī)表學(xué)號(hào)課程考試日期成績(jī)S001CIS0911997/10/1784S002MGT1001997/10/1772S003CIS0911997/10/1793特殊情況可不用設(shè)計(jì)范式*存儲(chǔ)計(jì)算值到數(shù)據(jù)庫(kù)中。*將歷史信息分割到其他表中。存儲(chǔ)計(jì)算值：通常，一個(gè)設(shè)計(jì)良好的關(guān)系數(shù)據(jù)

14、庫(kù)不存儲(chǔ)任何計(jì)算數(shù)據(jù)如總和，平均值，最大值和最小值。這些數(shù)據(jù)通常在運(yùn)行時(shí)利用基本數(shù)據(jù)來(lái)計(jì)算。然而，有些場(chǎng)合把計(jì)算值儲(chǔ)存起來(lái)可能更簡(jiǎn)單，更快，更明智。比如：旅客表：旅客編號(hào)姓名Z001張三.L004李四.W008王五飛行情況表：旅客編號(hào)飛行次數(shù)飛行日期飛行里程Z001111998/01/027832.L00418001998/02/037743.W008271998/04/03743問(wèn)題：“飛行情況表”會(huì)很快增加，漸漸達(dá)到幾萬(wàn)行。旅客若打電話詢問(wèn)自己飛行有多少公里，希望立刻得到回答，然而查詢“飛行情況表”并把所有單個(gè)里程加起來(lái)可能要花費(fèi)幾秒的時(shí)間。這時(shí)就需要把總和信息存儲(chǔ)起來(lái)，以供快速查詢。正確

15、處理：旅客編號(hào)姓名旅客里程Z001張三73873.L004李四92923.W008王五8727為保持總公里數(shù)的相對(duì)實(shí)時(shí)性，可以每晚運(yùn)行一個(gè)加總程序更新總和，這樣做可至少帶來(lái)兩個(gè)好處：其一：總公里數(shù)可快速獲取。其二：更好地平衡負(fù)載。繁重的加總工作放在晚上處理。為了更快更新，從而得到更準(zhǔn)確的數(shù)據(jù)，需要使用類似觸發(fā)器的方法來(lái)得到最新的數(shù)據(jù)。查找歷史：假設(shè)維護(hù)一個(gè)信用卡支付系統(tǒng)，顧客通常打電話來(lái)了解自己最近的收支情況。偶爾他們想知道幾個(gè)月前的收支情況。在這個(gè)應(yīng)用中最主要的表如下：業(yè)務(wù)交易表：交易編碼客戶編碼使用日期金額T0001C20211997/11/1414.88.T1012C30001997/1

16、1/965.90問(wèn)題：該表會(huì)很快增長(zhǎng)到幾百萬(wàn)行，查找一個(gè)客戶的所有記錄需要幾秒鐘。事實(shí)上顧客和服務(wù)人員對(duì)這反應(yīng)時(shí)間都有抱怨。改進(jìn)方法一：由于客戶一般只查詢最近月份的交易信息，可以另加兩個(gè)同樣的緩沖表，每月底，進(jìn)行一次數(shù)據(jù)移動(dòng)即可（把最近月份的數(shù)據(jù)刪除）。改進(jìn)方法二：可利用其“分區(qū)”的概念，通過(guò)復(fù)制機(jī)制，將一個(gè)數(shù)據(jù)庫(kù)復(fù)制到另外一個(gè)數(shù)據(jù)庫(kù)中。其他l 保證數(shù)據(jù)完整性n 使用事務(wù)提交概念n 使用觸發(fā)器等手段n 設(shè)置外鍵l 數(shù)據(jù)庫(kù)維護(hù)（整理，備份，恢復(fù)）l 數(shù)據(jù)庫(kù)訪問(wèn)操作必須考慮網(wǎng)絡(luò)多用戶使用沖突問(wèn)題l 對(duì)較大系統(tǒng)，需要考慮數(shù)據(jù)安全性，數(shù)據(jù)分布，數(shù)據(jù)復(fù)制，數(shù)據(jù)倉(cāng)庫(kù)等等l 必須考慮數(shù)據(jù)庫(kù)訪問(wèn)速度，對(duì)于數(shù)據(jù)

17、量較大的表，一定要加索引有關(guān)一般信息和更多的用例準(zhǔn)則，請(qǐng)參閱 Rational Unified Process。3.1 參與者準(zhǔn)則 有關(guān)一般信息和更多的參與者準(zhǔn)則，請(qǐng)參閱 Rational Unified Process。3.1.1 每個(gè)具體用例至少涉及一個(gè)參與者 每個(gè)具體用例是否都至少涉及一個(gè)參與者？如果不是，就存在問(wèn)題了。不與參與者交互的用例是多余的，應(yīng)該將它刪除或確定相應(yīng)的參與者。在某些情況中，會(huì)有多個(gè)參與者參與到用例交互中。請(qǐng)確保檢查在一個(gè)用例中使用多個(gè)參與者是否是有效的（請(qǐng)參閱“參與者泛化關(guān)系”）。3.1.2 直觀、描述性的參與者名稱 參與者是否是具有直觀、描述性的名稱？用戶和客戶都

18、能理解這些名稱嗎？參與者的名稱與他們的角色對(duì)應(yīng)，這一點(diǎn)很重要。如果不是，則更改它們。您應(yīng)當(dāng)參考用例模型來(lái)確保為用例中的每個(gè)參與者使用了正確的參與者名稱。3.1.3 參與者名稱的一致使用 用例規(guī)范需要使用一致的參與者名稱撰寫(xiě)。需要注意確保參與者命名是清晰明確的。不要籠統(tǒng)地使用“參與者”，而應(yīng)當(dāng)使用實(shí)際的名稱來(lái)唯一地確定或定義參與者。參與者名稱可以視為是參與到一組系統(tǒng)交互中的角色。3.2 用例名稱 用例名稱應(yīng)是唯一、直觀和解釋性的名稱，從而可以清晰明確地定義從用例獲取的值的可觀察結(jié)果。檢查用例名稱的一種好方法是調(diào)查客戶、業(yè)務(wù)代表、分析人員和開(kāi)發(fā)人員是否都能理解用例的名稱和描述。請(qǐng)記住：您需要從參與

19、者的角度定義值的可觀察結(jié)果。每個(gè)用例名稱需要描述用例支持的行為。名稱中需要包含要執(zhí)行的操作和要操作的關(guān)鍵元素。通常，這是一種簡(jiǎn)單的“動(dòng)詞名詞”組合。用例應(yīng)當(dāng)從觸發(fā)用例的參與者的角度進(jìn)行命名。示例包括：“注冊(cè)課程”、“選擇授課課程”。3.3 用例簡(jiǎn)短描述 3.3.1 至少 1 個(gè)段落 用例中需包含用例的簡(jiǎn)短描述。此描述的長(zhǎng)度至少應(yīng)當(dāng)為 1 個(gè)段落，并且不超出 3 個(gè)段落。描述中需包含用例的關(guān)鍵目的、價(jià)值陳述和概念的說(shuō)明。3.3.2 示例（可選） 如果簡(jiǎn)短的示例“故事”能夠增加價(jià)值，則可以在簡(jiǎn)短描述中包含它來(lái)幫助進(jìn)一步地描述環(huán)境。此示例通常需遵循基本流，同時(shí)在有幫助時(shí)包含數(shù)據(jù)值。3.4 祈使語(yǔ)氣的

20、一致使用：需要 用例中的系統(tǒng)需求需使用祈使語(yǔ)氣撰寫(xiě)。相對(duì)于“應(yīng)當(dāng)”和“必須”，通常更傾向于使用“需要”來(lái)一致地描述需求。并且應(yīng)避免使用暗示需求是可選或未定義的需求的消極詞匯，例如，“應(yīng)該”、“可能”、“等”。3.5 詞匯表術(shù)語(yǔ)的使用 用例中使用的所有業(yè)務(wù)術(shù)語(yǔ)在項(xiàng)目的詞匯表中進(jìn)行定義。如果用例中存在詞匯表中未包含的業(yè)務(wù)術(shù)語(yǔ)，則術(shù)語(yǔ)需要：1. 添加到詞匯表中，同時(shí)包含簡(jiǎn)短描述（最多 1 個(gè)段落）。2. 在用例中進(jìn)行更改，以反映詞匯表中定義的正確業(yè)務(wù)術(shù)語(yǔ)。3.6 “操作”術(shù)語(yǔ)的使用 3.6.1 定義系統(tǒng)負(fù)責(zé)在何處提供操作選項(xiàng) 用例需要明確地說(shuō)明系統(tǒng)負(fù)責(zé)在何處提供用作供參與者選擇的可用選項(xiàng)的操作。在多

21、數(shù)情況下，可用選項(xiàng)應(yīng)當(dāng)作為基本流的組成部分而提供，并在對(duì)應(yīng)的備選流的第一個(gè)語(yǔ)句中作為入口點(diǎn)引用。3.6.2 術(shù)語(yǔ)在整個(gè)用例中的一致使用 諸如“新建”、“修改”、“取消”、“刪除”、“確定”和“打印”之類的術(shù)語(yǔ)在整個(gè)用例的使用需保持一致：相同的邏輯操作不能使用不同的術(shù)語(yǔ)指代。特別需要注意確保在備選流中使用的操作術(shù)語(yǔ)與在基本流中使用的操作術(shù)語(yǔ)匹配。3.7 參與者和系統(tǒng)行為的獨(dú)立段落 每次參與者和系統(tǒng)之間的交互改變焦點(diǎn)（在參與者和系統(tǒng)之間）時(shí)，下一個(gè)行為段需使用新的段落描述。先描述參與者，然后再描述系統(tǒng)。句子必須以“ 需 xxxxx”或“系統(tǒng)需 xxxx”開(kāi)始。始終使用全稱來(lái)正確地表示參與者名稱，而不是使用縮寫(xiě)。3.8 備選流和子流 每個(gè)備選流和子流清晰明確地定義進(jìn)入流中的所有可能的入口點(diǎn)，并結(jié)束于從流中退出的所有可能的出口點(diǎn)。備選流還將明確地說(shuō)明出口點(diǎn)和參與者繼續(xù)到下一步的位置 是返回到基本流中的特定步驟還是結(jié)束。在事件流由于存在復(fù)雜的行為而變得混亂時(shí)，或者在單個(gè)流的長(zhǎng)度超出實(shí)際的打印頁(yè)面時(shí)，可以使