1. 概述

本文介绍 Maven 构建工具的核心插件之一——site 插件。关于其他核心插件的概述,可参考这篇教程

2. 插件目标

Maven 的 site 生命周期默认绑定两个阶段到 site 插件的目标:

  • site 阶段绑定到 site 目标
  • site-deploy 阶段绑定到 deploy 目标

以下是这些目标的说明:

site
为单个项目生成站点文档,生成的站点仅展示 POM 中定义的构件信息

deploy
将生成的站点部署到 POM 中 distributionManagement 元素指定的 URL

sitedeploy 外,site 插件还提供其他目标用于:

  • 自定义生成文件的内容
  • 控制部署流程

3. 目标执行

由于超级 POM 已包含此插件,无需在 POM 中显式添加即可使用。

3.1 生成站点

执行以下命令生成站点:

mvn site:site
# 或简写为
mvn site

3.2 本地预览

执行以下命令在本地预览站点:

mvn site:run

此命令会将站点部署到 Jetty 服务器,访问地址:http://localhost:8080

⚠️ 注意:run 目标未隐式绑定到 site 生命周期阶段,需直接调用

3.3 停止服务器

Ctrl + C 即可停止服务器

4. 总结

本文介绍了 site 插件及其目标执行方法。更多详细信息可参考Maven 官方文档


原始标题:The Maven Site Plugin | Baeldung