網(wǎng)站和BS軟件系統(tǒng)開(kāi)發(fā)需要的幾個(gè)技術(shù)規(guī)范

1、網(wǎng)站和B/S軟件系統(tǒng)開(kāi)發(fā)需要的幾個(gè)技術(shù)規(guī)范做項(xiàng)目越多，結(jié)識(shí)各種項(xiàng)目的人也就越多。從專注進(jìn)入軟件開(kāi)發(fā)行業(yè)開(kāi)始，就跟各種軟件項(xiàng)目結(jié)下不解之緣。以前在內(nèi)地公司干，總以為發(fā)達(dá)地區(qū)的軟件公司應(yīng)該是什么都好，如編碼規(guī)范、文檔、架構(gòu)設(shè)計(jì)等都一一俱全，但是在客戶現(xiàn)場(chǎng)看到的，大部份與我所想象的差距很大，要么沒(méi)規(guī)范，各自為政，只要能實(shí)現(xiàn)功能就行，要么規(guī)范只是一種擺設(shè)，基本不遵守。網(wǎng)站開(kāi)發(fā)和軟件開(kāi)發(fā)都一樣，都需要有一定的技術(shù)規(guī)范，否則很容易造成項(xiàng)目各組員之間的內(nèi)耗。有時(shí)一些小的細(xì)節(jié)問(wèn)題會(huì)造成很大的資源消耗，如果在項(xiàng)目開(kāi)始就不規(guī)范下來(lái)，在開(kāi)發(fā)過(guò)程中問(wèn)題會(huì)越積越多，導(dǎo)致返工、項(xiàng)目延期，嚴(yán)重的造成項(xiàng)目失敗。曾經(jīng)有位老大說(shuō)

2、，寫程序要像寫詩(shī)一樣，要有韻味，但是我覺(jué)得這種要求太太.太高了，我們一般就要求像寫小說(shuō)一樣，一段程序能把一件事情說(shuō)清楚就OK了，做到不看注釋，也能把程序看懂，這種要求其實(shí)不低，也要有一定的水準(zhǔn)才能寫得出來(lái)。那就按照這種要求來(lái)協(xié)助我們的員工完成這種標(biāo)準(zhǔn)吧。下面就把我經(jīng)歷和總結(jié)出來(lái)的一些東西分享一下，以便能讓自己時(shí)刻記住，也希望能幫到一些項(xiàng)目管理過(guò)程中遇到問(wèn)題的同學(xué)。 1、界面樣式規(guī)范界面樣式的要求對(duì)網(wǎng)站來(lái)說(shuō)是非常重要的一塊區(qū)域，網(wǎng)站好不好看，完全依賴美工的水平，而如果美工對(duì)樣式的把握不好，切出來(lái)的頁(yè)面雖然好看，但是可能會(huì)影響到網(wǎng)頁(yè)的打開(kāi)整度、網(wǎng)站seo的優(yōu)化等。比如我最開(kāi)始做網(wǎng)站的時(shí)候

3、，只會(huì)用table來(lái)對(duì)網(wǎng)站進(jìn)行布局，一個(gè)內(nèi)容非常多的網(wǎng)產(chǎn)首頁(yè)使用一個(gè)大table來(lái)進(jìn)行外層布局，然后再對(duì)大表格進(jìn)行單元格切分后顯示各個(gè)子模塊，這就導(dǎo)致訪問(wèn)網(wǎng)頁(yè)時(shí)半天都沒(méi)反應(yīng)，但是過(guò)幾秒后突然就崩出一個(gè)完整的界面，這就是網(wǎng)頁(yè)元素布局導(dǎo)致的，后面經(jīng)過(guò)朋友建議改成多個(gè)小表格，按布局改成流式的，讓網(wǎng)頁(yè)一部份一部分的顯示，打開(kāi)體驗(yàn)上一下得到極大改觀，雖然網(wǎng)頁(yè)并不是否下就加載完，但是對(duì)用戶來(lái)說(shuō)就不存在等待時(shí)間。這好比我們?cè)诙萝嚨臅r(shí)候，如果能慢慢的向前走，即使是很慢，心理也是比較愉快的，但是如果就讓你干等著，然后突然一下讓你加速通過(guò)，也會(huì)感覺(jué)到很煩惱，這是兩種完全不同的心理反應(yīng)，雖然結(jié)果可能是一樣的。當(dāng)然現(xiàn)

