讲师中心 微信公众号
AI工具推荐 视频效率加速

Maven 中怎么配置 site 插件生成项目构建报告文档

老强君_7079

老强君_7079

发布时间:2026-08-13 14:58:26

|

246人浏览过

|

来源于php中文网

原创

在pom.xml的<reporting>中配置报告插件并执行mvn site可生成完整文档站点;需配合mvn clean test确保JaCoCo和Surefire数据就绪,且各插件必须置于<reporting><plugins>下而非<build>中。

maven 中怎么配置 site 插件生成项目构建报告文档

直接在 pom.xml<reporting> 区域配置报告插件,再执行 mvn site 即可生成含构建报告的完整文档站点。关键不是只配 maven-site-plugin,而是让它能调用各类报告插件并读取前置产物(比如测试结果、覆盖率数据)。

必须放在 <reporting> 下配置报告插件

Site 插件本身不生成具体报告,它只是“聚合器”。真实内容由其他报告插件提供,而这些插件必须声明在 <reporting><plugins> 中,不能写在 <build><plugins> 里(那是构建阶段用的)。

  • maven-project-info-reports-plugin:输出项目基本信息、依赖树、许可证、团队成员等
  • maven-javadoc-plugin:生成 API 文档(要求源码有标准 Javadoc 注释)
  • maven-surefire-report-plugin:汇总 src/test 下的单元测试执行结果
  • jacoco-maven-plugin:展示行/分支覆盖率(需先运行测试生成 target/jacoco.exec
  • spotbugs-maven-plugin:替代已停更的 FindBugs,做静态缺陷扫描

JaCoCo 和 Surefire 需要前置测试执行

覆盖率和测试报告依赖实际运行结果。如果跳过测试直接 mvn site,这两项会为空或报错。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 推荐执行顺序:mvn clean test site —— 一次性完成编译、测试、采集数据、生成报告
  • 或者分步:mvn clean test(生成 target/surefire-reports/target/jacoco.exec),再 mvn site
  • 注意:jacoco-maven-plugin 必须在 <build><plugins> 中配置 prepare-agentreport 执行绑定,否则 site 阶段读不到数据

自定义站点结构与外观

生成的 HTML 站点默认结构较基础,可通过以下方式增强可读性与专业性:

  • 创建 src/site/site.xml,用 <body><menu> 添加导航菜单(如“设计说明”“接口约定”)
  • site.xml 中指定 <skin>,例如使用 org.apache.maven.skins:maven-stylus-skin 并覆盖 CSS
  • 把项目说明写成 Markdown(src/site/markdown/index.md),Doxia 引擎会自动转为 HTML
  • 确保 pom.xml 中填写了 <description><developers><licenses> 等字段,它们会自动出现在首页

验证与查看生成结果

执行成功后,所有报告都输出到 target/site/ 目录:

  • 打开 target/site/index.html 查看总览页
  • 各报告子页路径示例:target/site/project-info.html(依赖列表)、target/site/apidocs/(Javadoc)、target/site/cobertura/(旧版覆盖率)或 target/site/jacoco/
  • 若某报告缺失,先检查对应插件是否在 <reporting> 中,再确认前置步骤(如测试是否真运行了)

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

2820

2025.09.15

Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

289

2026.05.09

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

0

2026.09.22

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

0

2026.09.22

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

0

2026.09.22

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

0

2026.09.22

NumPy常见函数使用方法
NumPy常见函数使用方法

本专题整理 NumPy 常见函数使用方法相关教程,覆盖函数大全、参数用法、数组运算、统计聚合、排序处理、where 条件筛选、linspace 创建数列等常用场景,帮助读者快速掌握 NumPy 函数调用思路和实际数据处理技巧。

0

2026.09.22

NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

20

2026.09.22

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

20

2026.09.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn