Maven 项目报告插件
Maven 项目报告插件,都是对于前面生成的项目站点的内容丰富,因此都是基于项目站点的,生成的命令和生成项目站点一致(mvn site),项目报告插件的配置和一般插件不同,是在 project->reporting->plugins 元素下配置的。
-
JavaDocs插件
使用JDK的javadoc工具,基于项目的源代码生成JavaDocs文档,如果希望一次生成聚合项目的所有文档,该插件也是支持的,配置如下:
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
</plugin>
</plugins>
</reporting>
在生成项目站点后,会增加链接,Test JavaDocs 和 JavaDocs 来显示项目的 JavaDocs 文档
-
Source Xref 插件
如果能够随时随地的打开浏览器访问项目的最新源码,那无疑会方便团队之间的交流,maven-jxr-plugin 能够帮助我们完成这个目标,配置如下:
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>2.2</version>
<configuration>
<!-- 标识当前项目是否为聚合项目 -->
<aggregate>true</aggregate>
</configuration>
</plugin>
</plugins>
</reporting>
在生成项目站点后,会增加链接 Source Xref
-
CheckStyle 插件
该插件时用来帮助Java开发人员遵循编码规范的工具,maven-checkstyle-plugin 能根据一套规则自动检查Java代码,使得团队能够方便的定义自己的编码规范,默认情况下 会使用Sun 定义的编码规范,可以选择其他预定义的规则,也可以自定义规则,目前不支持聚合模块配置,预定义的规范有:
- config/sun_checks.xml:sun定义的编码规范(默认值)
- config/maven_checks.xml:Maven社区定义的编码规范
- config/turbine_checks.xml:turbine 定义的编码规范
- config/avalon_checks.xml:Avalon 定义的编码规范
配置如下:
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>2.5</version>
<configuration>
<!-- 定义代码编码规范 -->
<configLocation>config/sun_checks.xml</configLocation>
</configuration>
</plugin>
</plugins>
</reporting>
在生成项目站点后,会增加链接 Checkstyle
-
PMD插件
该插件时一款强大的Java源代码分析工具,能够寻找代码中的问题,包括潜在的BUG、无用代码、可优化代码、重复代码以及过于复杂的表达式等,该插件的详细信息可以访问 http://pmd.sourceforge.net 进行了解,除了生成PMD报告外,还会生成CPD的报告,该报告中包含了代码拷贝粘贴的分析结果,PMD包含了大量的分析规则,可以访问 http://pmd.sourceforge.net/rules/index.html 来查看规则,配置如下:
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>2.5</version>
<configuration>
<!-- 标识当前项目是否为聚合项目 -->
<aggregate>true</aggregate>
<rulesets>
<!-- 默认规则 -->
<ruleset>rulesets/basic.xml</ruleset>
<ruleset>rulesets/unusedcode.xml</ruleset>
<!-- 增加非默认规则 -->
<ruleset>rulesets/braces.xml</ruleset>
<ruleset>rulesets/naming.xml</ruleset>
<ruleset>rulesets/strings.xml</ruleset>
</rulesets>
</configuration>
</plugin>
</plugins>
</reporting
在生成项目站点后,会增加链接 CPD Report 和 PMD Report
-
Cobertura插件
该插件生成测试覆盖率报告,该插件还不支持报告聚合,配置如下:
<reporting>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>cobertura-maven-plugin</artifactId>
<version>2.4</version>
</plugin>
</plugins>
</reporting>
在生成项目站点后,会增加链接 Cobertura Test Coverage