有哪些“紀(jì)律”是Java程序員所要遵守的？

1. 為代碼添加注釋（Add comments to your code）. – 每個(gè)人都知道這一點(diǎn)，但不是每個(gè)人都會(huì)這么做。你有多少次“忘記”添加注釋了？確實(shí)，注釋不會(huì)為你的程序增加任何函數(shù)功能。但是，有多少次，看到2周前寫的代碼，你都記不起它是干什么的？你很幸運(yùn)，那些未注釋的代碼是你自己寫的，你腦海中還會(huì)有殘存的印象。非常不幸，大多時(shí)候，代碼是別人寫的，并且那個(gè)人很可能已經(jīng)離開公司了。有句諺語說的好：“有來有往，互惠互利”，因此程序員應(yīng)該體諒彼此（還有你自己），給你的代碼加上注釋。

2. 不要把簡(jiǎn)單事情復(fù)雜化（Do not complicate things）. – 我曾經(jīng)這么做過，我相信你也一樣。開發(fā)者都傾向于采用復(fù)雜方式解決簡(jiǎn)單問題。我們?cè)谝粋€(gè)只有5個(gè)用戶的系統(tǒng)中引入EJB，為一個(gè)并不需要框架的應(yīng)用實(shí)現(xiàn)一套框架，采用屬性文件、采用面向?qū)ο蠼鉀Q方案、使用線程，而這些根本用不著。為什么會(huì)這么做？一些人可能不知道有更好的解決方案，但另一些人可能故意這樣做來學(xué)習(xí)新知識(shí)，或僅僅是因?yàn)橛腥?。?duì)那些不知道更好解決方案的人，要多聽有經(jīng)驗(yàn)程序員的建議。對(duì)于那些純粹出于個(gè)人目的而將設(shè)計(jì)復(fù)雜化的人，我建議你要更加專業(yè)一點(diǎn)。

3. 記住 － “越少越好”并非總是如此(Keep in Mind – "Less is more" is not always better). – 高效率的代碼是件好事，但很多情況下，并非代碼行數(shù)越少效率就越高?？聪旅孢@個(gè)“簡(jiǎn)單”的例子：

if(newStatusCode.equals("SD") && (sellOffDate == null ||  
todayDate.compareTo(sellOffDate)<0 || (lastUsedDate != null && todayDate.compareTo(lastUsedDate)>0)) ||(newStatusCode.equals("OBS") && (OBSDate == null ||  
todayDate.compareTo(OBSDate)<0))){ 
    newStatusCode = "NYP"; 
} 

指出這個(gè)if條件是什么有多困難？再設(shè)想一下，寫這段代碼的人并沒遵循第1條 － 為代碼添加注釋。

把if條件分解成2個(gè)if語句不是更容易理解嗎？現(xiàn)在讓我們看一下修改過的代碼：

if(newStatusCode.equals("SD") && (sellOffDate == null ||  
todayDate.compareTo(sellOffDate)<0 || (lastUsedDate != null &&  
todayDate.compareTo(lastUsedDate)>0))){ 
    newStatusCode = "NYP"; 
}else  
if(newStatusCode.equals("OBS") && (OBSDate == null ||  
todayDate.compareTo(OBSDate)<0)) 
{ 
    newStatusCode = "NYP"; 
} 

這樣可讀性不是更好嗎？的確，我們寫了重復(fù)語句；的確，我們多寫了一個(gè)if和2個(gè)大括號(hào)；但是代碼確實(shí)更加易讀、更加容易理解了！

4. 不要“硬編碼"（No hard coding please）. – 由于時(shí)間緊迫，開發(fā)者總是會(huì)忘記或故意忽略這一條。然而另一種可能是，遵循這條戒律，我們就不會(huì)陷入“時(shí)間緊迫”的困境。定義一個(gè)static final 變量，增加一行代碼，又能花多長(zhǎng)時(shí)間呢？譬如：

public class A { 
   
    public static final String S_CONSTANT_ABC = "ABC"; 
   
    public boolean methodA(String sParam1){ 
       
      if (A.S_CONSTANT_ABC.equalsIgnoreCase(sParam1)){ 
        return true; 
      }     
      return false; 
    } 
} 

