IntelliJ IDEA本身提供了一些內(nèi)置的代碼審查工具和代碼檢查功能，這些工具可以幫助提高代碼質(zhì)量和檢測潛在的問題。此外，你也可以集成第三方的代碼審查工具，如SonarQube，來進(jìn)一步提高代碼質(zhì)量。代碼審查是消滅Bug最重要的方法之一，這些審查在大多數(shù)時候都特別奏效。由于代碼審查本身所針對的對象，就是俯瞰整個代碼在測試過程中的問題和Bug。并且，代碼審查對消除一些特別細(xì)節(jié)的錯誤大有裨益，尤其是那些能夠容易在閱讀代碼的時候發(fā)現(xiàn)的錯誤，這些錯誤往往不容易通過機器上的測試識別出來。本文就常見的Java代碼中容易出現(xiàn)的問題提出一些建設(shè)性建議，以便您在審查代碼的過程中注意到這些常見的細(xì)節(jié)性錯誤。

　　通常給別人的工作挑錯要比找自己的錯容易些。別樣視角的存在也解釋了為什么作者需要編輯，而運動員需要教練的原因。不僅不應(yīng)當(dāng)拒絕別人的批評，我們應(yīng)該歡迎別人來發(fā)現(xiàn)并指出我們的編程工作中的不足之處，我們會受益匪淺的。

　　正規(guī)的代碼審查(code inspection)是提高代碼質(zhì)量的最強大的技術(shù)之一，代碼審查—由同事們尋找代碼中的錯誤—所發(fā)現(xiàn)的錯誤與在測試中所發(fā)現(xiàn)的錯誤不同，因此兩者的關(guān)系是互補的，而非競爭的。

　　如果審查者能夠有意識地尋找特定的錯誤，而不是*漫無目的的瀏覽代碼來發(fā)現(xiàn)錯誤，那么代碼審查的效果會事半功倍。在這篇文章中，我列出了11個 Java編程中常見的錯誤。你可以把這些錯誤添加到你的代碼審查的檢查列表(checklist)中，這樣在經(jīng)過代碼審查后，你可以確信你的代碼中不再存在這類錯誤了。

　　常見錯誤1 多次拷貝字符串

　　測試所不能發(fā)現(xiàn)的一個錯誤是生成不可變(immutable)對象的多份拷貝。不可變對象是不可改變的，因此不需要拷貝它。最常用的不可變對象是String。

　　如果你必須改變一個String對象的內(nèi)容，你應(yīng)該使用StringBuffer。下面的代碼會正常工作：

　　String s = new String ("Text here");

　　但是，這段代碼性能差，而且沒有必要這么復(fù)雜。你還可以用以下的方式來重寫上面的代碼：

　　String temp = "Text here";

　　String s = new String (temp);

　　但是這段代碼包含額外的String，并非完全必要。更好的代碼為：

　　String s = "Text here";

　　常見錯誤2 沒有克隆(clone)返回的對象

　　封裝(encapsulation)是面向?qū)ο缶幊痰闹匾拍?。不幸的是，Java為不小心打破封裝提供了方便——Java允許返回私有數(shù)據(jù)的引用(reference)。下面的代碼揭示了這一點：

　　import java.awt.Dimension;

　　/***Example class.The x and y values should never*be negative.*/

　　public class Example{

　　private Dimension d = new Dimension (0, 0);

　　public Example (){ }

　　/*** Set height and width. Both height and width must be nonnegative * or an exception is thrown.*/

　　public synchronized void setValues (int height,int width) throws IllegalArgumentException{

　　if (height < 0 || width < 0)

　　throw new IllegalArgumentException();

　　d.height = height;

　　d.width = width;

　　}

　　public synchronized Dimension getValues(){

　　// Ooops! Breaks encapsulation

　　return d;

　　}

　　}

　　Example類保證了它所存儲的height和width值永遠(yuǎn)非負(fù)數(shù)，試圖使用setValues()方法來設(shè)置負(fù)值會觸發(fā)異常。不幸的是，由于getValues()返回d的引用，而不是d的拷貝，你可以編寫如下的破壞性代碼：

