Maven生成项目站点

概述

Maven不仅仅是一个自动化构建工具和一个依赖工具，还能够帮助聚合项目信息。POM可以包含各种项目信息、如项目描述、版本控制系统地址、缺陷跟踪系统地址、许可证信息、开发者信息等。
另Maven社区提供了大量插件，能让用户生成各种各样的项目审查报告，包括测试覆盖率、静态代码分析、代码变更等。

生成站点

对maven2来说，站点生成的逻辑是Maven核心的一部分。对Maven3来说，这部分逻辑已经从核心中移除，需要使用3.x版本的maven-site-plugin

maven3生成站点示例

<pluginManagement>
    <plugins>
        <plugn>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.0-beta-1</version>
        </plugn>
    </plugins>
</pluginManagement>

maven2生成站点示例

<pluginManagement>
    <plugins>
        <plugn>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>2.1.1</version>
        </plugn>
    </plugins>
</pluginManagement>

配置完成后，运行mvn site就能直接生成一个最简单的站点。

站点的可配置信息

• 关于（about）：项目描述
• 持续集成（continuous integration）：项目持续集成服务信息
• 依赖（dependencies）:项目的依赖信息，包括传递性依赖、依赖图、依赖许可证以及依赖文件的大小、所包含的类数目，此内容可以使用插件maven-dependency-site生成
• 依赖收敛（dependency convergence）:只针对多模块项目生成，提供一些依赖健康状况分析，如各个模块使用的依赖版本是否一致、项目中是否有SNAPSHOT依赖
• 依赖管理（dependency management）：基于项目的依赖管理配置生成的报告
• 问题追踪（issue tracking）：项目的问题追踪系统信息
• 邮件列表（mailing lists）：项目的邮件列表
• 插件管理（plugin management）：项目所使用插件的列表
• 项目许可证（project license）：项目许可证
• 项目概述（project summary）：项目概述包括坐标、名称、描述等
• 项目团队（project team）：项目团队信息
• 源码仓库（source repository）：项目的源码仓库信息

另选择性的生成项目信息项，可使用插件maven-project-info-reports-plugin

<project>
    ...
    <reporting>
        <plugins>
            <plugn>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-project-info-reports-plugin</artifactId>
                <version>2.1.2</version>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>dependencies</report>
                            <report>project-team</report>
                            <report>issue-tracking</report>
                            <report>license</report>
                        </reports>
                    </reportSet>
                </reportSets>
            </plugn>
        </plugins>
    </reporting>
    ...
</project>

其他项目报告插件介绍

生成项目源码JavaDocs文档

maven-javadoc-plugin

Source Xref可以随时随地打开浏览器访问项目的最新源码

maven-jxr-plugin

CheckStyle帮助Java开发遵循编码规范的工具，能根据一套规则自动检查Java代码

maven-checkstyle-plugin

PMD是一款强大的Java源代码分析工具，能够寻找代码中的问题，包括潜在的bug、无用代码、可优化代码、重复代码以及过于复杂的表达式

maven-pmd-plugin

ChangeLog基于版本控制生成三份变更报告

maven-changelog-plugin

Cobertura生成测试覆盖率报告

cobertura-maven-plugin