時間:2015-06-28 00:00:00 來源:IT貓撲網(wǎng) 作者:網(wǎng)管聯(lián)盟 我要評論(1)
?? 程序中的編碼風(fēng)格讓我們的編程工作變得輕松,特別是程序維護(hù)員,他們要經(jīng)常閱讀其他人編寫的程序編碼,這一點(diǎn)尤其突出。編碼規(guī)范從根本上解決了程序維護(hù)員的難題;規(guī)范的編碼閱讀和理解起來更容易,也可以快速的不費(fèi)力氣的借鑒別人的編碼。對將來維護(hù)你編碼的人來說,你的編碼越優(yōu)化,他們就越喜歡你的編碼,理解起來也就越快。
?? 同樣,高水平的編碼風(fēng)格(例如固定的封閉結(jié)構(gòu))目的在于改善設(shè)計和使編碼更易于理解。事實(shí)上,最后有些人會認(rèn)為改善設(shè)計和提高編碼的易讀性是一回事。
?? 本文中你會看到一些流行的編碼風(fēng)格被面向讀者的更易于接受的風(fēng)格所替代。有人爭論說這些風(fēng)格都已經(jīng)被大家廣泛使用,不應(yīng)該簡單的為了達(dá)到讀者的期望而拋棄。然而,讀者的期待只是其中一方面的原因,不可能凌駕于所有因素之上。列出四種常見的問題:
?? 1.對局域變量(local variables)、參數(shù)(method arguments)、字段(fields)這三種變量的命名沒有區(qū)分:
?? 對看編碼的人來說,首先要弄清這些數(shù)據(jù)如何定義的?看一個類時,得弄清楚每個條目是局域變量?字段?還是參數(shù)?有必要使用一個簡單的命名約定來定義這些變量,增加易讀性。
?? 很多權(quán)威機(jī)構(gòu)規(guī)范過字段變量用以區(qū)分它與其它的變量,但這遠(yuǎn)遠(yuǎn)不夠??梢园褜ψ侄蔚暮侠淼拿s定邏輯也應(yīng)用在參數(shù)上面。先看示例1:沒有進(jìn)行區(qū)分這三種變量的類定義,如下所示:
?? 示例1:
public boolean equals (Object arg) { if (! (arg instanceof Range)) return false; Range other = (Range) arg; return start.equals(other.start) && end.equals(other.end);} |
?? 在這個方法中,arg直接用argument的縮寫,雖然大家一看就知道這是參數(shù)了,但這種命名方式卻丟失了參數(shù)代表的對象本身 的含義。大家知道這 是參數(shù),卻不知道這是什么參數(shù)。如果方法的參數(shù)多一點(diǎn),都按照arg1,arg2這樣的方式命名,閱讀代碼? 的時候很頭疼。另外兩個字段變量,start和 end,突然憑空而出,想一下才知道這應(yīng)該是字段。當(dāng)然,這個方法很短,造成的困難還不大,如果這個方法比較長的話,突然看到start和end兩個變 量,一般會先在前面找一下是不是局部變量,然后才能確定是類的字段變量。
?? 這個問題貌似微不足道,但為什么要讓代碼閱讀者花費(fèi)額外時間在這些瑣碎的問題上呢?如果有個方案能讓代碼閱讀者一目了然的明白變量是那種變量,為什 么不采用呢?就如同Steve McConnell在 《代碼大全》中說的:"讓人費(fèi)神去琢磨神秘殺人兇手這沒有問題,但你不需要琢磨程序代碼,代碼是用來閱讀的。
?? 接下來看示例2,使用命名約定后對示例1重寫以后的代碼,用到的命名約定有:
?? ◆參數(shù)定義時名字加前綴a
?? ◆字段定義時名字加前綴f
?? ◆局域變量定義時不加任何前綴
?? 示例2:對變量類型進(jìn)行區(qū)分
public boolean equals (Object aOther) { if (! (aOther instanceof Range)) return false; Range other = (Range) aOther; return fStart.equals(other.fStart) && fEnd.equals(other.fEnd);} |
?? 你可能反對示例2中的風(fēng)格,反對過時了的匈牙利符號,但是我認(rèn)為反對是錯誤的,因?yàn)樾傺览柲茉敿?xì)說明信息的類型。上面的命名約定區(qū)分了類型。而且這樣做分清了字段、變量和局域變量,這是兩種完全不同的概念。這種命名約定的方式并不像看起來那么微不足道:當(dāng)這些約定用在程序編碼中時,會大大降低理解的難度,因?yàn)槟憧梢圆恍枰确直孢@些變量,省去不少時間。
?? 2.按層次劃分包,而不是根據(jù)特征或功能劃分最常見的劃分應(yīng)用序就是按層次命名包:
?? com.blah.action 、com.blah.dao 、com.blah.model、com.blah.util
?? 也就是說,把具有同樣特征或者功能的類劃分到了不同的包里。因?yàn)槌蓡T的屬性對其他成員應(yīng)該是可見的,這就意味著幾乎應(yīng)用程序中所有的類都是公共的。實(shí)際上,這種按層次劃分包的方法完全扔掉了Java的包內(nèi)私有。包內(nèi)私有應(yīng)該徹底不使用。現(xiàn)在,包內(nèi)私有是Java程序語言中設(shè)計者的默認(rèn)作用域。這種包的劃分習(xí)慣也違反了面向?qū)ο缶幊痰暮诵脑瓌t之--盡量保持私有以減少影響,因?yàn)檫@種習(xí)慣強(qiáng)迫你必須擴(kuò)大類的作用域。由于一些奇怪的原因,一些Java組織不贊成這種命名,似乎不公正的。
另一種風(fēng)格是按特征劃分命名:
?? com.blah.painting 、com.blah.buyer 、com.blah.seller 、com.blah.auction 、com.blah.webmaster 、com.blah.useraccess 、com.blah.util
?? 這里,成員不按行為劃分,而是按照不同特征的類劃分,每個成員都關(guān)聯(lián)不同的特征。這種方法下包在最初使用是被定義。
例如:在Web應(yīng)用程序中,"com.blah.painting"包可能由下列成員組成:
?? ◆Painting.java: 一個model對象
?? ◆PaintingDAO.java: 一個數(shù)據(jù)存取對象Dao
?? ◆PaintingAction.java: 一個控制或者行為對象
?? ◆statements.sql: Dao對象使用的SQl文件
?? ◆view.jsp: Jsp文件
?? 需要特別說是的是,這種劃分方法,每一個包都包含所有成員有關(guān)的特征文件,而不僅僅是Java源文件。這種按特征劃分包的方法,要求在做刪除操作時要注意,刪除一個特征時要刪掉它的整個目錄,不能保存在源碼中。
?? 這種方法優(yōu)于按層次劃分包的方法,表現(xiàn)在以下幾點(diǎn):
?? ◆包是高內(nèi)聚的,并且模塊化,包與包之間的耦合性被降到最低。
?? ◆代碼的自描述性增強(qiáng). 讀者只需看包的名字就對程序有些什么功能或特征有了大概的印象。在《代碼大全》中, Steve McConnell 將自描述性的代碼比作 "易讀的圣杯",來表達(dá)它的易讀性。
?? ◆把類按照每個特征和功能區(qū)分開可以很容易實(shí)現(xiàn)分層設(shè)計。
#p#副標(biāo)題#e#
?? ◆相關(guān)的成員在同一個位置。不需要為了編輯一個相關(guān)的成員而去瀏覽整個源碼樹。
?? ◆成員的作用域默認(rèn)是包內(nèi)私有。只有當(dāng)另外的包需要訪問某個成員的時候,才把它修改為public. (需要注意的是修改一個類為public,并不意味著它的所有類成員都應(yīng)該改為public。public成員和包內(nèi)私有(package- private)成員是可以在同一個類里共存的。)
?? ◆刪除一個功能或特征只需要簡單的刪除一個文件夾。
?? ◆每個包內(nèi)一般只有很少的成員,這樣包可以很自然的按照進(jìn)化式發(fā)展。如果包慢慢變的太大,就可以再進(jìn)行細(xì)分,把它重構(gòu)為兩個或者更多新的包,類似于物種進(jìn)化。而按照層次劃分的方式,就沒辦法進(jìn)化式發(fā)展,重構(gòu)也不容易。
?? 一些框架推薦使用層層定義包的傳統(tǒng)的方式做為包的命名方法:由于使用傳統(tǒng)的包命名,開發(fā)者總能知道在哪個位置可以找到這些項(xiàng)目,但是為什么避免人們這樣做呢?使用另一種按特征定義包的風(fēng)格,就不需要這種單調(diào)的操縱,因此,按特征定義完全超越了任何其它命名約定。約書亞布洛赫在《高效的Java》一書中說到:區(qū)分一個設(shè)計好壞的唯一重要因素是模塊內(nèi)部隱藏的數(shù)據(jù)和其它模塊中涉及的實(shí)現(xiàn)過程的程度。
?? 3.習(xí)慣用JavaBeans而不是不可變對象
?? 不可變對象是構(gòu)造后狀態(tài)不改變。Scala的主要創(chuàng)造者M(jìn)artin Odersky最近還稱贊過這種不可變對象。在《高效的Java》一書中,Joshua Bloch列舉了大量實(shí)例支持使用不可變對象,并總結(jié)了很多優(yōu)點(diǎn)。但他的意見,似乎很大程度上被忽略。大多數(shù)程序使用JavaBeans來替代不可變對象。JavaBean明顯要比不可變對象復(fù)雜的多,因?yàn)樗木薮蟮穆暶骺臻g。粗略的講,你可以把JavaBean看作是與不可變對象完全相反的對象:它允許最大的可變性。JavaBean常被用來做數(shù)據(jù)庫記錄的映射。假如你要從數(shù)據(jù)庫記錄集映射一行為對象,不考慮現(xiàn)有的持久化方案和框架,你會將這個對象設(shè)計成什么樣子?跟javabean相似呢還是完全不一樣?我認(rèn)為會完全不一樣,說明如下:
?? ◆它不包含一個無參數(shù)構(gòu)造方法(這一特征是javabean必備的。)。作者認(rèn)為一個數(shù)據(jù)庫記錄的對象如果不包含任何數(shù)據(jù)是沒有意義的。一個數(shù)據(jù)庫表的所有字段都是可選的情況有多少?
?? ◆It would likely not have anything to say about events and listeners.(不太明白作者的意思)
?? ◆它不強(qiáng)迫你用可變的對象。
?? ◆它內(nèi)部有一個數(shù)據(jù)驗(yàn)證機(jī)制。這樣一個驗(yàn)證機(jī)制對大多數(shù)數(shù)據(jù)庫應(yīng)用非常重要。(記住對象的第一原則:一個對象應(yīng)該同時封裝數(shù)據(jù)和對數(shù)據(jù)的操作。在這種情況下,操作就是驗(yàn)證數(shù)據(jù)。)
?? ◆數(shù)據(jù)驗(yàn)證機(jī)制可以給
關(guān)鍵詞標(biāo)簽:Java編碼
相關(guān)閱讀
熱門文章 eclipse中如何設(shè)置字體大小_eclipse字體大小設(shè)置方法 jsp 實(shí)現(xiàn)在線人數(shù)統(tǒng)計 Eclipse優(yōu)化設(shè)置教程_Eclipse卡頓優(yōu)化設(shè)置技巧 JS截取字符串常用方法詳細(xì)整理
人氣排行 JS驗(yàn)證日期格式是否正確 Java中3DES加密解密調(diào)用示例 Java技術(shù)-J2EE開發(fā)日記-MyEclipse快捷鍵與插件大全 eclipse中如何設(shè)置字體大小_eclipse字體大小設(shè)置方法 Eclipse優(yōu)化設(shè)置教程_Eclipse卡頓優(yōu)化設(shè)置技巧 JavaScript基本語法-常量和變量 用Java刪除文件夾里的所有文件 100多個很有用的JavaScript函數(shù)以及基礎(chǔ)寫法匯總