JavaEE程序編碼規(guī)范

名稱版本號:X.X文件標(biāo)識:comtop-scm-tmp-doc密級-PAGEII-目錄JAVA程序編碼規(guī)范 11 變量的命名規(guī)則 11.1 常量(包含靜態(tài)的) 11.2 類變量（靜態(tài)變量）及實(shí)例變量 11.3 局部變量 11.4 參數(shù) 21.5 其它 22 方法的命名規(guī)則 33 類及接口的命名規(guī)則 33.1 一般類名 33.2 值對象 33.3 Action 33.4 MyBatis配置文件 43.5 DAO 43.6 ApplicationService 43.7 工具類 43.8 門面類 43.9 代理類 43.10 異常類 43.11 接口類 53.12 接口實(shí)現(xiàn)類 54 作用域 54.1 類的作用域 54.2 方法的作用域 54.3 屬性的作用域 54.4 局部變量的作用域 55 注釋的編寫規(guī)則 66 格式 76.1 縮進(jìn) 76.2 每代碼行的長度 76.3 大括號 86.4 空行 86.5 空格 96.6 import部分 96.7 數(shù)字 97 性能與安全 107.1 靜態(tài)檢查插件 107.2 空指針引用(nullpointerdereference) 107.3 數(shù)組引用問題(RETURNARRAY） 107.4 硬編碼敏感數(shù)據(jù)(Hard-codedsensedata) 107.5 整數(shù)溢出 107.6 對象初始化 107.7 集合對象初始化容量 117.8 簡單參數(shù) 117.9 Final類和方法 117.10 無用的代碼 117.11 日志級別 117.12 序列化問題 117.13 通過名稱比較類 127.14 類克隆 127.15 JDBC使用 137.16 SQL語句 137.17 數(shù)據(jù)庫連接釋放 137.18 使用存儲(chǔ)過程 137.19 第三方組件 148 附件 14 第16頁變量的命名規(guī)則常量(包含靜態(tài)的)一個(gè)或多個(gè)英文單詞的組合，所有字母均大寫，單詞之間以“_”分隔，如：publicstaticfinalStringUPDATE_FLAG=“T”；finaldoublePI=3.14；一般情況下常量的public等修飾符不可少。類變量（靜態(tài)變量）及實(shí)例變量一個(gè)或多個(gè)英文單詞的組合，第一個(gè)單詞的首字母小寫，其他單詞首字母均大寫，其余所有字母均小寫。如:privateProjectSesprojectSes;privatestaticStringproviderUrl=“”;privateLoggerlogger=Logging.getLogger("TestLogger");一般情況下類變量（靜態(tài)變量）及實(shí)例變量的public等修飾符不可少。局部變量一個(gè)或多個(gè)英文單詞的組合，一般采用Hungarynnaming法（匈牙利定義法），如下：以下是基本數(shù)據(jù)類型的前綴列表前綴含義實(shí)例ch表示char類型charchTemp;i表示int類型intiNumber;byte表示Byte類型bytebyteGet;s表示short類型shortsNumber;l表示long類型longlNumber;f表示float類型floatfCount;d表示double類型doubledPrise;str表示String類型StringstrSend;b表示boolean類型BooleanbFlag;其他數(shù)據(jù)類型的前綴列表前綴含義實(shí)例col表示Collection類型CollectioncolUser=newArrayList();CollectioncolUser=newVector();lst表示List類型ListlstUser=newArrayList();date表示Date類型DatedateStart=newDate();sb表示StringBuffer類型StringBuffersbName=newStringBuffer(1024)除上述情況以外的數(shù)據(jù)類型，都以obj作為前綴，后面跟一個(gè)能說明變量功能或意義單詞作為變量，如：UserVOobjUserVO;參數(shù)一個(gè)或多個(gè)英文單詞的組合，第一個(gè)單詞的首字母小寫，其他單詞首字母均大寫，其余所有字母均小寫。如:publicvoidsetProjectVO(ProjectVOprojectVO)publicvoidsetUserId(StringuserId)建議方法的參數(shù)不要超過5個(gè)，超過時(shí)可以將多個(gè)參數(shù)合并為一個(gè)對象進(jìn)行傳遞。其它常用數(shù)據(jù)類型的變量，采用固定的命名，包括以下幾種:Connectionconn；ResultSetrs；PreparedStatementpstmt；Statementstmt；數(shù)組變量命名與普通變量命名規(guī)則一致，如：intiProjectId[];publicStringuserName[];每個(gè)變量的聲明單獨(dú)占一行。不能一個(gè)類型同時(shí)聲明兩個(gè)變量。如：inti,j;這樣的寫法是不允許的。不要在代碼中出現(xiàn)不使用的變量，如果以后會(huì)用到或有其他用途要寫上注釋說明。類名、變量名中含縮寫詞組：縮寫詞組全部大寫，如:StringstrSQL;publicclassProjectDAO{}方法的命名規(guī)則方法命名的基本原則：容易看懂一般的方法名采用兩個(gè)單詞動(dòng)賓結(jié)構(gòu)形式的名稱，兩個(gè)單詞之間不要帶其它符號，第二個(gè)單詞的首字母大寫，其它的都小寫。如：readBudget(intbudgetId)、deleteBudget(intbudgetId)只有一個(gè)動(dòng)詞形式的方法名不推薦使用。不容易看明白的方法名或有歧義的方法名可采用多單詞的形式，每兩個(gè)單詞之間不要帶其它符號，從第二個(gè)單詞開始，每個(gè)單詞的首字母大寫，其它的都小寫。如：readBudgetByProjectId(intprojectId)、readBudgetByProjectIdAndYear(intprojectId,intyear)方法命名不得采用縮寫形式。類及接口的命名規(guī)則一般類名一個(gè)或多個(gè)英文單詞的組合，所有單詞的首字母大寫，其余所有字母均小寫，如：publicclassProjectUser{}值對象數(shù)據(jù)庫表的邏輯名+VO，如：表PUB_DICTIONARY的值對象名為DictionaryVO。Action表名/模塊名+Action，如：字典的Action類名為DictionaryAction。MyBatis配置文件表名/模塊名+SQL.xml，如：字典模塊的MyBatis配置文件命名為DictionarySQL.xml。DAODAO類名為模塊名+DAO，如：字典DAO類名為：DictionaryDAOApplicationServiceApplicationService類名為模塊名+AppService，如：字典ApplicationService類名為：DictionaryAppService工具類工具類的類名為模塊名+Util，如：字典的工具類名為：DictionaryUtil門面類門面類的類名為模塊名+Facade，如：字典的門面類名為：DictionaryFacade代理類代理類的類名為模塊名+Man，如：字典的代理類名為：DictionaryMan異常類異常類的類名為模塊名+Exception，如：字典的異常類名為：DictionaryException接口類接口類的類名為模塊名+Interface，如：字典的接口類名為：DictionaryInterface接口實(shí)現(xiàn)類接口實(shí)現(xiàn)類的類名為實(shí)現(xiàn)名+Imp，如：字典的接口實(shí)現(xiàn)類名為：DictionaryImp作用域類的作用域類的作用域保持最小范圍。供包外其它類引用的類才添加public作用域修飾符。方法的作用域只供對象或類內(nèi)部調(diào)用的方法必須使用private作用域修飾符。包外不會(huì)調(diào)用的方法嚴(yán)禁使用public作用域修飾符。屬性的作用域靜態(tài)常量（類常量）屬性可以使用各種作用域修飾符。對象屬性變量嚴(yán)禁使用public作用域修飾符。VO對象屬性變量必須使用private作用域修飾符。局部變量的作用域方法內(nèi)的變量定義應(yīng)該遵循最小作用域規(guī)則。如：//iSize只在下面的for循環(huán)中使用intiSize=alItems.size();for(inti=0;i<iSize;i++){ ……………….}建議寫成：for(inti=0,iSize=alItems.size();i<iSize;i++){ ……………….}屬性是對象的特征，不要把非對象的屬性定義為實(shí)例變量。注釋的編寫規(guī)則所有類及接口文件要寫文件頭注釋(包含版權(quán)等)，版權(quán)中的年度代碼書寫的開始年度(Copyright(C)2021)，如下：/*******************************************************************************Copyright(C)2021SunLineInformationTechnologyCo.,Ltd*AllRightsReserved.*本軟件為SunLine開發(fā)研制。未經(jīng)本公司正式書面同意，其他任何個(gè)人、團(tuán)體不得使用、*復(fù)制、修改或發(fā)布本軟件.*****************************************************************************/所有類及接口頭要寫類注釋（包含作者、創(chuàng)建日期等），@author、@history中要書寫中文名，如果注釋的內(nèi)容比較長則需要加“<br>”。如下:/***技改項(xiàng)目業(yè)務(wù)代表實(shí)現(xiàn)類.實(shí)現(xiàn)新增項(xiàng)目,刪除項(xiàng)目等方法，<br>*提供對表現(xiàn)層的接口.*@author張三*@sinceJDK1.4*@history2021-10-15張三新建*/類中必要的方法(包括私有方法)要寫方法頭注釋。其中返回值(@return)需要說明含義,包括整型,布爾型,集合等,如對于整形：@return返回1表示成功，0表失??；對于集合類型要寫明集合內(nèi)元素的類型：@returnUserVO的集合。如果注釋的內(nèi)容比較長則需要加“<br>”，如下：/***修改投標(biāo)人信息*@parambidderVO投標(biāo)人信息*@throwsBidderException修改異常*@throwsNoPermissionException沒有修改權(quán)限*@return修改成功返回1沒有修改返回0*/publicintupdateBidder(BidderVObidderVO)throwsBidderException對代碼塊的注釋，注釋語句放在代碼塊之上，用”//”進(jìn)行注釋，如果注釋語句本身超過一行，則用”/**/”進(jìn)行注釋。對某一行代碼的注釋，注釋語句放在代碼行的后面，用”//”進(jìn)行注釋。建議代碼塊之間空一行。如下：publicvoidinsertProject(ProjectVOprojectVO){ //新增項(xiàng)目信息 iProjectId=Toolkit.getInstance().getNextKey("Project");//取項(xiàng)目IDlogger.debug("GenerateProjectID:"+iProjectId);ProjectobjProject=projectHome.create(iProjectId);objProject.setProjectVO(projectVO);<空一行>/*從項(xiàng)目VO中取得申請人ID及聯(lián)系人ID，并將申請人ID及聯(lián)系人ID插入到PUB_ACCESS_CONTROL表*/projectVO.setProjectId(iProjectId);this.authProject(projectVO);}格式引入公司指定的格式化配置文件最新版本，使用Eclipse的格式化功能進(jìn)行代碼格式化?？s進(jìn)設(shè)定為4個(gè)字符。每代碼行的長度代碼行的長度不超過120個(gè)字符。大括號大括號中的“{”與條件在同一行，“}”單獨(dú)一行，即使大括號中只有一條執(zhí)行語句也要使用大括號，如：if(a==b){return0;}空行類文件頭注釋、package語句、import語句、類頭注釋、類的屬性、方法等之間都空一行。類的屬性與屬性之間、方法與方法之間都空一行。如下：/*******************************************************************************Copyright(C)2021SunLineInformationTechnologyCo.,Ltd*AllRightsReserved.*本軟件為SunLine開發(fā)研制。未經(jīng)本公司正式書面同意，其他任何個(gè)人、團(tuán)體不得使用、*復(fù)制、修改或發(fā)布本軟件.*****************************************************************************/<空一行>packagejectinfo.exception;<空一行>importtop.util.BaseException;<空一行>/***公共項(xiàng)目管理異常類.*@author張三*@sinceJDK1.4*@history2021-03-15張三新建*/publicclassProjectExceptionextendsBaseException{privateStringmessage; <空一行>/** ...... */publicProjectException(Stringmessage){super(message);this.message=message;}<空一行>/** ......*/publicStringgetMessage(){returnmessage;}}空格“=”、“+”、“==”等二元操作符兩邊分別空一格。如：inti=1;“，”的后面空一格。如：implementsRunnable,cloneableimport部分import引用要具體到類名，不能用“*”。import語句書寫的順序?yàn)椋篔ava標(biāo)準(zhǔn)類，第三方軟件類庫，本公司自己的組件類、本工程其他包中的類。這四部分之間分別空一行。所有需要用到的其他包的類都要在import中應(yīng)用，不要將類似“newjava.util.ArrayList()”的語句寫在代碼中。數(shù)字long、double、float型變量后的字母“L”、“D”、“F”均大寫。16進(jìn)制的前綴“0X”要大寫“X”，數(shù)字部分“A”“F”要大寫。代碼中不要直接使用數(shù)字（-1，0，1除外），要先對數(shù)字進(jìn)行變量聲明。性能與安全靜態(tài)檢查插件有tptp-analysis、PMD、findbugs、checkStyle、commontools共5個(gè)插件做為代碼自檢的標(biāo)準(zhǔn)工具。按照給定的最新版插件配置文件檢查，識別問題原因及改進(jìn)范圍，在上傳配置庫前改進(jìn)代碼格式及性能。空指針引用(nullpointerdereference)在使用或引用對象前，要先對其進(jìn)行檢查，判斷其是否為空。數(shù)組引用問題(RETURNARRAY）不要直接返回指向包含敏感數(shù)據(jù)的內(nèi)部數(shù)組的引用。不要傳回一個(gè)數(shù)組，而是數(shù)組的拷貝。硬編碼敏感數(shù)據(jù)(Hard-codedsensedata)應(yīng)該將敏感數(shù)據(jù)保存在屬性文件中，無論什么時(shí)候需要這些數(shù)據(jù)，都可以從該文件讀取。如果數(shù)據(jù)極其敏感，那么在訪問屬性文件時(shí)，應(yīng)用程序應(yīng)該使用一些加密／解密技術(shù)，避免導(dǎo)致敏感數(shù)據(jù)泄露。整數(shù)溢出應(yīng)該對所有整數(shù)計(jì)算的結(jié)果進(jìn)行檢查，防止整數(shù)溢出。對象初始化對變量的使用不要依賴于初始化。在使用對象之前，應(yīng)該檢查對象的初始化過程。可以采用如下方法實(shí)現(xiàn)：在每個(gè)類中都應(yīng)該有一個(gè)在構(gòu)造器中設(shè)置的私有布爾標(biāo)志，在每個(gè)非static方法中，代碼在任何進(jìn)一步執(zhí)行之前都應(yīng)該檢查該標(biāo)志的值。如果該標(biāo)志的值為true，那么控制應(yīng)該進(jìn)一步繼續(xù)；否則，控制應(yīng)該拋出一個(gè)例外并停止執(zhí)行。集合對象初始化容量在初始化StringBuffer、集合類（List、Set、Map）等時(shí)，一般要指定對象的初始化容量，避免不必要的空間浪費(fèi)，提升性能。StringBuffer的初始化容量比PMD插件檢查后給出的建議值大一些的值；List、Set初始化容量可設(shè)置為估計(jì)值；Map初始化容量可設(shè)置為估計(jì)值的2倍到3倍。簡單參數(shù)方法調(diào)用時(shí)，傳入的參數(shù)應(yīng)該是一個(gè)具體對象，而不是一個(gè)嵌套另一個(gè)方法。比如類似“this.a(b(c()))”，要將方法的返回值賦給變量再作為參數(shù)傳遞。Final類和方法應(yīng)該將不允許擴(kuò)展的類和方法應(yīng)該聲明為final，這樣可以防止系統(tǒng)外的代碼擴(kuò)展類并修改類的行為。避免使用非final的公共靜態(tài)變量。無用的代碼應(yīng)該將（除啟動(dòng)應(yīng)用程序的main()方法之外的）main()方法、未使用的方法以及死代碼從應(yīng)用程序代碼中除去。調(diào)試使用的控制臺(tái)輸出語句(System.out.println)在調(diào)試結(jié)束后要?jiǎng)h除。日志級別使用正確的日志級別輸出，注意info、warning、debug、error等級別的使用場合。禁止使用debug級別輸出錯(cuò)誤信息，禁止使用errror級別輸出調(diào)試信息。序列化問題在包含系統(tǒng)資源的直接句柄和相對地址空間信息的字段前應(yīng)該使用transient關(guān)鍵字。如果資源，如文件句柄，不被聲明為transient，該對象在序列化狀態(tài)下可能會(huì)被修改，從而使得被反序列化后獲取對資源的不當(dāng)訪問。為了確保反序列化對象不包含違反一些不變量集合的狀態(tài)，類應(yīng)該定義自己的反序列化方法并使用ObjectInputValidation接口驗(yàn)證這些變量。為了保護(hù)虛擬機(jī)外的字節(jié)流，可以對序列化包產(chǎn)生的流進(jìn)行加密。字節(jié)流加密防止解碼或讀取被序列化的對象的私有狀態(tài)。如果決定加密，應(yīng)該管理好密鑰，密鑰的存放地點(diǎn)以及將密鑰交付給反序列化程序的方式等。如果一個(gè)類定義了自己的序列化方法，它就不能向任何DataInput/DataOuput方法傳遞內(nèi)部數(shù)組。所有的DataInput/DataOuput方法都能被重寫。注意默認(rèn)序列化不會(huì)向DataInput/DataOuput字節(jié)數(shù)組方法暴露私有字節(jié)數(shù)組字段。通過名稱比較類在那些非得根據(jù)名稱來比較類的情況下，必須確保使用了當(dāng)前類的ClassLoader的當(dāng)前名稱空間，如下面示例中所示的一種更好的比較方法：if(obj.getClass()==this.getClassLoader().loadClass("com.bar.Vnet")){//object'sclassisequalto//theclassthatthisclasscalls"com.bar.Vnet"}else{//object'sclassisnotequaltotheclassthat//thisclasscalls"com.bar.Vnet"}比較類的更好方法是直接比較類對象看它們是否相等：if(a.getClass()==b.getClass()){//objectshavethesameclass}else{//objectshavedifferentclasses}應(yīng)該盡可能少用直接名稱比較。類克隆除非有明確的需求，否則要保證你定義的類是不可克隆的。要使類不可被復(fù)制，只要在每個(gè)類里定義如下方法：publicfinalObjectclone()?throwsjava.lang.CloneNotSupportedException{thrownewjava.lang.CloneNotSupportedException();}如果想讓您的類可克隆并且您已經(jīng)考慮了這一選擇的后果，請?jiān)谀愕念愔卸x一個(gè)為final的克隆方法publicfinalObjectclone()?super.clone();}JDBC使用SQL語句變量使用“？”綁定變量。在DAO中，所有SQL語句中的變量都要使用“？”來綁定變量，禁止直接拼湊變量到SQL語句中；查詢分頁數(shù)據(jù)方法中，避免取所有記錄的方式。在DAO中，查詢分頁數(shù)據(jù)的方法，不得使用取所有記錄出來后再分頁的方式，而要使用分頁SQL語句包裝方法。SQL語句不得在DAO外書寫。不得在DAO類外寫好SQL語句后傳入DAO執(zhí)行。查詢數(shù)據(jù)集合時(shí)要使用DAO方式，避免使用EntityBean查詢數(shù)據(jù)集合。SQL語句類中包含的SQL語句必須全部大寫(包括關(guān)鍵字、表名、字段名等)，如：SELECTPROJECT_NAMEFROMIMP_PROJECTWHEREPROJECT_ID=1EJB的EJB-QL中關(guān)鍵字(如WHERE等)必須全部大寫,實(shí)體類的別名為英文單詞(組合)且單詞首字母大寫，其余字母全部小寫。如：SELECTOBJECT(User)FROMUserASUserWHEREUser.Id=?1數(shù)據(jù)庫連接釋放數(shù)據(jù)庫訪問可使用EJB的EntityBean等，對數(shù)據(jù)集的訪問必須使用DAO方式。不管代碼是否失敗，均關(guān)閉對數(shù)據(jù)庫的連接。DAO層可使用iBatic等開源框架，如果是手工寫SQL語句訪問，必須在try語句的finilly塊中安全釋放數(shù)據(jù)庫連接。使用存儲(chǔ)過程對于復(fù)雜的數(shù)據(jù)庫操作應(yīng)該使用存儲(chǔ)過程。存儲(chǔ)過程具有更短運(yùn)行時(shí)間和更短的事務(wù)鎖，具有更高的運(yùn)行效率。第三方組件慎重使用第三方組件。如果必須使用第三方組件，那必須遵守以下原則：1、向你要重用的提供商詢問，是否用過findbugs或者類似的工具檢查組件，確保供應(yīng)商進(jìn)行過足夠的安全測試。2、在你購買之前要求一個(gè)findbugs的報(bào)告，這可能增加對組件的信任3、可以對使用的第三方組件進(jìn)行獨(dú)立的安全測試。附件

論大學(xué)生寫作能力寫作能力是對自己所積累的信息進(jìn)行選擇、提取、加工、改造并將之形成為書面文字的能力。積累是寫作的基礎(chǔ)，積累越厚實(shí)，寫作就越有基礎(chǔ)，文章就能根深葉茂開奇葩。沒有積累，胸?zé)o點(diǎn)墨，怎么也不會(huì)寫出作文來的。寫作能力是每個(gè)大學(xué)生必須具備的能力。從目前高校整體情況上看，大學(xué)生的寫作能力較為欠缺。一、大學(xué)生應(yīng)用文寫作能力的定義那么，大學(xué)生的寫作能力究竟是指什么呢？葉圣陶先生曾經(jīng)說過，“大學(xué)畢業(yè)生不一定能寫小說詩歌，但是一定要寫工作和生活中實(shí)用的文章，而且非寫得既通順又扎實(shí)不可?！睂τ诖髮W(xué)生的寫作能力應(yīng)包含什么，可能有多種理解，但從葉圣陶先生的談話中，我認(rèn)為：大學(xué)生寫作能力應(yīng)包括應(yīng)用寫作能力和文學(xué)寫作能力，而前者是必須的，后者是“不一定”要具備，能具備則更好。眾所周知，對于大學(xué)生來說，是要寫畢業(yè)論文的，我認(rèn)為寫作論文的能力可以包含在應(yīng)用寫作能力之中。大學(xué)生寫作能力的體現(xiàn)，也往往是在撰寫畢業(yè)論文中集中體現(xiàn)出來的。本科畢業(yè)論文無論是對于學(xué)生個(gè)人還是對于院系和學(xué)校來說，都是十分重要的。如何提高本科畢業(yè)論文的質(zhì)量和水平，就成為教育行政部門和高校都很重視的一個(gè)重要課題。如何提高大學(xué)生的寫作能力的問題必須得到社會(huì)的廣泛關(guān)注，并且提出對策去實(shí)施解決。二、造成大學(xué)生應(yīng)用文寫作困境的原因：（一）大學(xué)寫作課開設(shè)結(jié)構(gòu)不合理。就目前中國多數(shù)高校的學(xué)科設(shè)置來看，除了中文專業(yè)會(huì)系統(tǒng)開設(shè)寫作的系列課程外，其他專業(yè)的學(xué)生都只開設(shè)了普及性的《大學(xué)語文》課。學(xué)生寫作能力的提高是一項(xiàng)艱巨復(fù)雜的任務(wù)，而我們的課程設(shè)置僅把這一任務(wù)交給了大學(xué)語文教師，可大學(xué)語文教師既要在有限課時(shí)時(shí)間內(nèi)普及相關(guān)經(jīng)典名著知識，又要適度提高學(xué)生的鑒賞能力，且要教會(huì)學(xué)生寫作規(guī)律并提高寫作能力，任務(wù)之重實(shí)難完成。（二）對實(shí)用寫作的普遍性不重視。“大學(xué)語文”教育已經(jīng)被嚴(yán)重地“邊緣化”。目前對中國語文的態(tài)度淡漠，而是呈現(xiàn)出全民學(xué)英語的大好勢頭。中小學(xué)如此，大學(xué)更是如此。對我們的母語中國語文，在大學(xué)反而被漠視，沒有相關(guān)的課程的設(shè)置，沒有系統(tǒng)的學(xué)習(xí)實(shí)踐訓(xùn)練。這其實(shí)是國人的一種偏見。應(yīng)用寫作有它自身的規(guī)律和方法。一個(gè)人學(xué)問很大，會(huì)寫小說、詩歌、戲劇等，但如果不曉得應(yīng)用文寫作