　　Example ex = new Example();

　　Dimension d = ex.getValues();

　　d.height = -5;

　　d.width = -10;

　　現(xiàn)在，Example對象擁有負(fù)值了!如果getValues() 的調(diào)用者永遠(yuǎn)也不設(shè)置返回的Dimension對象的width 和height值，那么僅憑測試是不可能檢測到這類的錯誤。

　　不幸的是，隨著時間的推移，客戶代碼可能會改變返回的Dimension對象的值，這個時候，追尋錯誤的根源是件枯燥且費時的事情，尤其是在多線程環(huán)境中。

　　更好的方式是讓getValues()返回拷貝：

　　public synchronized Dimension getValues(){

　　return new Dimension (d.x, d.y);

　　}

　　現(xiàn)在，Example對象的內(nèi)部狀態(tài)就安全了。調(diào)用者可以根據(jù)需要改變它所得到的拷貝的狀態(tài)，但是要修改Example對象的內(nèi)部狀態(tài)，必須通過setValues()才可以。

　　常見錯誤3 不必要的克隆

　　我們現(xiàn)在知道了get方法應(yīng)該返回內(nèi)部數(shù)據(jù)對象的拷貝，而不是引用。但是，事情沒有絕對：

　　/*** Example class.The value should never * be negative.*/

　　public class Example{

　　private Integer i = new Integer (0);

　　public Example (){ }

　　/*** Set x. x must be nonnegative* or an exception will be thrown*/

　　public synchronized void setValues (int x) throws IllegalArgumentException{

　　if (x < 0)

　　throw new IllegalArgumentException();

　　i = new Integer (x);

　　}

　　public synchronized Integer getValue(){

　　// We can’t clone Integers so we makea copy this way.

　　return new Integer (i.intValue());

　　}

　　}

　　這段代碼是安全的，但是就象在錯誤1#那樣，又作了多余的工作。Integer對象，就象String對象那樣，一旦被創(chuàng)建就是不可變的。因此，返回內(nèi)部Integer對象，而不是它的拷貝，也是安全的。

　　方法getValue()應(yīng)該被寫為：

　　public synchronized Integer getValue(){

　　// ’i’ is immutable, so it is safe to return it instead of a copy.

　　return i;

　　}

　　Java程序比C++程序包含更多的不可變對象。jdk 所提供的若干不可變類包括：

　　·Boolean

　　·Byte

　　·Character

　　·Class

　　·Double

　　·Float

　　·Integer

　　·Long

　　·Short

　　·String

　　·大部分的Exception的子類

　　常見錯誤4 自編代碼來拷貝數(shù)組

　　Java允許你克隆數(shù)組，但是開發(fā)者通常會錯誤地編寫如下的代碼，問題在于如下的循環(huán)用三行做的事情，如果采用Object的clone方法用一行就可以完成：

　　public class Example{

　　private int[] copy;

　　/*** Save a copy of ’data’. ’data’ cannot be null.*/

　　public void saveCopy (int[] data){

　　copy = new int[data.length];

　　for (int i = 0; i < copy.length; ++i)

　　copy = data;

　　}

　　}

　　這段代碼是正確的，但卻不必要地復(fù)雜。saveCopy()的一個更好的實現(xiàn)是：

　　void saveCopy (int[] data){

　　try{

　　copy = (int[])data.clone();

　　}catch (CloneNotSupportedException e){

　　// Can’t get here.

　　}

　　}

　　如果你經(jīng)?？寺?shù)組，編寫如下的一個工具方法會是個好主意：

　　static int[] cloneArray (int[] data){

　　try{

　　return(int[])data.clone();

　　}catch(CloneNotSupportedException e){

　　// Can’t get here.

　　}

　　}

　　這樣的話，我們的saveCopy看起來就更簡潔了：

　　void saveCopy (int[] data){

　　copy = cloneArray ( data);

　　}

　　常見錯誤5 拷貝錯誤的數(shù)據(jù)

