公司最近嚴(yán)抓軟件質(zhì)量問題,我抽空了解了下提高代碼質(zhì)量的一些開源工具。其中一個就是findbugs。使用findbugs有很多方式,比如:安裝eclipse findbugs插件,通過maven調(diào)用生成報告。今天主要演示下maven與findbugs集成。
第一步:下載maven,我使用的是maven3。把maven的命令加入PATH環(huán)境變量。
第二步:創(chuàng)建一個普通的maven java工程。命令如下:mvn archetype:maven-archetyp-quickstart –DgroupId=com.tianya –DartifactId=baowu。如果正常執(zhí)行的話會生成如下結(jié)構(gòu)的一個工程。
第三步:我們看下pom文件
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.tianya</groupId>
<artifactId>baowu</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>
<!--配置插件來源 -->
<pluginRepositories>
<pluginRepository>
<id>Codehaus repository</id>
<url>http://repository.codehaus.org/</url>
</pluginRepository>
</pluginRepositories>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<!-- <configLocation>${basedir}/springside-findbugs.xml</configLocation> -->
<threshold>High</threshold>
<effort>Default</effort>
<findbugsXmlOutput>true</findbugsXmlOutput>
<!-- findbugs xml輸出路徑--> <findbugsXmlOutputDirectory>target/site</findbugsXmlOutputDirectory>
</configuration>
</plugin>
</plugins>
</build>
</project>
我來解釋下xml配置:
l 配置插件下載地址
<!--配置插件來源 -->
<pluginRepositories>
<pluginRepository>
<id>Codehaus repository</id>
<url>http://repository.codehaus.org/</url>
</pluginRepository>
</pluginRepositories>
l 由于maven核心做的事情都是抽象的構(gòu)建過程,很多實際的工作都是具體的插件來實現(xiàn)。所以很顯然,maven以插件的方式集成findbugs。
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<!-- <configLocation>${basedir}/springside-findbugs.xml</configLocation> -->
<!-- findbugs xml輸出--> <findbugsXmlOutput>true</findbugsXmlOutput>
<!-- findbugs xml輸出路徑--> <findbugsXmlOutputDirectory>target/site</findbugsXmlOutputDirectory>
</configuration>
</plugin>
l 大家注意到了findbugs插件里,我注釋掉了一句話,其實這句話就是可以使用自己的fingbugs配置來做檢查。我用的是springside的一個xml文件。
第四步:配置好相關(guān)文件之后,接下來就是執(zhí)行相關(guān)命令了。
mvn compile findbugs:findbugs生成報告。報告生成的地址就是${項目根目錄}/target/site。也可以通過mvn findbugs:gui gui界面查看findbugs的report。