Maven：站点生成

Posted 2021-04-30 优才网

一、生成简单的站点 

 1.在pom.xml文件中，配置maven-site-plugin插件（Maven的site生命周期如果默认绑定了site插件就可以不配置）。 

2.配置正确版本之后，在项目之下运行mvn site就能直接生成一个最简单的站点。 

3.待Maven运行完成后，可以在项目的target/site/目录下找到Maven生成的站点文件，包括dependencies.html、dependency-convergence.html、index.html和css、images文件夹。

4.点击index.html文件，打开生成的站点。

二、丰富项目的信息 

1.默认情况下，Maven生成的站点包含了很多项目的信息链接，这其实是由一个名为maven-project-info--reports-plugin的插件（Maven3中，该插件内置在maven-site-plugin中，Maven2内置在核心源码中）生成的，该插件会基于POM配置生成下列项目信息报告（见上站点截图）： 

关于（about）：项目描述

持续集成（Continuous Integeration）：项目持续化集成服务器信息； 

依赖（Dependencies）：项目依赖信息，包括传递性依赖、依赖图、依赖许可证以及依赖文件的大小、所包含的类的数目； 
依赖收敛（Dependency Convergence）：针对多个模块项目生成，提供一些依赖健康状况分析； 
依赖管理（Dependency Management）：基于项目的依赖管理生成的报告； 
问题追踪（Issue Tracking）：项目问题追踪系统信息； 
邮件列表（Mailing Lists）：项目的邮件列表信息； 
插件管理（Plugin Management）：项目所有项目插件的列表； 
项目许可证（Project License）：项目许可证信息； 
项目概述（Project Summary）：项目概述包括坐标、名称、描述等； 
项目团队（Project Team）：项目团队信息； 
源码仓库（Source Repository）：项目的源码仓库信息；

   

2.Maven不会凭空生成信息，只有用户在POM中提供了相关配置后，站点才可能包含这些信息的报告。为了让站点包含完整的项目信息，需要配置PMO如下： 

3.执行mvn site重新生成站点，发现对比简单站点，多生成了如 "CI Management" report、"Source Code Management" report等。 

4.有些时候，我们并不需要生成某些项目信息，如：可能不想公开源码仓库信息，可以通过maven-project-info-reports-plugin选择性生成信息项目，pom.xml配置如下： 

5.mvn site生成站点。

三、项目报告插件

除了默认的项目信息报告，Maven社区还提供了大量报告插件，只要稍加配置，用户就能让Maven自动生成各种内容丰富的报告。

一般的插件在<project><build><plugins>配置，报告插件在<project><reporting><plugins>配置。

 
1.JavaDocs：使用JDK的javadoc工具，基于项目源代码生成JavaDocs文档。

pom.xml配置如下： 

执行mvn site生成站点中，包含javadoc文档Project Reports->JavaDocs如下：

2.Source Xref：能够随时随地打开浏览器访问项目的最新源代码。

pom.xml配置如下：

执行mvn site生成站点中，包含源码文档Project Reports->Source Xref如下：

3.CheckStyle：帮助开发人员遵循编码规范的工具，能根据一套规则自动检查Java代码，使得团队能够方便地定义自己的编码规范； 
pom.xml配置如下： 

Checkstyle.xml配置如下（详细配置信息，查看官方文档：http://checkstyle.sourceforge.net/checks.html）： 

执行mvn site生成站点中，包含源码文档Project Reports->CheckStyle如下：

4.PMD：Java源代码分析工具，能够寻找代码中的问题，包括潜在的bug、无用的代码、可优化的代码、重复代码以及过于复杂的表达式。 
pom.xml配置如下：

执行mvn site生成站点中，包含源码文档Project Reports->PMD如下：

关于PMD自定义规则详情查看（http://pmd.sourceforge.net/pmd-4.3.0/howtowritearule.html） 

5.ChangeLog：基于版本控制系统中就近的变更记录生成三份报告（貌似只支持github）。

6.Cobertura：生成测试覆盖率报告。 
pom.xml配置如下：

执行mvn site生成站点中，包含源码文档Project Reports->Coberatura Test如下： 

四、自定义站点外观 

Maven生成的站点非常灵活，除了前面提到的标准信息报告和其它创建生成的报告，还能够自定义站点的外观和布局。

1.创建如下文件目录（src/site）：

2.分别创建site.xml、faqtest.fml和apttest.apt文件:

src/site/site.xml文件（定义了站点描述符，头部内容及外观-1、2、3、4，皮肤-7，导航边栏-5，创建自定义页面-5）

 

src/site/fml/faqtest.fml文件（一种用来创建FAQ页面的XML文档格式） 

src/site/apt/apttest.apt文件（一种类似于维基的文档格式，用它来快速创建简单而又结构丰富的文档） 

3.执行mvn site生成站点中，生成自定义站点如下： 

五、国际化 

1.要正确地生成简单中文站点，首先要确保项目所有的源码，包括pom.xml、site.xml以及apt文档等，都是使用UTF-8编码保存。

2.接下来我们配置pom.xml，配置编码格式，本地语言。

3.执行mvn site生成站点中，生成本地化站点如下：

文章来源：

http://blog.csdn.net/p106786860/article/details/52884750