現(xiàn)在，每次需要比較字符串“ABC”與某個(gè)變量的時(shí)候，我們只要引用 A.S_CONSTANT_ABC 即可，而不必記住它本身是什么。對(duì)這個(gè)常量的修改也非常方便，改一個(gè)地方即可，而不必在全部代碼中查找。

5. 不要發(fā)明你自己的框架（Do not invent your own frameworks）. – 不夸張地講，已經(jīng)有幾千個(gè)框架存在了，大多數(shù)還是開源的。很多框架都是極完美的解決方案，并已被用到成千的系統(tǒng)中。我們只要關(guān)注最新的流行的框架，至少表面上要熟悉一下。一個(gè)最成功的、也是被廣泛使用的例子是Struts框架，這個(gè)開源的web框架是建立web系統(tǒng)的極佳選擇，不要試圖構(gòu)造你自己的Struts版本，會(huì)累死的。但你必須記住第2條（譯注：原文是“第3條”，顯然不對(duì)）戒律 —— 不要把簡(jiǎn)單事情復(fù)雜化。如果你要開發(fā)的系統(tǒng)只有3個(gè)界面，就不要用Struts. 對(duì)于這樣一個(gè)系統(tǒng)，沒有足夠的需要被“控制”的東西（譯注：Struts將界面做MVC劃分，C即controller，所以作者說there isn't much "controlling" required）。

6. 對(duì)Print行或字符串說不（Say no to Print lines and String Concatenations）. – 我知道為了調(diào)試方便，程序員喜歡到處用System.out.println ,然后對(duì)自己說過一會(huì)就刪掉。但我們常常忘記刪掉這些行或不愿刪掉，我們用System.out.println 做測(cè)試，為什么測(cè)完后還要去改代碼？這很可能導(dǎo)致誤刪一行我們需要的代碼。不要低估System.out.println 的危害，看下面代碼：

public class BadCode { 
  public static void calculationWithPrint(){ 
    double someValue = 0D; 
    for (int i = 0; i < 10000; i++) { 
      System.out.println(someValue = someValue + i); 
    }   
  } 
  public static void calculationWithOutPrint(){ 
 
      double someValue = 0D; 
      for (int i = 0; i < 10000; i++) { 
        someValue = someValue + i; 
      } 
     
  } 
  public static void main(String [] n) { 
    BadCode.calculationWithPrint(); 
    BadCode.calculationWithOutPrint(); 
  } 
} 

下面表格可以看出，calculationWithOutPrint() 方法執(zhí)行時(shí)間是0.001204 s. 作為對(duì)比，calculationWithPrint() 方法居然需要令人難以置信的10.52 s來執(zhí)行！

(若你想知道怎么做一個(gè)這樣的表，請(qǐng)閱讀另一篇文章"Java Profiling with WSAD" Java Profiling with WSAD )

為了避免CPU浪費(fèi)，最好的辦法是引入一個(gè)包裝的方法，如下：

public class BadCode { 
   
    public static final int DEBUG_MODE = 1; 
    public static final int PRODUCTION_MODE = 2; 
   
  public static void calculationWithPrint(int logMode){   
    double someValue = 0D; 
    for (int i = 0; i < 10000; i++) { 
      someValue = someValue + i; 
      myPrintMethod(logMode, someValue); 
    } 
  } 
       
  public static void myPrintMethod(int logMode, double value) { 
    if (logMode > BadCode.DEBUG_MODE) {  return; } 
    System.out.println(value);   
  } 
  public static void main(String [] n) { 
    BadCode.calculationWithPrint(BadCode.PRODUCTION_MODE); 
    } 
} 

字符串(String)連接是另一種CPU浪費(fèi)方式，看下面的例子：

public static void concatenateStrings(String startingString) { 
    for (int i = 0; i < 20; i++) { 
      startingString = startingString + startingString; 
    } 
  } 
   
  public static void concatenateStringsUsingStringBuffer( 
String startingString) { 
    StringBuffer sb = new StringBuffer(); 
    sb.append(startingString); 
      for (int i = 0; i < 20; i++) { 
        sb.append(sb.toString()); 
      } 
} 

