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

老强君_7079

老强君_7079

2026-08-13

246人浏览

原创

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

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

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

必须放在 下配置报告插件

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

  • 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,这两项会为空或报错。

Java Development Manual
Java Development Manual

Java开发手册规约集合,基于阿里巴巴Java开发手册(嵩山版)。 涵盖7大维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约。 当用户需要:(1) 编写或审查Java代码 (2) 检查命名/代码规范 (3) 处理异常和日志 (4) 编写单元测试 (5) 安全编码 (6) 数据库设...

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

自定义站点结构与外观

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

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

验证与查看生成结果

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

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java maven

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Java Maven专题
Java Maven专题

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

2025.09.15

2820

19

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

2026.05.09

289

25

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

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

2026.09.22

0

25

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

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

2026.09.21

20

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

20

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

NumPy广播机制数学运算与统计分析
NumPy广播机制数学运算与统计分析

本专题整理 NumPy 广播机制、数组数学运算与统计分析相关教程,覆盖广播规则、维度对齐、矩阵与数组加减除法、向量化计算、均值方差、分位数、中位数、直方图和 unique 频次统计等场景,帮助读者掌握 ndarray 高效计算与统计处理方法。

2026.09.21

0

17

NumPy数组创建索引切片与数据选择
NumPy数组创建索引切片与数据选择

本专题整理 NumPy 数组创建、索引、切片与数据选择相关教程,覆盖 np.array、zeros/ones、多维数组形状、基础切片、花式索引、布尔索引、条件筛选、视图与副本等常用场景,帮助读者系统掌握 ndarray 数据构造与高效提取方法。

2026.09.21

0

12

Aionclaw智能助手介绍
Aionclaw智能助手介绍

本专题汇总了AionClaw(AI龙虾助手)的功能介绍与在线使用入口。AionClaw是杭州趣猿人工智能有限公司推出的桌面级AI智能体,能直接在电脑上读写文件、运行脚本、操作浏览器,自动交付Word、PPT、Excel等成品。

2026.09.20

40

13

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习