news 2026/4/23 17:20:55

【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/23 11:44:07

零基础学前端加密:crypto-js.min.js入门教程

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 制作一个面向初学者的crypto-js.min.js教学页面。要求&#xff1a;1. 分步骤展示如何下载和使用crypto-js.min.js&#xff1b;2. 提供5个基础加密示例&#xff08;MD5、SHA1、SHA2…

作者头像 李华
网站建设 2026/4/23 13:42:56

深度学习算法在医疗影像诊断中的实战案例

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 创建一个基于深度学习的肺部CT影像分析系统。功能需求&#xff1a;1.使用U-Net架构进行肺部分割 2.实现结节检测功能 3.包含可视化模块 4.支持DICOM格式输入 5.输出诊断报告模板。…

作者头像 李华
网站建设 2026/4/18 23:28:27

AI助力CONDA安装:智能解决环境配置难题

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 开发一个AI辅助的CONDA安装工具&#xff0c;能够自动检测用户系统环境&#xff08;Windows/macOS/Linux&#xff09;&#xff0c;根据用户指定的Python版本和所需包自动生成CONDA安…

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

AI如何自动反编译JAR包并优化代码

快速体验 打开 InsCode(快马)平台 https://www.inscode.net输入框内输入如下内容&#xff1a; 开发一个AI辅助的JAR包反编译工具&#xff0c;能够自动解析Java字节码并生成可读性强的源代码。要求支持主流反编译器&#xff08;如JD-GUI、FernFlower&#xff09;的集成&#x…

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

Rembg性能测试:不同分辨率图片处理速度

Rembg性能测试&#xff1a;不同分辨率图片处理速度 1. 智能万能抠图 - Rembg 在图像处理与内容创作领域&#xff0c;自动去背景是一项高频且关键的需求。无论是电商商品图精修、社交媒体素材制作&#xff0c;还是AI生成内容的后处理&#xff0c;快速精准地提取主体对象都至关…

作者头像 李华
网站建设 2026/4/23 13:12:35

智能体 vs. 工作流:本质区别、核心对比与协同应用

个人名片 &#x1f393;作者简介&#xff1a;java领域优质创作者 &#x1f310;个人主页&#xff1a;码农阿豪 &#x1f4de;工作室&#xff1a;新空间代码工作室&#xff08;提供各种软件服务) &#x1f48c;个人邮箱&#xff1a;[2435024119qq.com] &#x1f4f1;个人微信&a…

作者头像 李华