1、稅友軟件集團(tuán)Java編碼規(guī)范和指南培訓(xùn),納稅事業(yè)部/王偉,20091125,WWW.JDLSSOFT.COM.CN,A,2,課程目標(biāo),使開發(fā)人員認(rèn)識(shí)到編碼規(guī)范和指南存在的意義 對(duì)公司的開發(fā)編碼規(guī)范(JAVA)、JAVA編碼指南、JavaScript編碼規(guī)范和J2EE項(xiàng)目開發(fā)命名標(biāo)準(zhǔn)等文檔做一簡(jiǎn)介，使開發(fā)人員對(duì)此有個(gè)總體印象，知道在以后的工作中需要遵守這些規(guī)范 通過(guò)對(duì)公司編碼規(guī)范和編碼指南的介紹，使得開發(fā)人員了解到其側(cè)重點(diǎn),WWW.JDLSSOFT.COM.CN,A,3,PPT概要,WWW.JDLSSOFT.COM.CN,A,4,一、編碼規(guī)范的目的,宗旨：為了開發(fā)小組能夠在編碼過(guò)程中遵循一致的風(fēng)

2、格，使得代碼閱讀者能夠非常清晰的各個(gè)成員編寫的代碼，使得維護(hù)人員能夠很好的繼承前輩的代碼，制定編碼規(guī)范； 編碼工程師：負(fù)責(zé)按編碼規(guī)范實(shí)施編碼工作 。 代碼審核人：負(fù)責(zé)按編碼規(guī)范審核代碼 。,WWW.JDLSSOFT.COM.CN,A,5,二、編碼指南的目的,宗旨： 為了提高團(tuán)隊(duì)編程的質(zhì)量、協(xié)同性、規(guī)范性，需要對(duì)項(xiàng)目的編碼過(guò)程作出指導(dǎo)和約束；同時(shí)也作為概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)的補(bǔ)充，及測(cè)試的依據(jù)。 每個(gè)項(xiàng)目都需要結(jié)合項(xiàng)目實(shí)際情況制定相應(yīng)的編碼指南 項(xiàng)目組織者：在編碼開始前根據(jù)公司編碼指南模板，對(duì)其進(jìn)行裁剪和細(xì)化，于項(xiàng)目編碼前公布，并組織對(duì)全體編碼人員、測(cè)試人員進(jìn)行培訓(xùn)，作為項(xiàng)目級(jí)規(guī)范必須遵守，同時(shí)指定

3、本項(xiàng)目各種規(guī)定的負(fù)責(zé)人、檢查人。 編碼人員：深入理解本項(xiàng)目編碼指南中所要求的一些約束、規(guī)定，如是編碼指南中某個(gè)方面的負(fù)責(zé)人，則還需要切實(shí)檢查并督促其他編碼人員遵循這些規(guī)定。,WWW.JDLSSOFT.COM.CN,A,6,三、編碼規(guī)范與編碼指南,編碼規(guī)范是一組相對(duì)靜態(tài)的規(guī)范，而項(xiàng)目指南是項(xiàng)目組內(nèi)相對(duì)動(dòng)態(tài)的； 編碼規(guī)范是針對(duì)編碼的成果，而編碼指南是針對(duì)項(xiàng)目編碼的過(guò)程； 編碼指南是貫徹編碼規(guī)范的一種較好的方法，項(xiàng)目組內(nèi)沒(méi)有制定或沒(méi)有很好的執(zhí)行編碼指南，通常會(huì)造成代碼成果沒(méi)有什么規(guī)范性 編碼指南除了對(duì)項(xiàng)目?jī)?nèi)編碼規(guī)范作出指南之外，還要關(guān)注很多方面，比如開發(fā)框架、命名約定等內(nèi)容,WWW.JDLSSOFT

4、.COM.CN,A,7,PPT概要,WWW.JDLSSOFT.COM.CN,A,8,JAVA編碼規(guī)范包括的幾個(gè)方面,源代碼格式和文件樣式 版權(quán)信息、類注釋、javadoc、縮進(jìn)、頁(yè)寬等 命名規(guī)范 包名、類名、方法名、變量名等的通用規(guī)范 程序編寫規(guī)范 clone、final、垃圾收集等 一些編程約束和技巧 一些經(jīng)驗(yàn)和建議，時(shí)至今日，依然有價(jià)值,WWW.JDLSSOFT.COM.CN,A,9,PPT概要,WWW.JDLSSOFT.COM.CN,A,10,JAVA編碼指南包括的幾個(gè)方面,開發(fā)環(huán)境、技術(shù)框架、工程結(jié)構(gòu)及命名規(guī)定 開發(fā)方面規(guī)范和約束的關(guān)鍵要素 編碼過(guò)程負(fù)責(zé)人分工,WWW.JDLSSOFT