　　有時候程序員知道必須返回一個拷貝，但是卻不小心拷貝了錯誤的數(shù)據(jù)。由于僅僅做了部分的數(shù)據(jù)拷貝工作，下面的代碼與程序員的意圖有偏差：

　　import java.awt.Dimension;

　　/*** Example class. The height and width values should never * be

　　negative. */

　　public class Example{

　　static final public int TOTAL_VALUES = 10;

　　private Dimension[] d = new Dimension[TOTAL_VALUES];

　　public Example (){ }

　　/*** Set height and width. Both height and width must be nonnegative * or an exception will be thrown. */

　　public synchronized void setValues (int index, int height, int width) throws IllegalArgumentException{

　　if (height < 0 || width < 0)

　　throw new IllegalArgumentException();

　　if (d[index] == null)

　　d[index] = new Dimension();

　　d[index].height = height;

　　d[index].width = width;

　　}

　　public synchronized Dimension[] getValues()

　　throws CloneNotSupportedException{

　　return (Dimension[])d.clone();

　　}

　　}

　　這兒的問題在于getValues()方法僅僅克隆了數(shù)組，而沒有克隆數(shù)組中包含的Dimension對象，因此，雖然調(diào)用者無法改變內(nèi)部的數(shù)組使其元素指向不同的Dimension對象，但是調(diào)用者卻可以改變內(nèi)部的數(shù)組元素(也就是Dimension對象)的內(nèi)容。方法getValues()的更好版本為：

　　public synchronized Dimension[] getValues() throws CloneNotSupportedException{

　　Dimension[] copy = (Dimension[])d.clone();

　　for (int i = 0; i < copy.length; ++i){

　　// NOTE: Dimension isn’t cloneable.

　　if (d != null)

　　copy = new Dimension (d.height, d.width);

　　}

　　return copy;

　　}

　　在克隆原子類型數(shù)據(jù)的*數(shù)組的時候，也會犯類似的錯誤。原子類型包括int,float等。簡單的克隆int型的一維數(shù)組是正確的，如下所示：

　　public void store (int[] data) throws CloneNotSupportedException{

　　this.data = (int[])data.clone();

　　// OK

　　}

　　拷貝int型的二維數(shù)組更復(fù)雜些。Java沒有int型的二維數(shù)組，因此一個int型的二維數(shù)組實際上是一個這樣的一維數(shù)組：它的類型為int[]。簡單的克隆int[][]型的數(shù)組會犯與上面例子中g(shù)etValues()方法第一版本同樣的錯誤，因此應(yīng)該避免這么做。下面的例子演示了在克隆int型二維數(shù)組時錯誤的和正確的做法：

　　public void wrongStore (int[][] data) throws CloneNotSupportedException{

　　this.data = (int[][])data.clone(); // Not OK!

　　}

　　public void rightStore (int[][] data){

　　// OK!

　　this.data = (int[][])data.clone();

　　for (int i = 0; i < data.length; ++i){

　　if (data != null)

　　this.data = (int[])data.clone();

　　}

　　}

　　常見錯誤6 檢查new 操作的結(jié)果是否為null

　　Java編程新手有時候會檢查new操作的結(jié)果是否為null?？赡艿臋z查代碼為：

　　Integer i = new Integer (400);

　　if (i == null)

　　throw new NullPointerException();

　　檢查當(dāng)然沒什么錯誤，但卻不必要，if和throw這兩行代碼完全是浪費，他們的唯一功用是讓整個程序更臃腫，運行更慢。

　　C/C++程序員在開始寫java程序的時候常常會這么做，這是由于檢查C中malloc()的返回結(jié)果是必要的，不這樣做就可能產(chǎn)生錯誤。檢查 C++中new操作的結(jié)果可能是一個好的編程行為，這依賴于異常是否被使能(許多編譯器允許異常被禁止，在這種情況下new操作失敗就會返回null)。在java 中，new 操作不允許返回null，如果真的返回null，很可能是虛擬機崩潰了，這時候即便檢查返回結(jié)果也無濟于事。