4、在都流行div+css進(jìn)行頁(yè)面設(shè)計(jì)，有些還需要嚴(yán)格按照w3c標(biāo)準(zhǔn)設(shè)計(jì)頁(yè)面，也基本上不存在我剛和說(shuō)到的情況了。但是一個(gè)好樣式規(guī)范，可以節(jié)省工美和程序員的雙重時(shí)間，也便于需求修改造成的返工消耗，不會(huì)導(dǎo)致修改一個(gè)小的樣式而影響其它地方。樣式名稱應(yīng)該與對(duì)應(yīng)模塊的功能一致，比如統(tǒng)一成英文的完整單詞。對(duì)于樣式命名，盡量使用class方式進(jìn)行html綁定，ID作為特殊屬性以備后用，比如頁(yè)面動(dòng)態(tài)效果上，可能需要用javascript來(lái)操作頁(yè)面，這就需要用到id屬性來(lái)取得頁(yè)面元素。樣式的作用范圍盡量小，否則可能會(huì)修改一個(gè)樣式屬性，導(dǎo)致整個(gè)頁(yè)面樣式全部改變。 頁(yè)面圖標(biāo)：頁(yè)面圖標(biāo)對(duì)一個(gè)風(fēng)頁(yè)或者軟件界面都是

5、不可或缺的裝飾成員。但是由于現(xiàn)象互聯(lián)網(wǎng)上的小圖標(biāo)非常多，如果不加以規(guī)范，每個(gè)美工或開(kāi)發(fā)人員都按照自己的喜好下載下來(lái)并放入系統(tǒng)，會(huì)導(dǎo)致很多比較奇葩的問(wèn)題。比如有些人喜歡把保存或確定按鈕使用勾勾圖標(biāo)，有些又使用磁盤類的圖片，取消按鈕用X或者減少圖標(biāo)，這就可能會(huì)造成用戶的潛意識(shí)錯(cuò)誤，把“關(guān)閉”按鈕當(dāng)成“取消”按鈕，導(dǎo)致所作的工作丟失。因?yàn)橛脩艉芏鄷r(shí)候并不在意某些組件的文字描述，而是根據(jù)習(xí)慣思維中的圖標(biāo)來(lái)操作。即使不出現(xiàn)這些錯(cuò)誤操作，相同作用但過(guò)多的圖標(biāo)也會(huì)造成項(xiàng)目管理混亂。在使用dorado7開(kāi)發(fā)項(xiàng)目的時(shí)候就經(jīng)常遇到這種問(wèn)題，dorado7自帶了一個(gè)圖標(biāo)管理的工具，可以通過(guò)這個(gè)工作點(diǎn)選自己需要的圖標(biāo)

6、。但是在開(kāi)發(fā)過(guò)程中，每個(gè)程序員都是根據(jù)自己的喜好來(lái)點(diǎn)選圖標(biāo)，造成系統(tǒng)中的圖標(biāo)泛濫。所以在項(xiàng)目開(kāi)發(fā)前期，就需要把這些規(guī)范定出來(lái)，避免開(kāi)發(fā)過(guò)程中的返工。 界面布局結(jié)構(gòu)界面布局的規(guī)范也特別重要，根據(jù)目標(biāo)用戶的使用習(xí)慣定制一套合適的界面布局結(jié)構(gòu)非常重要。開(kāi)發(fā)人員一般都會(huì)認(rèn)為自己的想法是對(duì)的，因此按照自己的習(xí)慣把某些按鈕或輸入框放到頁(yè)面上部或底部，而用戶的習(xí)慣卻恰恰相反，如果用戶不理解，那又得返工。所以在開(kāi)發(fā)軟件系統(tǒng)的時(shí)候，要規(guī)范好，比如查詢條件框要放到頁(yè)面頂部，下方是一條工具欄（含增刪改操作按鈕）和分頁(yè)欄，再向下就是數(shù)據(jù)列表；彈出的對(duì)話框統(tǒng)一使用傳統(tǒng)對(duì)話框模式，把操作按鈕放到對(duì)話框底部。&#

7、160;2、代碼規(guī)范代碼的規(guī)范相對(duì)來(lái)說(shuō)，最常被人提及，因?yàn)闈撘庾R(shí)里，軟件開(kāi)發(fā)主要就是編寫程序，因此大家都更加關(guān)注代碼編寫上的規(guī)范。我主要是用java語(yǔ)言來(lái)開(kāi)發(fā)，因此這里暫且用java的常用規(guī)范來(lái)解釋。所謂寫程序要像寫小說(shuō)一樣，行云如流水，那就要在代碼上下功夫。命名規(guī)范：變量要使用駝峰式命令，比如某個(gè)變量的意義是由多個(gè)英文單詞組合起來(lái)的，那么就用英文第一個(gè)單詞的首字母大寫，其它字母小寫來(lái)進(jìn)行規(guī)范。且作用范圍稍大的變量要盡量保持變量名稱的完整性，別使用縮寫，以方便跟蹤和調(diào)試程序。同樣，除了變量名外，方法名（函數(shù)名）、文件命名也需要按這種方式進(jìn)行命名，讓人一看字面意思就知道代碼的作用。代碼結(jié)構(gòu)：代碼

