news 2026/4/18 7:28:40

【maven】maven-site-plugin 插件

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
【maven】maven-site-plugin 插件

maven-site-plugin是 Maven 的一个核心插件,用于生成项目文档网站。以下是详细介绍:

主要功能

  1. 生成项目站点

    • 集成各种项目报告(Javadoc、测试报告、检查报告等)

    • 生成标准化的项目文档结构

    • 支持多模块项目的聚合站点

  2. 报告集成

    • Javadoc API 文档

    • 单元测试报告

    • 代码覆盖率报告(配合 jacoco 等)

    • 静态代码分析报告(Checkstyle、PMD、FindBugs)

    • 项目信息(依赖、许可证、团队等)

常用 Goals

Goal说明
site:site生成项目站点(HTML 文件输出到target/site/
site:stage将站点暂存到本地目录(用于多模块项目预览)
site:deploy将生成的站点部署到配置的服务器(需配置<distributionManagement>
site:run启动一个本地 HTTP 服务器预览站点(已弃用,建议用mvn site+ 本地打开index.html

注意:从Maven Site Plugin 3.0+开始,site:run已被移除。

基本配置

在 pom.xml 中配置

<project> <!-- 配置站点信息 --> <name>My Project</name> <description>项目描述</description> <url>https://example.com</url> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.12.1</version> <!-- 使用最新版本 --> </plugin> </plugins> </build> <!-- 配置报告插件 --> <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>3.5.0</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>3.0.0</version> </plugin> </plugins> </reporting> </project>

一键生成站点

mvn clean site

执行完后,静态站点位于target/site/;用浏览器打开target/site/index.html即可查看。


常见增强项

  • 中文站点 / UTF-8
    <properties>里加:

    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

    在插件<configuration>里加:

    <locales>zh_CN</locales>

自定义输出目录

<configuration> <outputDirectory>${project.build.directory}/my-site</outputDirectory> </configuration>

本地启服务实时预览

mvn site:run

会自动启动 Jetty,打开 http://localhost:8080 即可边改边看。


多模块项目

先生成整体站点,再一次性发布:

mvn site site:stage

site:stage会把所有模块的页面聚合到target/staging/目录,方便一次性拷贝到 nginx、Apache 或通过site:deploy上传到远程服务器。


与 AsciiDoc 集成(可选)

如果想用.adoc写文档,把文件放到src/site/asciidoc/,然后在插件里增加依赖即可:

<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.12.1</version> <dependencies> <dependency> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>2.2.1</version> </dependency> </dependencies> </plugin>

运行mvn site后会自动把.adoc渲染成.html并嵌入站点导航。




版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/3/28 15:52:20

智慧养老服务系统的设计与实现_SpringBoot+Vue+Springcloud微服务分布式

目录智慧养老服务系统的设计与实现项目技术支持可定制开发之功能亮点源码获取详细视频演示 &#xff1a;文章底部获取博主联系方式&#xff01;同行可合作智慧养老服务系统的设计与实现 智慧养老服务系统基于SpringBootVueSpringCloud微服务分布式架构设计&#xff0c;旨在为老…

作者头像 李华
网站建设 2026/4/13 10:40:46

校园物资招标投标竞标系统_SpringBoot+Vue+Springcloud微服务分布式

目录校园物资招标投标竞标系统&#xff08;SpringBootVueSpringCloud微服务分布式&#xff09;摘要项目技术支持可定制开发之功能亮点源码获取详细视频演示 &#xff1a;文章底部获取博主联系方式&#xff01;同行可合作校园物资招标投标竞标系统&#xff08;SpringBootVueSpri…

作者头像 李华
网站建设 2026/4/17 22:13:13

校园自行车电动车租赁系统_SpringBoot+Vue+Springcloud微服务分布式

目录校园自行车电动车租赁系统摘要项目技术支持可定制开发之功能亮点源码获取详细视频演示 &#xff1a;文章底部获取博主联系方式&#xff01;同行可合作校园自行车电动车租赁系统摘要 该系统基于SpringBootVueSpringCloud微服务分布式架构&#xff0c;旨在为校园内师生提供高…

作者头像 李华
网站建设 2026/4/10 21:56:18

5分钟快速验证:用模型量化加速你的AI创意原型

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 开发一个快速模型量化验证平台&#xff0c;功能&#xff1a;1. 拖拽上传自定义模型 2. 一键自动化量化 3. 实时性能预览 4. 导出量化后模型 5. 生成验证报告。要求支持ONNX格式&am…

作者头像 李华
网站建设 2026/4/16 22:30:49

零基础学用例图:5分钟用AI做出第一个专业图表

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 开发一个交互式用例图学习工具&#xff0c;分步骤引导新手创建简单用例图&#xff1a;1) 识别系统边界 2) 添加参与者 3) 添加基础用例 4) 建立关系。每个步骤提供可视化示例和常见…

作者头像 李华
网站建设 2026/3/29 3:09:47

电脑小白必看:Windows启动失败的简单自救指南

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 创建一个面向初学者的Windows启动问题解决指南应用。要求&#xff1a;1. 使用通俗易懂的语言&#xff1b;2. 图文并茂的步骤说明&#xff1b;3. 常见问题FAQ&#xff1b;4. 一键式…

作者头像 李华