從下面表格可以看出使用 StringBuffer只要花 0.01 s 而使用String 連接需要0.08 s，選擇哪種應(yīng)該很明顯了。

7. 注意圖形用戶界面（Pay attention to the GUI）. – 無論聽上去多荒謬，但有一點(diǎn)我注意過多次了：圖形用戶界面（GUI）對(duì)于商業(yè)用戶而言與程序功能及執(zhí)行效率一樣重要。GUI對(duì)于應(yīng)用程序的成功至關(guān)重要。 IT管理者（譯注：這里應(yīng)該是指程序開發(fā)方的IT management）常常忽略GUI的重要性，很多公司為了省錢而不雇傭web設(shè)計(jì)人員，而這些設(shè)計(jì)人員有足夠的經(jīng)驗(yàn)來設(shè)計(jì)“用戶友好”的應(yīng)用軟件。 Java程序員不得不依賴他們有限的HMTL知識(shí)。我見過非常多對(duì)“計(jì)算機(jī)友好”而非對(duì)“用戶友好”的應(yīng)用程序，同時(shí)精通軟件開發(fā)和用戶界面開發(fā)的開發(fā)者非常少見。 如果你是一位不幸被指派做界面開發(fā)的Java程序員，你要遵循下面3條規(guī)則：

a.不要重新發(fā)明輪子。去看那些類似應(yīng)用系統(tǒng)的界面。
b.首先建立一個(gè)原型。這一步非常關(guān)鍵?？蛻粝矚g提前看到他們要用的東西。同樣你可以得到他們的反饋，而不是你辛辛苦苦做出來一個(gè)客戶不喜歡的東西。
c.試戴用戶的帽子。換句話說，站在用戶的角度查看需求。譬如，一個(gè)統(tǒng)計(jì)的界面可以分頁，也可以不分頁。作為開發(fā)者，很可能會(huì)忽略分頁，因?yàn)檫@會(huì)減少很多麻煩；而站在客戶角度，這就不是一個(gè)好的方案，因?yàn)閿?shù)據(jù)可能多達(dá)幾百行。
8. 提前準(zhǔn)備需求文檔（Always Prepare Document Requirements）. – 每項(xiàng)業(yè)務(wù)需求都記入文檔。這在童話故事中可能實(shí)現(xiàn)，而現(xiàn)實(shí)中很難做到。無論時(shí)間多么緊迫，無論截止日期如何迫近，你必須確保業(yè)務(wù)需求被記錄下來。（譯注：這條明顯悖于敏捷開發(fā)的觀念，大家要獨(dú)立思考，甄別是非）

9. 單元測(cè)試，單元測(cè)試，單元測(cè)試 （Unit-test. Unit-test. Unit-test）. – 我不準(zhǔn)備討論如何單元測(cè)試的細(xì)節(jié)，我只是想說這必須要做。這是編程中最基本的規(guī)則了，尤其不能忽略。如果你同事能為你的代碼創(chuàng)建一個(gè)測(cè)試計(jì)劃，那就再好不過了；如果不能，那就要自己做。做單元測(cè)試計(jì)劃時(shí)，遵循下面原則：

a.編碼前就寫單元測(cè)試
b.保留單元測(cè)試的注釋
c.對(duì)任何“有趣的”公共方法都要做單元測(cè)試（“有趣的”是指除了像最常見的getter/setter這類方法外的方法，但包含有自己內(nèi)容的getter/setter 方法）
10. 記?。嘿|(zhì)量，而非數(shù)量（Remember – quality, not quantity）. - 不要待的太晚（除非有必要）。我知道有時(shí)因?yàn)楫a(chǎn)品問題，截止期限或其他突發(fā)事件，不能按時(shí)下班。但經(jīng)理不會(huì)因?yàn)槟銥橐话銌栴}待的太晚而感激或獎(jiǎng)勵(lì)你；他們會(huì)為有質(zhì)量的工作而感激你。如果你遵循上面的列的原則，你就會(huì)寫更健壯的、少bug的程序。這才是你最應(yīng)該做的。

本文中總結(jié)了Java程序員最應(yīng)注意的10項(xiàng)守則。僅僅知道是不夠的，還要遵循它們。希望這些守則能讓我們做更加專業(yè)的程序員。

最新評(píng)論