5、.COM.CN,A,11,一、開發(fā)環(huán)境、工程結(jié)構(gòu)及命名規(guī)定,項(xiàng)目開發(fā)架構(gòu) 開發(fā)架構(gòu)、使用框架（交大龍山架構(gòu)、擴(kuò)展包、Struts等等）、開發(fā)流程等 項(xiàng)目開發(fā)環(huán)境 WEB層目錄結(jié)構(gòu)、代碼包結(jié)構(gòu)目錄、配置文件命名等 例global、images、scripts、pages/模塊名等 .jdlssoft.系統(tǒng)名.web.模塊名.actions WEB-INF/config/目錄 EJB層代碼包結(jié)構(gòu)目錄、配置文件目錄 編譯和打包結(jié)構(gòu)、打包腳本,WWW.JDLSSOFT.COM.CN,A,12,JAVA編碼指南包括的幾個(gè)方面,開發(fā)環(huán)境、技術(shù)框架、工程結(jié)構(gòu)及命名規(guī)定 開發(fā)方面規(guī)范和約束的關(guān)鍵要素 編碼過(guò)程

6、負(fù)責(zé)人分工,WWW.JDLSSOFT.COM.CN,A,13,二、開發(fā)方面規(guī)范和約束的關(guān)鍵要素,界面約束 公共方法與函數(shù) 常量類 提示信息 日志 注釋,WWW.JDLSSOFT.COM.CN,A,14,2.1、界面編碼約束,頁(yè)面元素使用規(guī)則 文本輸入框、日期輸入框、金額、小數(shù)、身份證 頁(yè)面操作約定 新增、刪除、修改、查詢、進(jìn)度條、返回、退出 頁(yè)面特殊字符處理 URLEncoder.encode ConvertType.filter,WWW.JDLSSOFT.COM.CN,A,15,2.2、公共方法與函數(shù),架構(gòu)級(jí)的工具類 SysUtil、StringUtil、FileUtil等 擴(kuò)展包中Base

7、Code 頁(yè)面上進(jìn)行代碼/名稱轉(zhuǎn)換、下拉框選擇 項(xiàng)目自定義的公共方法 項(xiàng)目級(jí)、模塊級(jí) JS公共函數(shù)及工具組件,WWW.JDLSSOFT.COM.CN,A,16,2.3、常量類,*Constants 類中自定義的常量對(duì)象 公共的常量類 模塊級(jí)的常量類 模塊目錄下 層次級(jí)的常量類 層次目錄下 項(xiàng)目級(jí)的常量類 common目錄下,WWW.JDLSSOFT.COM.CN,A,17,2.4、提示信息,頁(yè)面方式提示 提示信息頁(yè)面/global/info.jsp 錯(cuò)誤信息頁(yè)面/global/error.jsp 警告信息頁(yè)面/global/warn.jsp 錯(cuò)誤、提示信息號(hào)碼段 Messages.getIns

8、tance().getMessage(8100, param) 異常處理的機(jī)制與提示信息的結(jié)合 底層業(yè)務(wù)處理出錯(cuò)時(shí)，設(shè)置好相應(yīng)的MsgCode，逐級(jí)向上拋出異常直到頁(yè)面層，頁(yè)面層根據(jù)相關(guān)開發(fā)框架，跳轉(zhuǎn)到相應(yīng)的提示信息頁(yè)面,WWW.JDLSSOFT.COM.CN,A,18,2.5、日志、注釋規(guī)范,日志配置文件 日志級(jí)別要求 異常、錯(cuò)誤、警告、提示、調(diào)試 Log的記載格式為: 錯(cuò)誤編碼-業(yè)務(wù)處理名稱：錯(cuò)誤信息； 注釋規(guī)范 注釋應(yīng)該采用標(biāo)準(zhǔn)的JavaDoc注釋方法 類文件、函數(shù)、數(shù)據(jù)結(jié)構(gòu)、處理邏輯、全局變量和常量都要注釋,WWW.JDLSSOFT.COM.CN,A,19,2.5、日志、注釋規(guī)范,pa

9、ckage .servyou.sszsk.web import java.util.ArrayList; /* * Title: 稅收知識(shí)庫(kù)系統(tǒng)action基類 * * Description: 稅收知識(shí)庫(kù)系統(tǒng)action基類，所有的action都要繼承本類 * 由本來(lái)通過(guò)command調(diào)用具體的receiver類，有如下一些可以被公用的方法 * * * Copyright: Copyright(c) 2009-2018 稅友集團(tuán) * * Company: 稅友集團(tuán) * * author servyou * * version 1.0 */ public class ProjectBaseSe

