news 2026/4/29 1:13:53

【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/4/29 1:12:40

MINIO极速安装:5分钟搞定对象存储部署

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 编写一个一键安装MINIO的Shell脚本&#xff0c;功能包括&#xff1a;1. 自动下载最新版MINIO&#xff1b;2. 创建系统服务&#xff1b;3. 设置防火墙规则&#xff1b;4. 生成访问密…

作者头像 李华
网站建设 2026/4/28 5:48:52

基于springboot物流管理平台设计开发实现

背景分析 物流管理平台在数字化经济背景下成为企业供应链优化的核心工具。传统物流依赖人工调度和纸质记录&#xff0c;存在效率低、错误率高、信息滞后等问题。SpringBoot框架因其快速开发、微服务支持、自动化配置等特性&#xff0c;成为构建现代物流系统的首选技术栈。 技…

作者头像 李华
网站建设 2026/4/28 5:46:53

MyBatis批量更新入门:5分钟学会高效数据操作

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 创建一个最简单的MyBatis批量更新教学示例&#xff0c;要求&#xff1a;1) 从建表SQL开始&#xff1b;2) 包含完整的Mapper接口和XML配置&#xff1b;3) 逐步注释说明每个配置项的…

作者头像 李华
网站建设 2026/4/27 12:29:33

Rembg抠图与3D结合:产品展示新维度

Rembg抠图与3D结合&#xff1a;产品展示新维度 1. 引言&#xff1a;智能万能抠图 - Rembg 在数字内容创作、电商视觉设计和虚拟现实应用日益普及的今天&#xff0c;高质量图像去背景技术已成为提升产品展示效果的核心环节。传统手动抠图耗时费力&#xff0c;而基于AI的自动分…

作者头像 李华
网站建设 2026/4/28 5:47:55

Rembg模型训练技巧:避免过拟合的方法

Rembg模型训练技巧&#xff1a;避免过拟合的方法 1. 智能万能抠图 - Rembg 在图像处理与计算机视觉领域&#xff0c;自动去背景&#xff08;Image Matting / Background Removal&#xff09;是一项高频且关键的任务。无论是电商商品图精修、人像摄影后期&#xff0c;还是AI生…

作者头像 李华
网站建设 2026/4/25 19:15:50

一文掌握ResNet18应用|本地化部署1000类物体识别方案

一文掌握ResNet18应用&#xff5c;本地化部署1000类物体识别方案 &#x1f4cc; 引言&#xff1a;为什么选择 ResNet-18 做本地化图像分类&#xff1f; 在边缘计算、私有化部署和低延迟场景中&#xff0c;轻量级、高稳定性、无需联网调用的图像分类模型正成为刚需。尽管大模型…

作者头像 李华