使用 CodeNarc 分析 Grails 專案程式碼品質

CodeNarc 是用於 Groovy 語言的程式碼分析工具，它可以協助找出程式碼存在的缺陷、壞習慣、不一致等問題，提供高彈性的規則框架，方便為專案訂定規則，並可以整合到建置工具及產生報表。

CodeNarc analyzes Groovy code for defects, bad practices, inconsistencies, style issues and more. A flexible framework for rules, rulesets and custom rules means it's easy to configure CodeNarc to fit into your project. Build tool, framework support, and report generation are all enterprise ready.

如果尚未瞭解程式碼分析對軟體專案的好處，可以參考「軟體構築美學」這本書的第五章，雖然該書是為 .NET 所寫，但其精神同樣適用於 Java / Grails 的開發。

在 Grails 的建置流程加入 CodeNarc 的支援，可以說宇宙超級無敵簡單，已經提供 CodeNarc for Grails Plugin，所以強烈建議...一定要加上 CodeNarc 整合。

安裝方法：

執行「grails install-plugin codenarc」

或

編輯 grails-app/conf/BuildConfig.groovy 在 plugins 區塊加上 compile ":codenarc:0.18.1" 設定。（適用 Grails 2.2.0 或更新版本）

安裝好 Plugin 以後，只要執行：

grails codenarc

就會產生報表檔案：target/CodeNarcReport.html

報表的畫面請參考以下畫面：

對專案管理者來說，只要由資深開發者訂定規則，依照 CodeNarc 的規則語法撰寫定義檔，就可以在持續整合（continuous integration）階段，自動產生程式碼的分析報表。

如此一來，就能夠要求每位開發者“盡可能”撰寫出能夠通過檢查的程式碼；能夠通過程式碼規則分析的查核，並不代表程式碼就沒 BUG 或很好，但至少在風格上會比較一致，而且能夠避免一些愚蠢的錯誤。