JAVA編碼規(guī)范和指南培訓(新改)

稅友軟件集團

Java編碼標準和指南培訓納稅事業(yè)部/王偉20211125課程目標使開發(fā)人員認識到編碼標準和指南存在的意義對公司的?開發(fā)編碼標準(JAVA)?、?JAVA編碼指南?、?JavaScript編碼標準?和?J2EE工程開發(fā)命名標準?等文檔做一簡介，使開發(fā)人員對此有個總體印象，知道在以后的工作中需要遵守這些標準通過對公司編碼標準和編碼指南的介紹，使得開發(fā)人員了解到其側(cè)重點WWW.JDLSSOFT.COM.CN整理pptPPT概要制定編碼規(guī)范和指南的意義JAVA編碼規(guī)范包括的幾個方面JAVA編碼指南包括的幾個方面JAVA編碼規(guī)范相關(guān)文檔代碼檢查工具介紹及使用WWW.JDLSSOFT.COM.CN整理ppt一、編碼標準的目的宗旨：為了開發(fā)小組能夠在編碼過程中遵循一致的風格，使得代碼閱讀者能夠非常清晰的各個成員編寫的代碼，使得維護人員能夠很好的繼承前輩的代碼，制定編碼標準；編碼工程師：負責按編碼標準實施編碼工作。代碼審核人：負責按編碼標準審核代碼。WWW.JDLSSOFT.COM.CN整理ppt二、編碼指南的目的宗旨：為了提高團隊編程的質(zhì)量、協(xié)同性、標準性，需要對工程的編碼過程作出指導和約束；同時也作為概要設(shè)計、詳細設(shè)計的補充，及測試的依據(jù)。每個工程都需要結(jié)合工程實際情況制定相應的編碼指南工程組織者：在編碼開始前根據(jù)公司編碼指南模板，對其進行裁剪和細化，于工程編碼前公布，并組織對全體編碼人員、測試人員進行培訓，作為工程級標準必須遵守，同時指定本工程各種規(guī)定的負責人、檢查人。編碼人員：深入理解本工程編碼指南中所要求的一些約束、規(guī)定，如是編碼指南中某個方面的負責人，那么還需要切實檢查并催促其他編碼人員遵循這些規(guī)定。WWW.JDLSSOFT.COM.CN整理ppt三、編碼標準與編碼指南編碼標準是一組相對靜態(tài)的標準，而工程指南是工程組內(nèi)相對動態(tài)的；編碼標準是針對編碼的成果，而編碼指南是針對工程編碼的過程；編碼指南是貫徹編碼標準的一種較好的方法，工程組內(nèi)沒有制定或沒有很好的執(zhí)行編碼指南，通常會造成代碼成果沒有什么標準性編碼指南除了對工程內(nèi)編碼標準作出指南之外，還要關(guān)注很多方面，比方開發(fā)框架、命名約定等內(nèi)容WWW.JDLSSOFT.COM.CN整理pptPPT概要制定編碼規(guī)范和指南的意義JAVA編碼規(guī)范包括的幾個方面JAVA編碼指南包括的幾個方面JAVA編碼規(guī)范相關(guān)文檔代碼檢查工具介紹及使用WWW.JDLSSOFT.COM.CN整理pptJAVA編碼標準包括的幾個方面源代碼格式和文件樣式版權(quán)信息、類注釋、javadoc、縮進、頁寬等命名標準包名、類名、方法名、變量名等的通用標準程序編寫標準clone、final、垃圾收集等一些編程約束和技巧一些經(jīng)驗和建議，時至今日，依然有價值WWW.JDLSSOFT.COM.CN整理pptPPT概要制定編碼規(guī)范和指南的意義JAVA編碼規(guī)范包括的幾個方面JAVA編碼指南包括的幾個方面JAVA編碼規(guī)范相關(guān)文檔代碼檢查工具介紹及使用WWW.JDLSSOFT.COM.CN整理pptJAVA編碼指南包括的幾個方面開發(fā)環(huán)境、技術(shù)框架、工程結(jié)構(gòu)及命名規(guī)定開發(fā)方面標準和約束的關(guān)鍵要素編碼過程負責人分工WWW.JDLSSOFT.COM.CN整理ppt一、開發(fā)環(huán)境、工程結(jié)構(gòu)及命名規(guī)定工程開發(fā)架構(gòu)開發(fā)架構(gòu)、使用框架〔交大龍山架構(gòu)、擴展包、Struts等等〕、開發(fā)流程等工程開發(fā)環(huán)境WEB層目錄結(jié)構(gòu)、代碼包結(jié)構(gòu)目錄、配置文件命名等例global、images、scripts、pages/模塊名等cn.jdlssoft.系統(tǒng)名.web.模塊名.actionsWEB-INF/config/目錄EJB層代碼包結(jié)構(gòu)目錄、配置文件目錄編譯和打包結(jié)構(gòu)、打包腳本W(wǎng)WW.JDLSSOFT.COM.CN整理pptJAVA編碼指南包括的幾個方面開發(fā)環(huán)境、技術(shù)框架、工程結(jié)構(gòu)及命名規(guī)定開發(fā)方面標準和約束的關(guān)鍵要素編碼過程負責人分工WWW.JDLSSOFT.COM.CN整理ppt二、開發(fā)方面標準和約束的關(guān)鍵要素界面約束公共方法與函數(shù)常量類提示信息日志注釋WWW.JDLSSOFT.COM.CN整理ppt2.1、界面編碼約束頁面元素使用規(guī)那么文本輸入框、日期輸入框、金額、小數(shù)、身份證頁面操作約定新增、刪除、修改、查詢、進度條、返回、退出頁面特殊字符處理URLEncoder.encodeConvertType.filterWWW.JDLSSOFT.COM.CN整理ppt2.2、公共方法與函數(shù)架構(gòu)級的工具類SysUtil、StringUtil、FileUtil等擴展包中BaseCode頁面上進行代碼/名稱轉(zhuǎn)換、下拉框選擇工程自定義的公共方法工程級、模塊級JS公共函數(shù)及工具組件

