Maven3实战笔记14Maven生成项目站点

1.  前言

一个项目的成败离不开项目各个阶段的信息反馈，总结报告，团队建设信息等等因素。及时反应这些信息，落实到具体的数字上，才能反映一个团队的战斗力。也更能反映出一个团队的问题出现在哪里，其实这是“敏捷开发”所提倡的概念，及时反映团队信息，用数据报告说话，团队成员看到这些，自己心里就有个数，自动调整、自动反馈、及时反应新数据。这样对于项目本身也有好处，也能够积极调动团队成员主观能动性。不过就是一个问题，团队成员被资本家们剥削得太彻底、太赤裸裸了吧。Maven可以生成一个静态站点，该站点就是反应以上各种信息的，虽然说该静态站点还不足和Trac、Jira等项目管理工具相媲美，但是也能体现项目的一些状况了，毕竟Maven与Trac等开源工具侧重点不同。

2.  基本站点

构建项目站点其实是Maven项目构建的一个生命周期，周期是site。在Maven3中需要在pom.xml配置一下site插件，执行相关命令即可。

pom.xml增加如下配置

	<build>
		<pluginManagement>
			<plugins>				
<!-- 构建项目站点报告插件-->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-site-plugin</artifactId>
					<version>3.0-beta-3</version>
					<configuration>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>

  执行命令

mvn clean site

 在生成文件夹target下面有一个site文件夹，里面就是静态页面，直接打开index.html网页文件即可看到报告。

左边的英文菜单比较简单，大家都知道是什么意思。

下面我们加一些其他信息看看项目站点生成是什么样子，pom.xml加入如下一些内容3.  站点报告信息

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

	<!-- 问题解决信息 -->
	<issueManagement>
		<system>Linux</system>
		<url>http://www.baidu.com/</url>
	</issueManagement>

	<!-- 持续集成信息 -->
	<ciManagement>
		<url>http://127.0.0.1:8080/hudson</url>
		<system>windows</system>
	</ciManagement>

	<!-- 开发人员信息 -->
	<developers>
		<developer>
			<id>liuyan</id>
			<email>[email protected]</email>
			<name>liuyan</name>
			<organization>uxian99</organization>
			<roles>
				<role>softwareengineer</role>
			</roles>
			<timezone>8</timezone>
		</developer>
	</developers>

	<!--许可证 -->
	<licenses>
		<license>
			<url>http://127.0.0.1:8080</url>
			<comments>评论</comments>
			<name>完全开源</name>
		</license>
	</licenses>

	<scm>
		<connection>scm:svn:https://liuyan:[email protected]:8443/svn/mysvn/mysrc/01-OpenSource/maven/MavenAccount-aggregator
		</connection>
		<developerConnection>scm:svn:https://liuyan:[email protected]:8443/svn/mysvn/mysrc/01-OpenSource/maven/MavenAccount-aggregator
		</developerConnection>
		<url>https://127.0.0.1:8443/svn/mysvn/mysrc/01-OpenSource/maven/MavenAccount-aggregator
		</url>
	</scm>

<build>
		<pluginManagement>
			<plugins>				
<!-- 构建项目站点报告插件-->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-site-plugin</artifactId>
					<version>3.0-beta-3</version>
					<configuration>
						<!-- 配置站点国际化 -->
						<locales>zh_CN</locales>
						<!-- 输出编码 -->
						<outputEncoding>GBK</outputEncoding>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>

 在原来的站点上加入了一些有意思的选项：问题跟踪信息；持续集成信息；开发人员信息；许可证信息；生成的站点还配置了编码格式和地区，让站点国际化。

 

项目信息是描述项目基本的信息，如果想要看到比较详细的报告数据，还需要在pom.xml加入相关的报告插件才行。

pom.xml增加如下内容值得一提的是，像Struts等等Apache家族的项目，自身源码中就有site.xml信息，可以模仿这些开源家族项目配置自己的个性化项目占站点。

<build>
		<pluginManagement>
			<plugins>				
<!-- 构建项目站点报告插件-->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-site-plugin</artifactId>
					<version>3.0-beta-3</version>
					<configuration>
<!-- 配置报告信息 -->
						<reportPlugins>
							<!-- 检查代码规范报告 -->
							<plugin>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-checkstyle-plugin</artifactId>
							</plugin>
							<!-- 测试报告 -->
							<plugin>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-surefire-report-plugin</artifactId>
							</plugin>
							<!-- 项目基本信息报告 -->
							<plugin>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-project-info-reports-plugin</artifactId>
								<version>2.2</version>
								<configuration>
									<dependencyDetailsEnabled>true</dependencyDetailsEnabled>
									<dependencyLocationsEnabled>false</dependencyLocationsEnabled>

								</configuration>
							</plugin>
							<!-- 项目API doc报告 -->
							<plugin>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-javadoc-plugin</artifactId>
								<version>2.7</version>
							</plugin>
							<!-- 项目源代码报告 -->
							<plugin>
								<groupId>org.codehaus.mojo</groupId>
								<artifactId>jxr-maven-plugin</artifactId>
							</plugin>
							<!-- 项目还需要做的TODO报告 -->
							<plugin>
								<groupId>org.codehaus.mojo</groupId>
								<artifactId>taglist-maven-plugin</artifactId>
							</plugin>
							<!-- 项目源代码分析报告 -->
							<plugin>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-pmd-plugin</artifactId>
								<version>2.5</version>
								<configuration>
									<linkXref>true</linkXref>
									<sourceEncoding>GBK</sourceEncoding>
									<minimumTokens>100</minimumTokens>
									<targetJdk>1.5</targetJdk>
								</configuration>
							</plugin>
							<!-- 生成站点文件具体信息报告 -->
							<plugin>
								<groupId>org.apache.maven.plugins</groupId>
								<artifactId>maven-linkcheck-plugin</artifactId>
								<version>1.1</version>
								<configuration>
								</configuration>
							</plugin>
							<!-- 单元测试覆盖率报告 -->
							<plugin>
								<groupId>org.codehaus.mojo</groupId>
								<artifactId>cobertura-maven-plugin</artifactId>
							</plugin>
						</reportPlugins>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>

 聚合项目的报告信息如下

 可以点击自行查看相应报告。

除了聚合项目，我们看看其中子模块的报表

 这个子模块报告信息，明显比聚合模块多很多项目，比如点击测试覆盖率

 因为聚合项目除了组织各模块外没其他目的，更不会有什么核心代码和测试代码包含其中，所以呢，一般各个模块的报告信息要多于聚合模块报告。因为真干实事的也是子模块。

具体的报告插件可以参考官方的文档http://maven.apache.org/plugins/index.html

4.  站点个性化配置

站点个性化是为了生成的站点的样式、皮肤、图片更加符合自身项目，而不是显示默认的Maven自己的样式。试想如果客户看到你给他交付的报告站点出现power by Maven的字样或者图片，客户心理总感觉很别扭。需要一个特殊的配置文件site.xml，将其放到src\site\下面。

内容如下

<?xml version="1.0" encoding="UTF-8"?>
<project name="MyMaven">
    <bannerLeft>
        <name>uxian99</name>
        <src>file://C:/sanguosha/11.jpg</src>
        <href>http://www.apache.org/</href>
    </bannerLeft>
    <body>
    <menu ref="parent" inherit="bottom" />
    <menu ref="reports"></menu>
    </body>
</project>

 构建站点后效果如下