Mybatis Plugin插件安裝使用說明

1 介紹

為了讓開發(fā)者更規(guī)范、快速地工作，為了將編碼規(guī)范推進并實施起來，該插件主要是在mapper接口方法和mapper XML文件之間來回切換非常方便，而且還可以自動生成xml代碼，極大的提高了開發(fā)效率。

2 安裝

"File->settings"

image.png

"Plugins->Browse repositories"

image.png

image.png

阿里編碼規(guī)約插件安裝使用說明

1 介紹

為了讓開發(fā)者更規(guī)范、快速地工作，為了將編碼規(guī)范推進并實施起來，阿里C3P項目組研發(fā)了一套自動化的IDE檢測插件。
功能提現(xiàn)在以下三個方面：
1.手動掃描代碼后，不符合規(guī)約的代碼按Blocker/Critical/Major三個等級顯示出來。
2.基于Inspection機制的實時檢測功能，編寫代碼的同時也能快速發(fā)現(xiàn)問題所在。
3.對于歷史代碼，部分規(guī)則實現(xiàn)了批量一鍵修復的功能。

2 安裝

"File->settings"

image.png

"Plugins->Browse repositories"

image.png

image.png

image.png

3 使用說明

可以分析當前編輯的文件，也可以分析整個項目模塊代碼。

image.png

image.png

從圖中可以看出掃描結(jié)果有block錯誤（不符合命名方式）；有critical錯誤和major錯誤。雙擊可以定位至代碼處，右側(cè)窗口還有代碼的批量修復功能。

Blocker/Critical/Major三個等級，在 Snoar 中對代碼規(guī)則有五個級別，這是前三個，翻譯下就是：崩潰/嚴重/重要 ，也就是說前兩級別是必須要處理掉的。

FindBugs-IDEA插件使用說明

1 介紹

這個插件可以幫助我們查找隱藏的bug,比較重要的功能就是查找潛在的null指針。在編寫代碼的過程中,我們可能不會一直記得檢查空的引用,在我們測試時可能很難發(fā)現(xiàn)問題,但是應用上線之后，面對大量的用戶，很多問題就會浮現(xiàn)出來。所以在編碼時，使用findbugs檢查一下很有必要。

2 安裝

"File->settings"

image.png

"Plugins->Browse repositories"

image.png

image.png

image.png

3 使用說明

可以分析單個文件，包下面的所有文件，整個module下的文件，整個project下的文件，右鍵想要分析的文件名/包名/module名/project
1.右鍵項目模塊

image.png

分析完之后就會出現(xiàn)結(jié)果面板

image.png

image.png

image.png

點擊如圖按鈕可分析當前文件

4 一些常見的錯誤信息

Bad practice 代碼中的一些壞習慣

Class names should start with an upper case letter 主要包括類名的命名，以大寫字母開頭

Method names should start with a lower case letter 方法名以小寫字母開頭

Field names should start with a lower case letter 字段名以小寫字母開頭

equals()method does not check for null argument equals()方法應該檢查非空

Class defines equals() and uses Object.hashCode() 一個類覆寫了equals方法，沒有覆寫hashCode方法，使用了Object對象的hashCode方法

Method ignores exceptional return value 方法忽略返回值的異常信息

Equals method should not assume anything about the type of its argument equals(Object)方法不能對參數(shù)o的類型做任何的假設(shè)。比較此對象與指定的對象。當且僅當該參數(shù)不為 null，并且是表示與此對象相同的類型的對象時，結(jié)果才為 true。

Comparison of String objects using == or != 用==或者！=去比較String類型的對象

Method might ignore exception 方法可能忽略異常

Method invokes System.exit() 在方法中調(diào)用System.exit(…)語句，考慮用RuntimeException來代替

Method ignores result of InputStream.read() InputStream.read方法忽略返回的多個字符，如果對結(jié)果沒有檢查就沒法正確處理用戶讀取少量字符請求的情況。

Dodgy code 糟糕的代碼

Switch statement found where default case is missing Switch沒有默認情況下執(zhí)行的case語句

Switch statement found where one case falls through to the next case Switch語句中一個分支執(zhí)行后又執(zhí)行了下一個分支。通常case后面要跟break 或者return語句來跳出。

Dead store to local variable 該指令為局部變量賦值，但在其后的沒有對她做任何使用。通常，這表明一個錯誤，因為值從未使用過。

Write to static field from instance method 在實例方法寫入靜態(tài)字段

