Question

我们已经构建了一个项目，现在准备生成一些简单的报告。一种可能的报告形式就是用于显示单元测试结果的 HTML 页面。测试成功还是失败了？哪些测试失败了？你也可以为代码提供 JavaDoc，对代码添加标注，以方便查阅。所有这些都生成好以后，可以运行命令 mvn site：

$mvn site

[INFO]Scanning for projects……

[INFO]-------------------------------------------------------------------------

---

[INFO]Building Harnessing Hibernate：Chapter Twelve：Maven

[INFO]task-segment：[site]

[INFO]-------------------------------------------------------------------------

---

[INFO]Setting property：classpath.resource.loader.class=＞'org.codehaus

.plexus.velocity.ContextClassLoaderResourceLoader'.

[INFO]Setting property：velocimacro.messages.on=＞'false'.

[INFO]Setting property：resource.loader=＞'classpath'.

[INFO]Setting property：resource.manager.logwhenfound=＞'false'.

[INFO]**************************************************************

[INFO]Starting Jakarta Velocity v1.4

[INFO][site：site]

Constructing Javadoc information……

Standard Doclet version 1.6.0_02

Building tree for all the packages and classes……

Generating～/examples/ch12/target/site/apidocs\index.html……

[INFO]Generate"Source Xref"report.

[INFO]Generate"Continuous Integration"report.

[INFO]Generate"Dependencies"report.

[INFO]Generate"Issue Tracking"report.

[INFO]Generate"Project License"report.

[INFO]Generate"Mailing Lists"report.

[INFO]Generate"About"report.

[INFO]Generate"Project Summary"report.

[INFO]Generate"Source Repository"report.

[INFO]Generate"Project Team"report.

[INFO]Final Memory：23M/42M

以上输出片段有相当多的删减。如果你运行 mvn site，将能够看到页面和活动的页面。Maven 创建了一个项目网站，并生成了一些有用的报告。以下我们快速浏览一下结果。

图　12-1　生成 Maven 的网站

Maven 生成的简单网站上列出了许多与项目有关的报告和页面。虽然默认的网站模板看起来不算太好，如图 12-1 所示，但它确实提供了一个基本的网站，你可以此为基础来在线发布有关项目的信息。如果项目的 POM 配置正确，就可以生成一个简单的页面，列出了项目的成员、许可协议以及一个指向问题管理工具（如 Bugzilla、JIRA 或 Trac）的链接。如果你正在创建一个开源项目，这些信息足以构成一个公共的、面向开发人员的网站的坚实基础。即便你是在一个封闭的环境中开发项目，这样的网站对开发团队来说也是有用的。默认 Maven 网站的感观风格有许多需要改进之处，可以使用保存在 src/site 目录下的样式表（stylesheets）和模板来进行定制。如果点击导航菜单左边的 Project Reports（项目报告）链接，就可以看到一些有用的报告。还可以浏览项目的 JavaDoc，如图 12-2 所示。

图　12-2　网站内的项目 JavaDoc 页面

点击 Surefire 报告链接，就可以浏览单元测试的结果（如图 12-3 所示）。

图　12-3　项目的单元测试结果页面

因为这个项目只定义了一个单元测试，所以 Surefire 报告没有多少内容。如果项目中包含了大量的测试，就可以在这个报告中检查代码的总体质量。如果发现单元测试有问题，或者如果想查找代码中特定的某一错误，就可以使用 JXR 报告来浏览经过标注的、交叉引用（cross-referenced）的源代码（如图 12-4 所示）。

图　12-4　交叉引用的 HTML 源代码

在查看代码时，JXR 报告很有用。还有很多其他报告可以使用，例如，用 Clover 报告测试的覆盖度，以及 JDepend 报告、DocBook、PDF 生成等。

这里我们不打算详细介绍 Maven 的工作原理，只是进行了编译、构建数据库、测试、打包、对某个简单的示例代码进行文档化。在下一节中，我们将看看让这一切都成为可能的文件：pom.xml。这样，对 Maven 的配置和定制，你才会有一定的感觉。