(AOS、JAVA)開發(fā)規(guī)范.docVIP

軟件產(chǎn)品開發(fā)規(guī)范（Java）1 .AOS開發(fā)規(guī)范1.1包命名1、包結(jié)構(gòu)規(guī)定 包主要分為兩類：第一類為系統(tǒng)公共包com.gxhtjs. tools 該包主要存放對數(shù)據(jù)庫操作的增刪查改的基本通用類。第二類為系統(tǒng)功能模塊業(yè)務(wù)處理包，每個包都為一個獨立的功能模塊第三類為數(shù)據(jù)庫操作包。2、包命名格式如：命名：以com.gxhtjs開頭，最后個為英文單詞不能用拼音縮寫。3、包結(jié)構(gòu)說明tools 工具包，該包的類都是具有通用性的包(包括通用算法類，數(shù)據(jù)庫操作同類)。biz 業(yè)務(wù)處理包，將用來處理相關(guān)業(yè)務(wù)的類放入此包。如果相關(guān)的類是提供給頁面調(diào)用時類在命名如：UserBizPlugin 表示用戶信息業(yè)務(wù)處理插件。dao 數(shù)據(jù)庫操作包，即對數(shù)據(jù)庫表進(jìn)行操作時，一般會以表名建立對應(yīng)類用來操作對應(yīng)的表。dao包中的所有具體操作類都將集成數(shù)據(jù)通用類。1.2表單命名規(guī)范 1、表單目錄機構(gòu) 如下圖按系統(tǒng)大的功能模塊，每個模塊都是一個獨立的包，包的命名必須符合英文帕斯卡命名規(guī)范。2、AOS項目文件名命名規(guī)范：所有的文件命名必須以gxhtjs_項目名_大模塊名_小模塊名.xml進(jìn)行命名。例如: gxhx_gxncpsg_xxcj_yhdddjc_sbwsjy.xml 銷售統(tǒng)計-銀行對賬單稽查-上報無實際有form的命名規(guī)則同文件名命名方式：如：gxhx_gxncpsg_xxcj_yhdddjc_sbwsjy 企業(yè)無系統(tǒng)有3、SQL語句編寫SQL可以通過建立對應(yīng)表的SQL xml，也可以在form上直接編寫SQL盡量使用預(yù)編譯的形式編寫SQL特別是查詢SQL。插件的開發(fā)規(guī)必須符合JAVA編程規(guī)范。1.3頁面控件命名組件命名規(guī)范Button 按鈕控件如：btnSubmitCheckBox 勾選框控件如：ckbGoodsCombox 下拉列表控件如：cbxFootboorDateChooser 日期選擇控件如：dceTimesEdit 輸入框控件如：edtNameIn 整數(shù)輸入控件如：inMcountFloat小數(shù)輸入框如：fltSellPriceHidden 隱藏值控件如：hidOrgidFlatButton 平按鈕控件如：fbtnSubmitHSeperator 水平分隔線如：hprLineInSession session值控件如：isnOrgNameLabel 標(biāo)簽控件 如：lblNameListBox 列表控件如：lbxGoodsInfoPassword 密碼控件如：pwdUserPasswordPrint 打印控件如：prtFpInfoReferEdit 參照控件如：retNsrsbhSeperator 垂直分隔線如：sprDownLineSpace 空方塊控件 如：spePlanText 文本輸入控件如：txtUserNameTextSeperator 帶標(biāo)題的水平分隔線如：tstLineTitle 標(biāo)題控件如：titHeadInfoTrueFalseBox 雙值控件如：tfbNumbersFileDownloader 文件下載控件如：fdlFileNameFileUploader 文件上傳控件如：fupFileNameSTreeWidget 勾選框樹控件如：stwOrgTreeTreeWidget 樹控件如：twdOrgTreeDatagrid表格組件如：dtgUserListToolbar工具條組件如：tlbMyToolBar2JAVA編程規(guī)范2.1命名規(guī)則2.1.1包與類命名包結(jié)構(gòu)與類名前綴為了便于管理Java開發(fā)的應(yīng)用，Java開發(fā)的應(yīng)用包命名要求帶有前綴com，采用“com.包名.子功能包名”的形式，如com.bcl表示基礎(chǔ)工具包。在日常項目應(yīng)用中積累的公共的內(nèi)容希望能夠形成通用的工具包，供項目組使用，工具包與應(yīng)用包同級，采用“com.應(yīng)用包名.子應(yīng)用包名”的形式來組織項目開發(fā)的程序代碼。包名和子功能包名要求具有實際的意義，從單詞或縮寫上能夠看出包的意義，如 “com.bcl”表示基礎(chǔ)工具組件的包，納入公司的基礎(chǔ)構(gòu)件庫進(jìn)行管理，應(yīng)用的包由項目組自己命名，命名的意義與具體的項目應(yīng)用的意義相符。類命名(1) 類名首字母應(yīng)該大寫，字段、方法以及對象（句柄）的首字母應(yīng)小寫。對于所有標(biāo)識符，其中包含的所有單詞都應(yīng)緊靠在一起，而且將中間單詞的首字母大寫。例如：ThisIsAClassNamethisIsMethodOrFieldName若在定義中出現(xiàn)了常數(shù)初始化字符，則大寫static final基本類型標(biāo)識符中的所有字母。這樣便可標(biāo)志出它們屬于編譯期的常數(shù)。Java包（Package）屬于一種特殊情況：它們?nèi)际切懽帜?，即便中間的單詞亦是如此。對于域名擴展名稱，如com，org，net或者edu等，全部都應(yīng)小寫（這也是Java 1.1和Java 1.2的區(qū)別之一）。(2) 一行不要超過80個字符，并要注意折行時的寫法。下面是例子：someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5);var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3); 2.1.2變量命名（Attributes/Properties）在本規(guī)則中，變量表示一個類屬性（Attribute/Property）或一個類方法中的變量。變量可以是簡單數(shù)據(jù)類型，如整數(shù)或浮點數(shù)，也可以是一個對象，如客戶帳戶、操作員等。本變量命名規(guī)則還包括一類特殊的變量：枚舉數(shù)據(jù)常量簡單數(shù)據(jù)類型循環(huán)計數(shù)器在不影響程序可讀性的前提下，可以使用傳統(tǒng)的變量命名方式，如i、m、n等。除計數(shù)器以外的簡單數(shù)據(jù)類型的變量由小寫字母前綴+大寫字母起頭的英文單詞（或單詞縮寫）組成。當(dāng)然，循環(huán)計數(shù)器也可以使用這種命名方式，如nLoopCounter。數(shù)組在變量名前綴后加數(shù)組前綴“a”。簡單數(shù)據(jù)類型前綴表：數(shù)據(jù)類型變量名前綴例子booleanbbCustomExist, baCustomExistcharccSymbol, caSymbolsbyteyyByte, yaBytesshortssHour, saHoursintnnLen, nLoopCounter, naLengthlongllMemory, laTimesfloatffLength, faLengthdoubleddMile, daMiles注：byte與int類型的前綴較特殊，使用時應(yīng)注意類實例命名類實例采用以下兩種命名方法：1對于可以使用單個單詞表示并且該單詞與類名一致（不含類名的前綴）的類實例，可以使用全部是小寫字母的實例名。例如operator（類WFOperator的實例）、task（類WFTask的實例）、date（類Date的實例）。2其它情況下使用以小寫字母表示的類名（也可以是類名的縮寫）和以大寫字母起始的名稱組成的標(biāo)識名。例如strOperatorName、dateStart、customerList。常用的類名縮寫如下表：類類名縮寫例子Exceptionee, eAllExceptionSSBusiExceptionbebe, beLowBalanceSSDbAccessdbadba, dbaManagement, dbaCIFSSLogiExceptionlele, leInvalidValueStringstrstrOperatorName, strAddressWFOperatoropopCustomerManager, opDepartmentManager3類實例數(shù)組或集合的命名，可以在前兩種情況的基礎(chǔ)上用單詞的復(fù)數(shù)形式表示，如tasks、opDepartmentManagers，也可以在變量前面加前綴“some”表示，如someTask、someOperator。枚舉數(shù)據(jù)常量枚舉數(shù)據(jù)常量由表示枚舉類型的前綴和常量名稱組成。前綴全部由小寫字母組成，名稱使用大寫字母起頭的英文單詞。例如交易類型的枚舉常量命名如下：不明交易類型requestUnknown菜單請求requestMenuPrepare任務(wù)準(zhǔn)備requestTaskPrepare任務(wù)提交requestTaskProcess提交requestReverseProcess登錄requestLogin系統(tǒng)應(yīng)用準(zhǔn)備requestSysAppPrepare系統(tǒng)應(yīng)用提交requestSysAppProcess2.1.3類方法命名存取類型的類方法命名對于直接操作類屬性的方法，命名使用前綴“get”、“is”和“set”表示存或取類屬性，后跟大寫字母起頭的英文單詞。示例如下：FieldTypeGetternameSetternamefirstNameStringgetFirstName()setFirstName()addressSurfaceAddress objectgetAddress()setAddress()persistentBooleanisPersistent()setPersistent()customerIdIntgetCustomerId()setCustomerId()orderItemsArray of OrderItem objectsgetOrderItems()setOrderItems()一般類型的類方法命名使用“動詞”+“名詞短語”的命名格式，其中動詞使用小寫字母。例如invokeProduct()、analyseRiskItem()、openAccount()、refreshOutPutStream()2.2源程序結(jié)構(gòu)源程序按以下結(jié)構(gòu)進(jìn)行組織：程序區(qū)說明Package區(qū)使用關(guān)鍵字“package”定義當(dāng)前類的包系統(tǒng)import區(qū)用戶import區(qū)類說明類成員屬性定義類方法定義注意：為了便于使用文檔工具自動生成程序文檔，程序員必須嚴(yán)格遵守格式說明。2.3 Package區(qū)定義類所屬的包，例如：package Main;2.4 Package區(qū)定義需要引入的系統(tǒng)資源，例如：import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import javax.servlet.ServletException;import java.io.IOException;import java.util.Vector;2.5用戶import區(qū)定義需要引入的本系統(tǒng)內(nèi)部的包，例如：import SS.*;import App.*;2.6類說明類說明使用如下格式：/* * 類的詳細(xì)說明 * * author 類創(chuàng)建者姓名 * author 其他作者姓名 * version 1.00 9999/99/99 類創(chuàng)建者姓名 * 9.99 9999/99/99 修改者姓名 修改內(nèi)容說明* function illuminate * */格式說明：項目規(guī)則備注起始行/*該行不允許再有其他內(nèi)容說明行 * 說明內(nèi)容說明行中對該類的功能進(jìn)行說明，可以有多個說明行作者行 * author 姓名如果有多名作者，則分寫幾個作者行，類創(chuàng)建者在第一個作者行版本行 * version 1.00 9999/99/99 姓名 * 9.99 9999/99/99 姓名“version”為創(chuàng)建版本行。創(chuàng)建版本行的版本號固定為1.00，日期采用“年/月/日”格式，后跟作者姓名，不止一人時中間以“，”分隔。“”為修改版本行。修改版本行必須緊跟創(chuàng)建版本行，可以有多個修改版本行。修改版本行的版本號使用“主版本號.次版本號”格式，并且在姓名之后說明此次修改涉及的內(nèi)容，其他要求與創(chuàng)建版本行的要求一致參考行 * see 參考內(nèi)容列出供參考的類或類的方法與屬性（使用格式“類名”列出參考類；使用格式“類名#方法或?qū)傩悦绷谐鼍唧w方法或?qū)傩悦?，可以有多個參考行結(jié)束行 */該行不允許再有其他內(nèi)容描述格式描述信息將描述信息使用括起來例子：/* * 工作流管理子系統(tǒng) * * author 李昕 * author 雷鳴 * version 1.00 2001/8/30 李昕 * 1.01 2001/9/3 李昕，雷鳴 優(yōu)化invokeProduct()方法 * 1.02 2001/9/10 李昕 修改登錄錯誤function illuminate */2.7類成員屬性定義類成員屬性定義分為說明與定義兩部分。說明部分有三種方式，見下表：方式規(guī)則備注簡單說明方式/* 說明內(nèi)容 */屬性定義對于功能比較單一的類屬性，使用簡單方式進(jìn)行說明。說明行以“/*”起頭，以“*/”結(jié)束。定義緊跟在說明后，另起一行。詳細(xì)說明方式/* * 說明內(nèi)容 * */屬性定義對于功能復(fù)雜，需要詳細(xì)說明的類成員屬性，使用詳細(xì)方式進(jìn)行解釋。詳細(xì)說明部分第一行必須是“/* ”，不能有其它內(nèi)容；中間的說明行以“ * ”起頭，后跟說明內(nèi)容；結(jié)束行必須是“ */”，也不能有其它內(nèi)容。定義緊跟在說明后，另起一行。枚舉類型說明方式/* 說明內(nèi)容 */ 屬性定義對于定義的枚舉類型（包括常量）的類屬性，其定義放在說明部分之后，處于同一行上。對于枚舉類型，說明內(nèi)容的格式為“枚舉類型-內(nèi)容說明”。簡單說明方式的例子：/* 提示信息 */private String strMsg = null;詳細(xì)說明方式的例子：/* * 詳細(xì)的補充信息，此屬性在缺省方式下不填， * 需要時通過addDetail(String strDetailMessage)方法補充 */private String strDetail = null;枚舉類型（常量）說明方式的例子：/* 標(biāo)記-格式 */ public static final String tagMessageFormat = MF;/* 標(biāo)記-交易類型 */ public static final String tagRequestType = RT;/* 標(biāo)記-工作流ID */ public static final String tagWorkflowId = WF;/* 標(biāo)記-子任務(wù)ID */ public static final String tagSubtaskId = ST;/* 標(biāo)記-操作員ID */ public static final String tagOperatorId = OP;/* 標(biāo)記-口令 */ public static final String tagPassword = PW;2.8類方法定義類方法定義有方法說明與方法實現(xiàn)兩部分，方法實現(xiàn)部分必須緊跟在方法說明部分下一行。2.8.1類方法說明類方法說明使用如下格式：/* * 類方法的詳細(xì)使用說明 * * param 參數(shù)1 參數(shù)1的使用說明 * param 參數(shù)2 參數(shù)2的使用說明 * param 參數(shù)3 參數(shù)3的使用說明 * return 返回結(jié)果的說明 * throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明 * throws 異常類型 注明原來從此類方法的被調(diào)用方法中拋出的異常 * see 參考類1 * see 參考類2#類方法或類屬性 */格式說明：項目類型規(guī)則備注起始行必選/*該行不允許再有其它內(nèi)容說明行必選 * 說明內(nèi)容說明行中對該方法的功能進(jìn)行說明，可以有多個說明行參數(shù)行可選 * param 參數(shù) 參數(shù)說明一行對一個參數(shù)進(jìn)行說明，可以有多個參數(shù)行。如果該方法沒有任何參數(shù)，此項可省略。返回行可選 * return 返回結(jié)果說明對方法的返回結(jié)果進(jìn)行詳細(xì)說明，只允許有一個返回行，但是可以折行。如果該方法沒有返回，此項可省略。直接引發(fā)行可選 * throws 異常.代碼 拋出* 說明一行對一類異常的一種錯誤碼進(jìn)行說明，可以有多個直接引發(fā)行。代碼使用系統(tǒng)預(yù)定義的代碼常量，不能直接寫數(shù)字。列出該方法直接拋出的異常，并說明在何種情況下拋出該異常。間接引發(fā)行可選 * throws 異常 說明拋出者一行對一類異常進(jìn)行說明，可以有多個間接引發(fā)行。列出該方法調(diào)用的方法可能拋出的異常。參考行可選 * see 參考內(nèi)容列出供參考的類或類的方法與屬性（使用格式“類名”列出參考類；使用格式“類名#方法或?qū)傩悦绷谐鼍唧w方法或?qū)傩悦梢杂卸鄠€參考行項目類型規(guī)則備注結(jié)束行可選 */該行不允許再有其他內(nèi)容例子/* * 調(diào)用相關(guān)產(chǎn)品的指定方法 * * param request 請求參數(shù) * param ac 環(huán)境參數(shù) * param strProductMethod 產(chǎn)品方法名 * return 應(yīng)用處理結(jié)果 * throws SSLogiException.codeNoEnoughParam 沒有合適的方法或參* 數(shù)不足時拋出異常* throws SqlException MainScheduler.CallProduct()拋出 * see AppContext * see AppOutput#form * see SSLogiException * see SqlException */public abstract AppOutput invokeProduct(HttpServletRequest req, AppContext ac, String strProductMethod) throws SSLogiException,SqlException;2.8.2類方法實現(xiàn)部分編程規(guī)范程序注釋的形式本系統(tǒng)中，程序注釋分以下三種形式：l 詳細(xì)說明式：較詳細(xì)地解釋后續(xù)處理的功能、算法等內(nèi)容，可以有多行說明。/* * 說明內(nèi)容 * */程序行l(wèi) 簡單說明式：簡要說明后續(xù)處理，注釋內(nèi)容在一行內(nèi)寫完。/* 說明內(nèi)容 */程序行l(wèi) 行末說明式：緊接在一個程序行最右邊，對該行程序進(jìn)行簡要說明，注釋內(nèi)容在一行內(nèi)寫完。程序行; /注釋內(nèi)容局部變量原則上，一行中只允許定義一種類型的同一種用途的變量。局部變量定義必須在同一行定義語句后面加以注釋，使用行末說明式的注釋方法。一個變量只能用于一種用途。例如用于循環(huán)計數(shù)的變量就不要再用作記錄函數(shù)的返回值。變量注釋舉例如下：int i, n;/循環(huán)計數(shù)器int nPromptMsgLength;/提示信息長度WFOperator operator;/當(dāng)前操作員WFOperator opDepartmentManager;/當(dāng)前部門主管語句塊完成一種功能的一組語句組成一個語句塊。語句塊之間應(yīng)該使用空行適當(dāng)分隔。在語句塊前面必須加注釋，詳細(xì)說明其后的語句塊的功能。注釋采用詳細(xì)說明或簡單說明的注釋形式。/* * 功能說明一 */語句語句 （空行以分隔兩個功能的語句塊）/* * 功能說明二 */語句語句在語句塊的注釋中，必須包括詳細(xì)設(shè)計文檔中的所有偽碼，以標(biāo)明此段程序是在實現(xiàn)哪部分詳細(xì)設(shè)計。條件判斷ifelse每一個條件判斷語句前面使用詳細(xì)說明或簡單說明形式進(jìn)行注釋，在每一個分支內(nèi)或者使用詳細(xì)/簡單說明形式進(jìn)行注釋，或者在條件分支語句后面以行末說明形式進(jìn)行注釋。例如在條件分支內(nèi)進(jìn)行注釋：/* * 判斷說明 */if () /* * 處理說明 */ else /* * 處理說明 */ 或者在條件分支語句末進(jìn)行注釋：/* * 判斷說明 */if () /處理說明 else /處理說明 條件判斷switchcasedefault與if式的判斷語句類似，在每一個條件判斷語句前面使用詳細(xì)說明或簡單說明形式進(jìn)行注釋，在每一個分支內(nèi)或者使用詳細(xì)/簡單說明形式進(jìn)行注釋，或者在條件分支語句后面以行末說明形式進(jìn)行注釋。例如在條件分支內(nèi)進(jìn)行注釋：/* * 判斷說明 */switch () case : /* * 處理說明 */ break; default: /* * 處理說明 */ 或者在條件分支語句末進(jìn)行注釋：/* * 判斷說明 */switch () case : /處理說明 break; default: /處理說明 循環(huán)控制語句循環(huán)語句塊前必須使用詳細(xì)說明或簡單說明形式進(jìn)行注釋說明，在循環(huán)體內(nèi)部的每一條循環(huán)控制語句或者使用詳細(xì)/簡單說明形式進(jìn)行注釋，或者使用行末說明形式進(jìn)行注釋說明。例如：/* * 循環(huán)處理說明 */for (;) break; /退出循環(huán)說明（如何種條件下退出循環(huán)） continue; /循環(huán)控制條件說明 方法調(diào)用在每一個方法調(diào)用前使用詳細(xì)說明或簡單說明形式進(jìn)行注釋，解釋調(diào)用該方法的目的。例如：/* * 使用得到的方法名調(diào)用合適的應(yīng)用功能 */output = invokeProduct(request, ac, strMethodName);編程風(fēng)格的要求1大括號（“”與“”）的使用類定義中使用起止括號均左邊齊頭的大括號，例如：public Class Datetime類成員方法的實現(xiàn)部分，可以選擇以下兩種方式中的一種：起止括號均左邊齊頭或者起始括號在同一程序行尾部，終止括號左邊齊頭的格式，例如：/* * 方法原型部分較短時，使用下面的格式 */public double getBalance() throws SSLogiExceptionif(dBalance dAmount) /如果余額小于本次發(fā)生額，提示錯誤 /* * 方法原型部分較長時，使用下面的格式 */public double getBalance(String strItemName, int nItemType)throws SSException, SQLExceptionif(dBalance dAmount) /如果余額小于本次發(fā)生額，提示錯誤 其他位置一律使用起始括號在同一程序行尾部，終止括號左邊齊頭的格式，例如：if(dBalance dAmount) /如果余額小于本次發(fā)生額，提示錯誤 else/余額大于或等于本次發(fā)生額時 2縮進(jìn)格式每一層嵌套向右側(cè)縮進(jìn)4個空格。以下列出了各種情況下的嵌套格式，請參考。函數(shù)定義：public double getBalance() throws SSLogiException條件語句ifelse：if(dBalance dAmount) /如果余額小于本次發(fā)生額，提示錯誤 或：if(dBalance dAmount) /如果余額不足，提示錯誤 else /否則（余額足），正常支取 或if(dBalance dAmount) /如果余額不足，提示錯誤 else if(bValid = true) /余額足，但賬戶不正常，提示錯誤 else /余額足，且賬戶正常，正常支取 條件分支語句switchcasedefault：switch(nSex) case sexMale: /男士 break; case sexFemale: /女士 break; default: /其他，提示錯誤 循環(huán)語句for：/* * 對所有的賬戶進(jìn)行處理 */for(i = 0; i nAccountNum; i+) 循環(huán)語句while：/* * 對所有的賬戶進(jìn)行處理 */i = 0;while(i nAccountNum) i+;循環(huán)語句dowhile：/* * 至少有一個賬戶，對所有的賬戶進(jìn)行處理 */i = 0;do i+; while(i nAccountNum)3 空格的使用等號左右必須各有一個空格：strName = null;雙目運算符左右必須各有一個空格：strFullName = strFirstName + strLastName;標(biāo)點符號后面必須跟一個空格標(biāo)點符號包括“,”、“;”等，下面列出幾個例子。一行定義多個變量時，“,”后跟空格：int i, j; /循環(huán)變量在for循環(huán)中，“;”后跟空格：for(i = 0; i nAccountNum; i+)在有多個入口參數(shù)的函數(shù)調(diào)用中，“,”后跟一個空格：strCustomId = getCustomId(nCustomType, strCustomName)2.9編寫類和方法時的一些約定l 對于自己創(chuàng)建的每一個類，都考慮置入一個main()，其中包含了用于測試那個類的代碼。為使用一個項目中的類，沒必要刪除測試代碼。若進(jìn)行了任何形式的改動，可方便地返回測試。這些代碼也可作為如何使用類的一個示例使用。l 應(yīng)將方法設(shè)計成簡要的、功能性單元，用它描述和實現(xiàn)一個不連續(xù)的類接口部分。理想情況下，方法應(yīng)簡明扼要。若長度很大，可考慮通過某種方式將其分割成較短的幾個方法。這樣做也便于類內(nèi)代碼的重復(fù)使用（有時，方法必須非常大，但它們?nèi)詰?yīng)只做同樣的一件事情）。l 使類盡可能短小精悍，而且只解決一個特定的問題。下面是對類設(shè)計的一些建議：一個復(fù)雜的開關(guān)語句考慮采用“多形”機制；數(shù)量眾多的方法涉及類型差別極大的操作時，考慮用幾個類來分別實現(xiàn)；許多成員變量在特征上有很大的差別時，考慮使用幾個類。l 讓一切東西都盡可能地“私有”private。使庫的某一部分“公共化”（一個方法、類或者一個字段等），就永遠(yuǎn)不能把它拿出。若強行拿出，就可能破壞其他人現(xiàn)有的代碼，使他們不得不