WWW.JDLSSOFT.COM.CN整理ppt2.3、常量類***Constants類中自定義的常量對象

公共的常量類模塊級的常量類模塊目錄下層次級的常量類層次目錄下工程級的常量類common目錄下WWW.JDLSSOFT.COM.CN整理ppt2.4、提示信息頁面方式提示提示信息頁面/global/info.jsp錯誤信息頁面/global/error.jsp

警告信息頁面/global/warn.jsp錯誤、提示信息號碼段

Messages.getInstance().getMessage("8100",param)異常處理的機制與提示信息的結(jié)合底層業(yè)務處理出錯時，設(shè)置好相應的MsgCode，逐級向上拋出異常直到頁面層，頁面層根據(jù)相關(guān)開發(fā)框架，跳轉(zhuǎn)到相應的提示信息頁面WWW.JDLSSOFT.COM.CN整理ppt2.5、日志、注釋標準日志配置文件日志級別要求異常、錯誤、警告、提示、調(diào)試Log的記載格式為:錯誤編碼-<模塊名>業(yè)務處理名稱：錯誤信息；注釋標準注釋應該采用標準的JavaDoc注釋方法類文件、函數(shù)、數(shù)據(jù)結(jié)構(gòu)、處理邏輯、全局變量和常量都要注釋WWW.JDLSSOFT.COM.CN整理ppt2.5、日志、注釋標準packagecn.servyou.sszsk.webimportjava.util.ArrayList;/***<p>Title:稅收知識庫系統(tǒng)action基類</p>**<p>Description:稅收知識庫系統(tǒng)action基類，所有的action都要繼承本類*由本來通過command調(diào)用具體的receiver類，有如下一些可以被公用的方法*</p>**<p>Copyright:Copyright(c)2021-2021稅友集團</p>**<p>Company:稅友集團</p>**@authorservyou**@version1.0*/publicclassProjectBaseSearchActionextendsBaseSearchAction{WWW.JDLSSOFT.COM.CN整理pptJAVA編碼指南包括的幾個方面開發(fā)環(huán)境、技術(shù)框架、工程結(jié)構(gòu)及命名規(guī)定開發(fā)方面標準和約束的關(guān)鍵要素編碼過程負責人分工WWW.JDLSSOFT.COM.CN整理ppt三、編碼過程負責人分工集成打包負責人ant腳本：包結(jié)構(gòu)、頁面目錄、代碼目錄、配置目錄公共JS負責人公共JS的統(tǒng)一維護；同時負責檢查頁面元素使用規(guī)那么，輸入框、下拉框等等；以及前臺提示信息對話框標準性的檢查公共方法與函數(shù)、常量類負責人工具類、baseCode、常量類統(tǒng)一維護，公共方法要及時提??；同時負責代碼中公共方法使用情況的檢查配置文件管理負責人配置文件的管理：命名標準性、模塊劃分標準性；公共配置文件的統(tǒng)一維護：poolconfig等提示信息、日志、注釋負責人代碼中標準的檢查：日志的級別、標準性、注釋的遺漏、標準性等等；提示信息號碼的分配，代碼中號碼使用正確性的檢查；WWW.JDLSSOFT.COM.CN整理pptPPT概要制定編碼規(guī)范和指南的意義JAVA編碼規(guī)范包括的幾個方面JAVA編碼指南包括的幾個方面JAVA編碼規(guī)范相關(guān)文檔代碼檢查工具介紹及使用WWW.JDLSSOFT.COM.CN整理pptJAVA編碼標準相關(guān)文檔開發(fā)編碼標準(JAVA)

JAVA編碼指南

JavaScript編碼標準

J2EE工程開發(fā)命名標準WWW.JDLSSOFT.COM.CN整理pptJavaScript編碼標準目的：為了重視頁面層的開發(fā)，為了標準公司J2EE工程開發(fā)中對JS的使用,增強工程的可讀性，降低交流本錢，以公司目前工程開發(fā)的實際情況為根底，制定出公司JS開發(fā)標準總那么：在J2EE工程開發(fā)中，頁面開發(fā)不是二等公民；JavaScript代碼也是代碼，需要象對待Java一樣來對待；使用第三方框架如prototype、dwr時，應該使用原版的而不用壓縮、混淆版的；應該考慮發(fā)布版與開發(fā)版的區(qū)別對待，對于重要的、自主研發(fā)的js文件，發(fā)布版中應該混淆、壓縮；應該采用面向?qū)ο蟮乃枷雽s代碼進行管理、書寫；WWW.JDLSSOFT.COM.CN整理pptJavaScript編碼標準JS目錄結(jié)構(gòu)