Redundant nullcheck of value known to be non-null 方法中對不為空的值進行為空的判斷。

Method uses the same code for two branches 此方法使用相同的代碼，以實現(xiàn)兩個有條件的分支。檢查以確保這是不是一個編碼錯誤

Exception is caught when Exception is not thrown 在try/catch塊中捕獲異常，但是異常沒有在try語句中拋出而RuntimeException又沒有明確的被捕獲

Integral division result cast to double or float 整形數(shù)除法強制轉(zhuǎn)換為double或者float類型。

Possible null pointer dereference due to return value of called method 方法的返回值沒有進行是否為空的檢查就重新賦值，這樣可能會出現(xiàn)空指針異常。

Useless object created 對象創(chuàng)建了并沒有用

Unread public/protected field 沒有用到的字段

Internationalization 關(guān)于代碼國際化相關(guān)方面的

Consider using Locale parameterized version of invoked method

使用平臺默認的編碼格式對字符串進行大小寫轉(zhuǎn)換，這可能導致國際字符的轉(zhuǎn)換不當。使用以下方式對字符進行轉(zhuǎn)換

Performance 關(guān)于代碼性能相關(guān)方面的

Boxing/unboxing to parse a primitive
類型轉(zhuǎn)換 比如字符串轉(zhuǎn)換成int 應該使用Integer.parseInt(“”) 代替Integer.valueOf(“”)

Method concatenates string using + in aloop
每次循環(huán)里的字符串+連接，都會新產(chǎn)生一個string對象，在java中，新建一個對象的代價是很昂貴的，特別是在循環(huán)語句中，效率較低 。解決辦法：使用StringBuffer或者StringBuilder重用對象。

Private method is never called 私有方法沒有被調(diào)用

Explicit garbage collection;extremely dubious except in benchmarking code
在代碼中顯式的調(diào)用垃圾回收命名，這樣做并不能起作用。在過去，有人在關(guān)閉操作或者finalize方法中調(diào)用垃圾回收方法導致了很多的性能浪費。這樣大規(guī)模回收對象時會造成處理器運行緩慢。

Unread field:should this field be static? 沒有用到的static 字段

should be a static inner class 此內(nèi)部類應該使用static修飾

Experimental

Method may fail to clean up stream or resource on checked exception
這種方法可能無法清除（關(guān)閉，處置）一個流，數(shù)據(jù)庫對象，或其他資源需要一個明確的清理行動 。解決方法：流的關(guān)閉都寫在finally里面

Malicious code vulnerability 關(guān)于惡意破壞代碼相關(guān)方面的

May expose internal representation by incorporating reference to mutable object
此代碼把外部可變對象引用存儲到對象的內(nèi)部表示。如果實例受到不信任的代碼的訪問和沒有檢查的變化危及對象和重要屬性的安全。存儲一個對象的副本，在很多情況下是更好的辦法。

Field isn’t final but should be 此字段前應該加final

Field isn’t final and can’t be protected from malicious code 此字段前應該加final

Field should be package protected
一個靜態(tài)字段是可以被惡意代碼或其他的包訪問修改?？梢园堰@種類型的字段聲明為final類型的以防止這種錯誤。

Multithreaded correctness 關(guān)于代碼正確性相關(guān)方面的

Static DateFormat DateFormat 在多線程中本身就是不安全的，如果在線程范圍中共享一個DateFormat的實例而不使用一個同步的方法在應用中就會出現(xiàn)一些奇怪的行為。

Call to static DateFormat DateFormats多線程使用本事就是不安全的,改進方法：需要創(chuàng)建多實例或線程同步

Correctness 關(guān)于代碼正確性相關(guān)方面的

Nullcheck of value previously dereferenced 此代碼之前廢棄null值檢查。解決辦法 進行null檢查

Possible null pointer dereference 可能為null

Null pointer dereference 對象賦為null值后 沒有被重新賦值

Possible null pointer dereference in method on exception path 在異常null值處理分支調(diào)用的方法上，可能存在對象去除引用操作

value is null and guaranteed to be dereferenced on exception path exception分支上，存在引用一個null對象的方法，引發(fā)空指針異常。

Self comparison of value with itself 方法中對一個局部變量自身進行比較運算，并可說明錯誤或邏輯錯誤。請確保您是比較正確的事情。

An apparent infinite recursive loop 明顯的無限迭代循環(huán),將導致堆棧溢出.