news 2026/5/28 14:08:23

【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/5/20 13:59:32

招数:最后回归测试

招数:最后回归测试 项目临近结束时&#xff0c;所有人员(开发、管理、测试)都要回归测试所有的Bug。每个人都要帮助团队确保这些Bug的确是被修复了&#xff0c;而且别的更改没有导致功能的"回归"。为便于管理&#xff0c;我们可以考虑新增一个字段&#xff0c;标记某…

作者头像 李华
网站建设 2026/5/28 2:22:59

如何用AI简化SEATA分布式事务配置

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 使用AI生成一个基于Spring Cloud和SEATA的分布式事务配置示例。要求包含&#xff1a;1. SEATA Server的Docker配置&#xff1b;2. Spring Boot项目中SEATA客户端的yml配置&#xf…

作者头像 李华
网站建设 2026/5/20 13:59:43

mysqldump --all-databases --single-transaction > full_backup.sql的庖丁解牛

mysqldump --all-databases --single-transaction > full_backup.sql 是 MySQL 逻辑备份 的黄金命令&#xff0c;尤其适用于 InnoDB 事务型数据库的在线热备。一、命令结构解析 mysqldump --all-databases --single-transaction > full_backup.sql部分作用mysqldumpMySQL…

作者头像 李华
网站建设 2026/5/20 13:59:39

1小时验证创意:MySQL数据迁移工具原型开发

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 开发一个MySQL数据迁移工具原型&#xff0c;功能包括&#xff1a;1) 源数据库和目标数据库配置&#xff1b;2) 选择要迁移的表&#xff1b;3) 实时显示迁移进度&#xff1b;4) 生成…

作者头像 李华
网站建设 2026/5/20 13:59:40

新能源汽车S店保养服务管理系统_SpringBoot+Vue+Springcloud微服务分布式

目录新能源汽车S店保养服务管理系统摘要项目技术支持可定制开发之功能亮点源码获取详细视频演示 &#xff1a;文章底部获取博主联系方式&#xff01;同行可合作新能源汽车S店保养服务管理系统摘要 新能源汽车S店保养服务管理系统基于SpringBootVueSpringCloud微服务分布式架构…

作者头像 李华
网站建设 2026/5/20 19:15:06

校园学生心理健康系统_SpringBoot+Vue+Springcloud微服务分布式

目录校园学生心理健康系统摘要项目技术支持可定制开发之功能亮点源码获取详细视频演示 &#xff1a;文章底部获取博主联系方式&#xff01;同行可合作校园学生心理健康系统摘要 校园学生心理健康系统基于SpringBootVueSpringCloud微服务分布式架构设计&#xff0c;旨在通过技术…

作者头像 李华