Maven 生成站点
通常情况下,项目很少是由人来开发完成的。不同团队间或者项目上线后,实际和开发者之交流都可以在上来完成。可以在上操作教程,指南等等,而其他的开发者则可以到关于项目的报告,问题追踪以及版本发布计划等等。今天我们来介绍一下如何使用 Maven 来,并且项目的。
首先我们打开 mall-aggregate 目录下的 pom.xml,并且在其中 maven-site-plugin
。
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.9.0</version>
</plugin>
完之后,Maven 会的下载该。下载完成后,我们在 mall-aggregate 目录下执行mvn clean site
命令。在控制台构建完成后,我们可以查看项目的 target 目录中,已经新产生了 site 目录。这个目录就是用来存放信息目录。
成功后,我们可以执行mvn site:run
命令,在运行这个。运行的时候会使用 Maven 内置的 jetty 容器来启动。启动后,我们可以在浏览器中输入localhost:8080/
来浏览该。
这时候,我们项目的简单就好了。个简单中,我们可以看到关于我们项目的一些信息,比如模块划分,依赖管理,管理,项目描述等等信息。有了这个,与开发者之间,以及开发者与开发者之间就能够更好的进行交流了。
有的时候,我们还想要在里面看到其他的一些信息,诸如,API 文档,规约检查,以及中是否存在某些 Bug 等等。Maven 也提供了丰富的来完成这件事情。这里,我们介绍几个常用的。
首先,我们可以打开 Maven 的官网中的列表,可以看到不同生命周期对应的不同:
这里,我们三个比较常用的作为示例,其他的的可以根据自身项目的需要来自行。
首先我们在列表中找到对应的,点击进入详情后,可以查看该的使用方式和 Maven 坐标。找到坐标后,我们在 pom.xml 中加入该坐标:
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<conuration>
<aggregate>true</aggregate>
</conuration>
</plugin>
</plugins>
</reporting>
在的 Usage 我们可以看到该依赖的方式有两种。
两种依赖方式的区别在于,如果将放入到 build 节点下,则需要会单独的 javadoc 文档,如果将的依赖放在 reporting 节点下,则产生的 javadoc 会作为项目报告的一部分,即会在的目录中。这里,我们选择的是后面一种,随着的,产生 javadoc 。
此时我们在 mall-aggregate 目录下执行 mvn clean site
命令。后,执行mvn site:run
命令启动。启动成功后,尝试访问的地址 localhost:8080
。我们可以看到在的目录中多了 Project Reports 的目录,点开后,我们可以看到 Javadoc 和 Test Javadoc,点击可以查看其产生的。
checkstyle 可以帮助团队中的各个成员来检查编码规范,并检查后的报告。我们首先在 pom.xml 中加入 checkstyle 的依赖:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId></artifactId>
<version>3.1.1</version>
</plugin>
待 Maven 下载该完成后,执行命令mvn clean site
来重新。后,执行mvn site:run
命令来重新启动。启动后,同样是在 Project Reports 目录下,可以看到新的 checkStyle 结果。
Maven 的 jxr 是很强大的,可以随时查看项目的源。相同步骤,首先在 pom.xml 中加入 jxr 的依赖:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>3.0.0</version>
<conuration>
<aggregate>true</aggregate>
<encoding>UTF-8</encoding>
</conuration>
</plugin>
待 Maven 下载该完成后,重新,并重启,即可在左边的目录中看到新的源码目录,点击后即阅读其中的源码。
认情况下,如果想要的外观,需要在src/site
目录下创建 site.xml ,在该中定义其中的参数和配置。
<project name="ximi-mall">
<!-- 定义左侧banner -->
<bannerLeft>
<name>Sonatype</name>
<src>https://www.imooc.com/static/img/index/.png</src>
<href>http://maven.apache.org/</href>
</bannerLeft>
<!-- 定义栏 -->
<body>
<menu ref="reports"/>
</body>
<!-- 定义皮肤 -->
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>1.9</version>
</skin>
</project>
这里,我们简单配置了 site.xml ,重新定义了的 ,以及的皮肤(skin)。重新打开后,样式已经发生了很大的变化。
这里面的皮肤可以直接在 Maven 的官网中找到。其中选择自己喜欢的皮肤类型。
本节中,我们简单介绍了如何使用 Maven 帮助我们来自己项目的, 以及如何简单装饰自己的。有了,我们可以和以及其他的开发者更好的交流。