JS源代碼格式標準

JS文件樣式約定

JS編程約束和技巧WWW.JDLSSOFT.COM.CN整理pptJS目錄結(jié)構(gòu)公司級公用的JavaScript文件放在scripts目錄的servyou下；工程級公用的JavaScript文件放在scripts目錄的XX工程下；第三方的JavaScript文件〔可能還包含一些頁面，CSS，images等〕放在scripts下，新建一個目錄；與頁面相關(guān)的JavaScript文件和頁面放在同一個目錄下，命名同頁面名稱〔如果同一模塊的多個頁面使用同一個js文件，該文件的命名應該與該模塊名相關(guān)，如fxxa_manage.js?！砏WW.JDLSSOFT.COM.CN整理pptJS源代碼格式標準應該采用面向?qū)ο蟮姆绞饺ス芾?、書寫函?shù)和變量

；每行長度縮進關(guān)于空格

WWW.JDLSSOFT.COM.CN整理pptJS一些編程約束和技巧JS的壓縮與混淆怎樣刷新JS腳本由于瀏覽器緩存引起的錯誤Ctrl+F5刷新，或者<scriptlanguage="JavaScript"src="./scripts/common.js?v=1.0.002"></script>

引入太大的JS文件，影響瀏覽器的速度，要做到按需加載和拆分JS代碼段在頁面中的位置，對頁面解析效率的影響WWW.JDLSSOFT.COM.CN整理pptPPT概要制定編碼規(guī)范和指南的意義JAVA編碼規(guī)范包括的幾個方面JAVA編碼指南包括的幾個方面JAVA編碼規(guī)范相關(guān)文檔代碼檢查工具介紹及使用WWW.JDLSSOFT.COM.CN整理ppt代碼檢查工具