升級 Java 編程規(guī)范的6個約定

taowen 發(fā)布于2019-08-14 15:09 / 2468人閱讀

摘要：對變量對象或者函數(shù)等進行命名時，選擇能清晰表達其用途的名字。其實，測試方法名應(yīng)該明確指出測試的內(nèi)容與條件。和這種命名方式是時代的前朝遺物。使用自己的異常類型筆者又一次錯誤地認(rèn)為這一開發(fā)習(xí)慣是業(yè)內(nèi)的共識。

作為 Java 開發(fā)人員，我們會遵循一系列的編碼風(fēng)格和開發(fā)習(xí)慣。習(xí)慣使然是一方面，另一方面，我們也從不停下腳步質(zhì)疑這些習(xí)慣。一段時間以后，筆者養(yǎng)成了一些不同于常人的編碼風(fēng)格和開發(fā)習(xí)慣。當(dāng)?shù)谝淮瘟私獾竭@些編碼風(fēng)格時，筆者感到又驚又氣。但是，花了一段時間踐行這些習(xí)慣之后，筆者意識到它們的確能造就更加簡潔可控的代碼庫，同時也讓開發(fā)者更加省心。

不要因這些想法的另類而否定它們，筆者建議你用幾周時間嘗試其中的一兩條，如果你仍然不喜歡它們，換回以前的代碼風(fēng)格也用不了多久時間。

零注釋（公共 API 除外）

筆者一度認(rèn)為業(yè)內(nèi)對于零注釋這種編程習(xí)慣已經(jīng)達成共識，但是當(dāng)與許多同事合作之后，筆者發(fā)現(xiàn)事實并非如此。所以，讓我們再次探討這個問題：無注釋。注釋很快就會與代碼脫節(jié)。假如你在一段代碼的上面寫了行注釋，誰也不能保證下一個修改代碼的人會更新注釋。根據(jù)筆者的開發(fā)經(jīng)驗，沒人會更新注釋。原來的代碼段可能被刪除，業(yè)務(wù)需求也可能改變。因此，你的注釋往往弊大于利。

對此，有個簡單的解決方案，就是寫自記錄代碼（self documenting code）。對變量、對象或者函數(shù)等進行命名時，選擇能清晰表達其用途的名字。假如不夠清晰，你需要對它們進行重構(gòu)，將之拆分為更簡潔的形式。只要能直觀地表達其用途，過長的名字也無需擔(dān)憂。別忘了編輯器有自動填寫功能，沒人需要敲出整個標(biāo)識符的名字。

然而，公共 API 是一個明顯的例外。假如你正在建立一個準(zhǔn)備公開發(fā)版的庫，那還是使用簡潔的方法名比較好。不過， Javadoc 對這種情況大有裨益，但也僅限此情況。

不要用 “Test” 為測試方法開頭

確實沒有必要這么做。你寫的方法會注釋為測試，方法所在的類也存在于測試包中。明眼人都知道那是測試。其實，測試方法名應(yīng)該明確指出測試的內(nèi)容與條件。例如， “reversesTheWordRandomToModnar()”或者“adds70ToBalanceOf100ToMakeBalanceOf170()”，這些名字都準(zhǔn)確表達了測什么功能以及預(yù)期的結(jié)果。

如果你正在使用 IntelliJ ，有一款特別棒的插件叫做 Enso 。它可以將測試名轉(zhuǎn)化成一個句子，一目了然地顯示測試的內(nèi)容。這意味著當(dāng)你在注視任何類的時候， Enso 都會展示其說明文檔。

不要使用@Override

這個觀點爭議頗多，請聽筆者說完。假如你不使用 @override ，最壞的結(jié)果就是你重寫了一個函數(shù)，而調(diào)用時執(zhí)行的卻是原版函數(shù)，而非重寫的版本。值得慶幸的是，在測試驅(qū)動開發(fā)模式下，測試整段代碼時就會定位到這個 bug 。這讓 @Override 成了一段冗余的代碼。顯然，冗余的代碼不僅沒有好處，還會讓人分心。因此，停止使用 @Override ，而依賴 TDD（測試驅(qū)動開發(fā)）。

不要使用 getX()/setY() 這樣的函數(shù)名

這確實讓人不由得感到惱火。 getXXX 和 setXXX 這種命名方式是 Javabeans 時代的前朝遺物。而 JavaBeans 時代早已過去，這種命名方式也不再適用了。后者讓代碼變得令人反感卻沒有帶來什么好處。去掉 get／set 這類關(guān)鍵字有利于字段名稱的簡潔。例如， car.engine() 函數(shù)將生成一個引擎對象，而 car.engine(new v8()) 將引擎設(shè)置為新的型號。如果需要讀取多層級內(nèi)的對象（例如：car.lights().frontLeft() 對比 car.getLights().getFrontLeft()），前者依舊表達清晰而且代碼更加簡潔。這個編程習(xí)慣筆者一開始也很反對，后來逐漸改變了看法，現(xiàn)在非常熱衷這一風(fēng)格。

可運行的代碼>高性能的代碼

這段內(nèi)容和代碼風(fēng)格關(guān)系不大，而是更加泛泛而談。每次看到人們?yōu)榱艘粋€問題，精雕細(xì)刻地設(shè)計解決方案，花費大量的時間，筆者都會感到不悅。其實，在最基本的層面上解決問題然后測試性能。十有八九，這類方案都是高速，可擴展或符合其他時髦概念的。相反，筆者經(jīng)常看到人們設(shè)計了一個復(fù)雜的緩存解決方案，結(jié)果沒有提高性能卻把代碼弄成一團亂麻。解決問題時，先實施你能采取的最基本方案，然后再進行優(yōu)化。最起碼，這種方式能讓你有實例證明問題已經(jīng)解決。

使用自己的異常類型

筆者又一次錯誤地認(rèn)為這一開發(fā)習(xí)慣是業(yè)內(nèi)的共識。 Java 中的檢查性異常（Checked exceptions）很糟糕，幾乎所有其他編程語言（例如C＃）都意識到了這一點，所以它們甚至沒有這個類型。在筆者編寫的任何應(yīng)用程序中，都會創(chuàng)建自己的異常類型，在這些應(yīng)用程序中拋出的任何異常都會用筆者創(chuàng)建的異常類接住，然后拋出運行時異常。這讓代碼更加整潔（筆者從未在程序中拋出大量 XXXException ），也意味著筆者能通過 log 追朔異常來自代碼的哪一部分或者這是完全出乎意料的異常類型。

（編譯自：https://dzone.com/articles/upgrade-your-code-conventions-2）

OneAPM 為您提供端到端的 Java 應(yīng)用性能解決方案，我們支持所有常見的 Java 框架及應(yīng)用服務(wù)器，助您快速發(fā)現(xiàn)系統(tǒng)瓶頸，定位異常根本原因。分鐘級部署，即刻體驗，Java 監(jiān)控從來沒有如此簡單。想閱讀更多技術(shù)文章，請訪問 OneAPM 官方技術(shù)博客。
本文轉(zhuǎn)自 OneAPM 官方博客