　　常見錯誤7 用== 替代.equals

　　在Java中，有兩種方式檢查兩個數(shù)據(jù)是否相等：通過使用==操作符，或者使用所有對象都實現(xiàn)的.equals方法。原子類型(int, flosat, char 等)不是對象，因此他們只能使用==操作符，如下所示：

　　int x = 4;

　　int y = 5;

　　if (x == y)

　　System.out.println ("Hi");

　　// This ’if’ test won’t compile.

　　if (x.equals (y))

　　System.out.println ("Hi");

　　對象更復(fù)雜些，==操作符檢查兩個引用是否指向同一個對象，而equals方法則實現(xiàn)更專門的相等性檢查。

　　更顯得混亂的是由java.lang.Object 所提供的缺省的equals方法的實現(xiàn)使用==來簡單的判斷被比較的兩個對象是否為同一個。

　　許多類覆蓋了缺省的equals方法以便更有用些，比如String類，它的equals方法檢查兩個String對象是否包含同樣的字符串，而Integer的equals方法檢查所包含的int值是否相等。

　　大部分時候，在檢查兩個對象是否相等的時候你應(yīng)該使用equals方法，而對于原子類型的數(shù)據(jù)，你用該使用==操作符。

　　常見錯誤8 混淆原子操作和非原子操作

　　Java保證讀和寫32位數(shù)或者更小的值是原子操作，也就是說可以在一步完成，因而不可能被打斷，因此這樣的讀和寫不需要同步。以下的代碼是線程安全(thread safe)的：

　　public class Example{

　　private int value; // More code here...

　　public void set (int x){

　　// NOTE: No synchronized keyword

　　this.value = x;

　　}

　　}

　　不過，這個保證僅限于讀和寫，下面的代碼不是線程安全的：

　　public void increment (){

　　// This is effectively two or three instructions:

　　// 1) Read current setting of ’value’.

　　// 2) Increment that setting.

　　// 3) Write the new setting back.

　　++this.value;

　　}

　　在測試的時候，你可能不會捕獲到這個錯誤。首先，測試與線程有關(guān)的錯誤是很難的，而且很耗時間。其次，在有些機器上，這些代碼可能會被翻譯成一條指令，因此工作正常，只有當(dāng)在其它的虛擬機上測試的時候這個錯誤才可能顯現(xiàn)。因此最好在開始的時候就正確地同步代碼：

　　public synchronized void increment (){

　　++this.value;

　　}

　　常見錯誤9 在catch 塊中作清除工作

　　一段在catch塊中作清除工作的代碼如下所示：

　　OutputStream os = null;

　　try{

　　os = new OutputStream ();

　　// Do something with os here.

　　os.close();

　　}catch (Exception e){

　　if (os != null)

　　os.close();

　　}

　　盡管這段代碼在幾個方面都是有問題的，但是在測試中很容易漏掉這個錯誤。下面列出了這段代碼所存在的三個問題：

　　1.語句os.close()在兩處出現(xiàn)，多此一舉，而且會帶來維護(hù)方面的麻煩。

　　2.上面的代碼僅僅處理了Exception，而沒有涉及到Error。但是當(dāng)try塊運行出現(xiàn)了Error，流也應(yīng)該被關(guān)閉。

　　3.close()可能會拋出異常。

　　上面代碼的一個更優(yōu)版本為：

　　OutputStream os = null;

　　try{

　　os = new OutputStream ();

　　// Do something with os here.

　　}finally{

　　if (os != null)

　　os.close();

　　}

　　這個版本消除了上面所提到的兩個問題：代碼不再重復(fù)，Error也可以被正確處理了。但是沒有好的方法來處理第三個問題，也許最好的方法是把close()語句單獨放在一個try/catch塊中。

　　常見錯誤10 增加不必要的catch 塊

　　一些開發(fā)者聽到try/catch塊這個名字后，就會想當(dāng)然的以為所有的try塊必須要有與之匹配的catch塊。