10、archAction extends BaseSearchAction ,WWW.JDLSSOFT.COM.CN,A,20,JAVA編碼指南包括的幾個(gè)方面,開發(fā)環(huán)境、技術(shù)框架、工程結(jié)構(gòu)及命名規(guī)定 開發(fā)方面規(guī)范和約束的關(guān)鍵要素 編碼過(guò)程負(fù)責(zé)人分工,WWW.JDLSSOFT.COM.CN,A,21,三、編碼過(guò)程負(fù)責(zé)人分工,集成打包負(fù)責(zé)人 ant腳本：包結(jié)構(gòu)、頁(yè)面目錄、代碼目錄、配置目錄 公共JS負(fù)責(zé)人 公共JS的統(tǒng)一維護(hù)；同時(shí)負(fù)責(zé)檢查頁(yè)面元素使用規(guī)則，輸入框、下拉框等等；以及前臺(tái)提示信息對(duì)話框規(guī)范性的檢查 公共方法與函數(shù)、常量類負(fù)責(zé)人 工具類、baseCode、常量類統(tǒng)一維護(hù)，公共方法要及時(shí)提??；

11、同時(shí)負(fù)責(zé)代碼中公共方法使用情況的檢查 配置文件管理負(fù)責(zé)人 配置文件的管理：命名規(guī)范性、模塊劃分規(guī)范性；公共配置文件的統(tǒng)一維護(hù)：poolconfig等 提示信息、日志、注釋負(fù)責(zé)人 代碼中規(guī)范的檢查：日志的級(jí)別、規(guī)范性、注釋的遺漏、規(guī)范性等等；提示信息號(hào)碼的分配，代碼中號(hào)碼使用正確性的檢查；,WWW.JDLSSOFT.COM.CN,A,22,PPT概要,WWW.JDLSSOFT.COM.CN,A,23,JAVA編碼規(guī)范相關(guān)文檔,開發(fā)編碼規(guī)范(JAVA) JAVA編碼指南 JavaScript編碼規(guī)范 J2EE項(xiàng)目開發(fā)命名標(biāo)準(zhǔn),WWW.JDLSSOFT.COM.CN,A,24,JavaScript編

12、碼規(guī)范,目的：為了重視頁(yè)面層的開發(fā)，為了規(guī)范公司J2EE項(xiàng)目開發(fā)中對(duì)JS的使用,增強(qiáng)項(xiàng)目的可讀性，降低交流成本，以公司目前項(xiàng)目開發(fā)的實(shí)際情況為基礎(chǔ)，制定出公司JS開發(fā)規(guī)范 總則： 在J2EE項(xiàng)目開發(fā)中，頁(yè)面開發(fā)不是二等公民； JavaScript代碼也是代碼，需要象對(duì)待Java一樣來(lái)對(duì)待； 使用第三方框架如prototype、dwr時(shí)，應(yīng)該使用原版的而不用壓縮、混淆版的； 應(yīng)該考慮發(fā)布版與開發(fā)版的區(qū)別對(duì)待，對(duì)于重要的、自主研發(fā)的js文件，發(fā)布版中應(yīng)該混淆、壓縮； 應(yīng)該采用面向?qū)ο蟮乃枷雽?duì)js代碼進(jìn)行管理、書寫；,WWW.JDLSSOFT.COM.CN,A,25,JavaScript編碼規(guī)范,J

13、S目錄結(jié)構(gòu) JS源代碼格式規(guī)范 JS文件樣式約定 JS編程約束和技巧,WWW.JDLSSOFT.COM.CN,A,26,JS目錄結(jié)構(gòu),公司級(jí)公用的JavaScript文件放在scripts目錄的servyou下； 項(xiàng)目級(jí)公用的JavaScript文件放在scripts目錄的XX項(xiàng)目下； 第三方的JavaScript文件（可能還包含一些頁(yè)面，CSS，images等）放在scripts下，新建一個(gè)目錄； 與頁(yè)面相關(guān)的JavaScript文件和頁(yè)面放在同一個(gè)目錄下，命名同頁(yè)面名稱（如果同一模塊的多個(gè)頁(yè)面使用同一個(gè)js文件，該文件的命名應(yīng)該與該模塊名相關(guān)，如fxxa_manage.js。）,WWW.JDLSSOFT.COM.CN,A,27,JS源代碼格式規(guī)范,應(yīng)該采用面向?qū)ο蟮姆绞饺ス芾?、書寫函?shù)和變量 ； 每行長(zhǎng)度 縮進(jìn) 關(guān)于空格,WWW.JDLSSOFT.COM.CN,A,28,JS一些編程約束和技巧,JS的壓縮與混淆 怎樣刷新JS腳本由于瀏覽器緩存引起的錯(cuò)誤 Ctrl+F5刷新，或者 引入太大的JS文件，影響瀏覽器的速度，要做到按需加載和拆分 JS代碼段在頁(yè)面中的位置，對(duì)頁(yè)面解析效率的影響,WWW.JDLSSOFT.COM.CN,A,29,PPT概要,WWW.JDLSSOFT.COM.CN,A,30,代碼檢查工具及使用