Maven工具学习使用（十）——生成项目站点

maven2中站点生成是Maven核心的一部分，Maven3中这部分内容已经移除。maven3必须使用3.x版本的maven-site-plugin,maven2则使用最新的2.x的版本，执行mvn site命令，可以在项目的target/site/目录下找到Maven生成的站点文件。例如dependencies.html，打开文件能够看到好多信息的连接，如果是聚合项目还可以看到子模块的链接，打开文件单机子模块的连接无法转到子模块的项目页面，如果将站点发布到服务器上，点击这些连接就可以打开子模块的项目页面。或者将站点预发布到本地某个临时目录也是可以点击的。

mvn site:stage -DstagingDirectory=D:\temp 该命令生成项目站点，并预发布至D:\temp目录

site生命周期的site阶段绑定到了插件maven-site-plugin插件的site目标，site-deploy 目标绑定到了maven-site-plugin的deploy目标。

配置pom文件

默认情况下生成的站点包含了很多项目信息连接，这个主要是由maven-project-info-reports-plugin插件生成的。Maven3中该插件的配置内置在maven-site-plugin中。

站点的信息都来自于pom配置文件，所以需要配置pom文件才能展示响应的信息。如果需要选择性的生成项目信息，可以配置maven-project-info-reports-plugin

项目报告插件

报告插件的配置需要在Maven Site Plugin的插件配置元素下配置报告插件，运行mvn site会执行以下插件

<project>...<reporting><plugins><!-- maven-project-info-reports-plugin该插件使站点的项目信息只包含依赖、团队、问题追踪系统、和许可证几项信息 可根据实际需要选择生成的项目信息--><plugin><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></plugin><!-- maven-javadoc-plugin使用JDK的javadoc工具，基于项目的源代码生成javaDocs文档mvn site 命令能得到项目主源码和测试源码的JavaDocs文档。适用于聚合项目--><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-javadoc-plugin</artifactId><version>2.7</version></plugin><!-- maven-jxr-plugin 实现通过浏览器访问项目的最新源代码，使源码文件通过超链接相连如果之前配置了javaDocs报告，用户还能直接转到源码文件对应的JavaDoc.聚合项目需要配置aggregate元素--><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jxr-plugin</artifactId><version>2.2</version><configuration><aggregate>true</aggregate></configuration></plugin><!-- checkstyle 2.5版本的还不支持报告聚合，如果需要报告聚合需要在经过以下步骤1、创建一个包含checkstyle规则文件的模块checkstyle/pom.xmlcheckstyle/src/main/resources/checkstyle/my-checks.xml2、聚合模块配置maven-checkstyle-plugin依赖该模块<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-checkstyle-plugin</artifactId><version>2.5</version><dependencies><dependency><groupId>com.juvenxu.mvnbook</groupId><artifactId>checkstyle</artifactId><version>1.0</version></dependency></dependencies></plugin></plugins></build>3、在聚合模块配置maven-checkstyle-plugin使用模块中的checkstyle规则，与如下单个模块配置相同1，2，3步骤的原理就是创建一个包含自定义规则文件的依赖，将该依赖加入到项目的classpath中，最后从classpath载入规则文件。maven-checkstyle-plugin 实际上是从classpath载入规则文件，无论规则文件实在当前项目中还是在依赖文件中，处理方式都是一样的。插件内置了四种规则,默认会使用sun定义的编码规范，使用时可以选择预置的规则也可以自定义规则。config/sun_checks.xml  Sun定义的编码规范（默认值）config/maven_checks.xml  Maven社区定义的编码规范config/turbine_checks.xml Turbine定义的编码规范config/avalon_checks.xml  Avalon定义的编码规范--><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-checkstyle-plugin</artifactId><version>2.5</version><configuration><configLocation>config/maven_checks.xml</configLocation><!-- 自定义checkstyle规则文件重写configLocation元素,文件位于src/main/resources/目录下<configLocation>checkstyle/my_checks.xml</configLocation>--></configuration></plugin><!-- PMD是一款强大的Java源码分析工具，它能够寻找代码中的问题，包括潜在的bug、无用代码、可优化代码、重复代码以及过于复杂的表达式。http://pmd/sourceforge.net/默认使用规则为 rulesets/basics.xml,rulesets/unusedcode.xml,rulesets/importss.xmlaggregate参数支持聚合报告--><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-pmd-plugin</artifactId><version>2.5</version><configuration><rulesets><ruleset>rulesets/braces.xml</ruleset><ruleset>rulesets/naming.xml</ruleset><ruleset>rulesets/strings.xml</ruleset></rulesets><aggregate>true</aggregate></configuration></plugin><!-- changelog基于版本控制系统中就近的变更记录生成三分变更报告 Change Log  基于提交的变更报告，包括每次提交的日期、文件、作者、注释等信息Develop Activity 基于作者的变更报告，包括作者列表以及每个作者相关的提价次数和涉及文件数目File Acivity 基于文件的变更报告，包括变更的文件列表及每个文件的变更次数<project><scm><connection>scm:svn:http://192.168.1.103/app/trunk</connection><developrConnecton>scm:svn:https://192.168.1.103/app/trunk</developrConnecton><url>http://192.168.1.103/app/trunk</url></scm></project>--><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-changelog-plugin</artifactId><version>2.2</version><configuration><type>range</type><range>60</range> <!-- 生成近60天的报告，默认30天 --></configuration></plugin><!-- cobertura该版本暂不支持聚合项目，生成测试覆盖率报告 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>cobertura-maven-plugin</artifactId><version>2.4</version></plugin></plugins></reporting>
</project>

设置站点插件的编码方式和语言

<properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>    用什么编码读取源码及文档<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> 用什么编码呈现站点的html文档
</properties>
<plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-pmd-plugin</artifactId><version>2.5</version><configuration><locales>zh_CN</locales></configuration></plugin>
</plugins>

部署站点

Maven支持多种协议部署站点，包括FTP、SCP、DAV，如果使用FTP协议，pom中还需要配置wagon-ftp插件；如果使用SCP协议需要在settings.xml文件中配置密钥相关信息。

执行命令 mvn clean site-deploy 将站点信息部署到url指定的地址。

<project>
...
<distributionManagement><site><id>app-site</id><url>dav:https://xxx.com/sites/app</url></site>
</distributionManagement>
...
</project>