　　C++程序員尤其是會這樣想，因為在C++中不存在finally塊的概念，而且try塊存在的唯一理由只不過是為了與catch塊相配對。

　　增加不必要的catch塊的代碼就象下面的樣子，捕獲到的異常又立即被拋出：

　　try{

　　// Nifty code here

　　}catch(Exception e){

　　throw e;

　　}finally{

　　// Cleanup code here

　　}

　　不必要的catch塊被刪除后，上面的代碼就縮短為：

　　try{

　　// Nifty code here

　　}finally{

　　// Cleanup code here

　　}

　　常見錯誤11 沒有正確實現(xiàn)equals，hashCode，或者clone 等方法

　　武漢Java培訓(xùn)方法equals，hashCode，和clone 由java.lang.Object提供的缺省實現(xiàn)是正確的。不幸地是，這些缺省實現(xiàn)在大部分時候毫無用處，因此許多類覆蓋其中的若干個方法以提供更有用的功能。但是，問題又來了，當(dāng)繼承一個覆蓋了若干個這些方法的父類的時候，子類通常也需要覆蓋這些方法。在進(jìn)行代碼審查時，應(yīng)該確保如果父類實現(xiàn)了 equals，hashCode，或者clone等方法，那么子類也必須正確。正確的實現(xiàn)equals，hashCode，和clone需要一些技巧。

以下是一些關(guān)于在IntelliJ IDEA中使用代碼審查工具（包括SonarQube）來提高代碼質(zhì)量的最佳實踐：

1. 使用內(nèi)置代碼檢查工具： IntelliJ IDEA自帶了強大的代碼檢查工具，例如代碼分析、尋找潛在的問題、代碼格式化等。確保啟用這些工具，并根據(jù)項目的需求進(jìn)行配置。

2. 配置代碼檢查規(guī)則： 根據(jù)項目的規(guī)范和最佳實踐，配置內(nèi)置代碼檢查工具的規(guī)則?？梢宰远x規(guī)則，也可以使用已有的規(guī)則集。

3. 實時代碼檢查： 啟用實時代碼檢查，以便在編寫代碼時立即獲得反饋。IntelliJ IDEA會在編輯器中標(biāo)記潛在的問題，并提供修復(fù)建議。

4. 靜態(tài)代碼分析： 使用IntelliJ IDEA的靜態(tài)代碼分析功能，可以識別代碼中的問題，如未使用的變量、空指針引用等。這些問題通常會在編譯前被檢測出來。

5. 代碼審查工具集成： 如果你的團(tuán)隊使用SonarQube或其他代碼審查工具，可以將其集成到IntelliJ IDEA中。SonarQube是一個流行的代碼質(zhì)量管理平臺，它可以幫助你分析和改進(jìn)代碼質(zhì)量。

6. SonarLint插件： 使用SonarLint插件，它可以與SonarQube集成，并在本地開發(fā)環(huán)境中執(zhí)行代碼檢查，以確保開發(fā)者在提交代碼到倉庫之前就可以發(fā)現(xiàn)問題。

7. 檢查并解決問題： 定期運行代碼檢查工具，分析代碼，并解決潛在的問題。確保代碼審查不僅僅是一個任務(wù)，而是一個持續(xù)的過程。

8. 團(tuán)隊合作： 促使團(tuán)隊成員參與代碼審查，確保多個眼睛檢查代碼。代碼審查是發(fā)現(xiàn)問題和知識分享的好機會。

9. 自動化集成： 將代碼審查工具的集成自動化，以便在代碼提交或持續(xù)集成過程中自動運行代碼審查。這有助于確保每次提交都經(jīng)過了審查。

10. 持續(xù)改進(jìn)： 定期審查代碼審查工具的輸出，了解項目中的常見問題，并采取措施來改進(jìn)代碼質(zhì)量。

通過合理配置和使用IntelliJ IDEA的內(nèi)置代碼檢查工具，以及集成SonarQube等外部工具，你可以顯著提高代碼質(zhì)量，降低潛在的bug和技術(shù)債務(wù)，從而使項目更加可維護(hù)和穩(wěn)定。