8、一定要有縮進(jìn)，這樣才便于檢查代碼的層次和結(jié)構(gòu)性，如果一段代碼里面有多個(gè)if判斷，在不使用縮進(jìn)的情況下，要去理清這段代碼，會(huì)使你頭變得很大，不心讓你白了少年頭。還有一些枚舉類型的常量，我建議寫到實(shí)體類里面，因?yàn)檫@些常量可能僅對(duì)該實(shí)體類中的某個(gè)字段屬性有用，那么定義在這里我覺(jué)和是最好不過(guò)的。比如有一個(gè)type屬性，有0,1,2三種狀態(tài)，在其它程序中可能會(huì)存在對(duì)這個(gè)屬性的值進(jìn)行判斷，然后再進(jìn)行其它業(yè)務(wù)上的流程操作，那么，就在這個(gè)類里面定義幾個(gè)常量，如TYPE_NORMAL=0;TYPE_COMPLETE=1;TYPE_CANCEL=2;常用工具類：我參與的有幾個(gè)項(xiàng)目，他們沒(méi)有定義常用工具類，程序員在

9、開(kāi)發(fā)的時(shí)候發(fā)現(xiàn)需要用到什么轉(zhuǎn)換的，就臨時(shí)在class里面寫個(gè)private方法來(lái)實(shí)現(xiàn)，而其它地方同樣需要這樣一個(gè)轉(zhuǎn)換，于是又自己寫一個(gè)私有方法，每個(gè)人因?yàn)樗絾?wèn)題可能實(shí)現(xiàn)效果還不一樣，這既造成重復(fù)工作，又會(huì)留下系統(tǒng)不穩(wěn)定的隱患。因此規(guī)范一套行之有效的公有工具類是很有必要的，定義好后對(duì)組類成員進(jìn)行一個(gè)簡(jiǎn)單的介紹或培訓(xùn)就能省點(diǎn)很多事。 3、文件存放結(jié)構(gòu)文件的存放結(jié)構(gòu)也非常重要，即圖片文件、樣式文件、js文件、用戶上傳的文件以及程序文件，如果不規(guī)范好存放目標(biāo)結(jié)構(gòu)，同樣會(huì)引起很多重復(fù)性的工作，比如A開(kāi)發(fā)員把文件存到images目錄，而B開(kāi)發(fā)員把圖片存到img目錄，美工又把圖片存到style/

10、images目錄，造成極大的文件管理難度。對(duì)程序文件的結(jié)構(gòu)，一是按數(shù)據(jù)流向來(lái)定義，即對(duì)數(shù)據(jù)庫(kù)的操作，所以數(shù)據(jù)操作類都放到dao這個(gè)包下面，業(yè)務(wù)操作類主到service包下面；要么按模塊功能來(lái)定義，每個(gè)模塊定義自己的數(shù)據(jù)流向文件包，比如用戶管理模塊，定義一個(gè)user包，然后再在user包里建幾個(gè)子包dao、service等。前者對(duì)功能簡(jiǎn)單的項(xiàng)目適用，后者對(duì)功能復(fù)雜的項(xiàng)目適用。上傳文件的保存也是一個(gè)值得注意的，不能把文件都保存到一個(gè)目錄下面，這樣會(huì)造成文件過(guò)多后訪問(wèn)速度下降，管理起來(lái)也很麻煩。那么可以按照年月日的目錄結(jié)構(gòu)方式保存文件，比如uploadfile/201306/01/xxx.jpg，這

11、樣每個(gè)目錄的數(shù)據(jù)都不會(huì)很大。對(duì)于文件的訪問(wèn)，可以使用二級(jí)域名的方式指向文件存放位置，這對(duì)網(wǎng)頁(yè)的打開(kāi)速度會(huì)有較大的影響，比如圖片的訪問(wèn)使用 4、文件模板文件模板不只是針對(duì)頁(yè)面的界面，還有一個(gè)代碼級(jí)模板，比如一些簡(jiǎn)單的操作類會(huì)有保存、修改、刪除、查詢幾個(gè)方法，那我就可以自己規(guī)范一套代碼樣式出來(lái)，有新的功能了，直復(fù)制這個(gè)文件，然后修改掉幾個(gè)相關(guān)的實(shí)體類和部分變量就可以了，可以省掉80%的時(shí)候來(lái)重復(fù)編寫類似相同的代碼。我現(xiàn)在已經(jīng)習(xí)慣于這種代碼的開(kāi)發(fā)，復(fù)制、粘貼、替換關(guān)鍵字，一個(gè)業(yè)務(wù)功能的基本代碼就完成，剩下的就是對(duì)一些特殊數(shù)據(jù)的處理添加相應(yīng)的代碼，真的很省事。 5、數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范首先還是要說(shuō)命名規(guī)范，數(shù)據(jù)庫(kù)設(shè)計(jì)是先于代碼開(kāi)發(fā)的，所以先行的事情一定要做好，否則會(huì)影響后面一系列工作，比如很多代碼開(kāi)發(fā)時(shí)，都是根據(jù)數(shù)據(jù)表的名稱來(lái)命名實(shí)體類、業(yè)務(wù)類和變