Maven 核心插件 maven-clean-plugin 使用详解

在软件开发中,构建和管理项目的复杂性随着代码量和依赖的增加而不断提升。Maven作为一个强大的构建工具,简化了这一过程,并通过其插件机制提供了丰富的功能。其中,maven-clean-plugin 是Maven的核心插件之一,它在项目的清理阶段发挥着重要作用。无论是删除旧的编译文件、清理生成的临时文件,还是确保构建环境的整洁,maven-clean-plugin 都是不可或缺的工具。

本文将详细介绍 maven-clean-plugin 的功能、配置方法以及常见的使用场景,帮助开发者更好地理解和利用这一插件,提高项目的构建效率和质量。无论你是Maven的新手还是经验丰富的开发者,希望通过这篇文章,你能够深入掌握 maven-clean-plugin 的使用,并在实际项目中得心应手地应用它。


文章目录

      • 1、maven-clean-plugin 插件介绍
      • 2、Maven 配置项解释
        • 2.1、`project.build.directory`
        • 2.2、`project.build.outputDirectory`
        • 2.3、`project.build.testOutputDirectory`
        • 2.4、`project.reporting.outputDirectory`
        • 2.5、在 `pom.xml` 中的配置示例
      • 3、配置 `` 元素
      • 4、其他可选插件元素
        • 4.1、配置 `` 元素
        • 4.2、配置 `` 元素
        • 4.3、配置 `` 元素
        • 4.4、配置 `` 元素
        • 4.5、配置 `` 元素
        • 4.6、配置 `` 元素


1、maven-clean-plugin 插件介绍

该插件只有一个插件目标:

  • clean:clean,用于尝试清除项目工作目录中因构建而生成的文件。

默认情况下,它会发现并删除在 project.build.directoryproject.build.outputDirectoryproject.build.testOutputDirectoryproject.reporting.outputDirectory 所配置的目录。

通过配置 <filesets/> 元素也可以删除默认目录以外的文件。


2、Maven 配置项解释

2.1、project.build.directory
  • 默认值:target
  • 说明:这是 Maven 项目构建的输出目录,所有构建的输出文件(如编译的类文件、JAR 包等)都会放在这个目录中。
2.2、project.build.outputDirectory
  • 默认值:target/classes
  • 说明:这是编译主源码的输出目录,所有编译后的主类文件都会放在这个目录中。
2.3、project.build.testOutputDirectory
  • 默认值:target/test-classes
  • 说明:这是编译测试源码的输出目录,所有编译后的测试类文件都会放在这个目录中。
2.4、project.reporting.outputDirectory
  • 默认值:target/site
  • 说明:这是生成报告(如站点文档)的输出目录,所有生成的报告文件都会放在这个目录中。
2.5、在 pom.xml 中的配置示例

虽然这些配置项有默认值,但你可以在 pom.xml 文件中自定义这些目录的位置。下面是一个示例,展示了如何在 pom.xml 文件中配置这些项:

<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.example</groupId><artifactId>my-app</artifactId><version>1.0-SNAPSHOT</version><build><directory>custom-target</directory><outputDirectory>custom-target/classes</outputDirectory><testOutputDirectory>custom-target/test-classes</testOutputDirectory></build><reporting><outputDirectory>custom-target/site</outputDirectory></reporting></project>

3、配置 <filesets/> 元素

通过在 pom.xml 文件中配置 <filesets> 元素,你可以指定需要删除的额外文件和目录。每个 <fileset> 元素允许你定义一个文件集,包括目录、包含的文件模式和排除的文件模式。

下面是一个示例,展示了如何在 pom.xml 中配置 maven-clean-plugin 插件以删除默认目录之外的文件和目录:

<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.example</groupId><artifactId>my-app</artifactId><version>1.0-SNAPSHOT</version><build><plugins><plugin><!-- 指定 maven-clean-plugin 插件 --><groupId>org.apache.maven.plugins</groupId><artifactId>maven-clean-plugin</artifactId><version>3.1.0</version><configuration><!-- 配置 excludeDefaultDirectories 元素以删除时排除项目的默认输出目录, 默认 false--><excludeDefaultDirectories>false</excludeDefaultDirectories><!-- 配置 failOnError 元素以在删除时出现错误,仍继续进行构建, 默认 false--><failOnError>true</failOnError><!-- 配置 followSymLinks 元素以在删除时遵循符号链接, 默认 false--><followSymLinks>false</followSymLinks><!-- 配置 retryOnError 元素以在第一次尝试删除失败时进行再次尝试删除文件, 默认 false--><retryOnError>true</retryOnError><!-- 配置 skip 元素以禁用插件的执行, 默认 false--><skip>false</skip><!-- 配置 verbose 元素以设置插件用详细模式运行, 默认 false--><verbose>false</verbose><!-- 配置 filesets 元素以删除默认目录之外的文件和目录 --><filesets><fileset><!-- 要删除的额外目录 --><directory>extra-directory</directory><!-- 包含 extra-directory 目录中的所有文件和子目录 --><includes><include>**/*</include></includes><!-- 排除 extra-directory 目录中的所有 .txt 文件 --><excludes><exclude>**/*.txt</exclude></excludes></fileset><fileset><!-- 要删除的另一个额外目录 --><directory>another-directory</directory><!-- 仅包含 another-directory 目录中的所有 .log 文件 --><includes><include>**/*.log</include></includes></fileset></filesets></configuration></plugin></plugins></build>
</project>

其中文件集中的目录是项目中的相对路径,换句话说,

<directory>some/relative/path</directory>

相当于:

<directory>${basedir}/some/relative/path</directory>

4、其他可选插件元素

4.1、配置 <excludeDefaultDirectories/> 元素

删除时排除项目的默认输出目录。如果设置为 true(默认为 false),则仅删除通过 <filesets> 元素选择的文件和目录。

Ps:从 3.0.0 版本开始,对应的 property 名称已从 clean.excludeDefaultDirectories 变为 maven.clean.excludeDefaultDirectories

4.2、配置 <failOnError/> 元素

如果在删除时出现错误,是否仍继续进行构建。

使用场景:

  • 设置为 false:适用于你希望在清理过程中即使出现错误也不影响整个构建流程的场景。例如,你知道某些文件可能会被其他进程锁定而无法删除,但这并不影响后续的构建步骤;
  • 设置为 true:适用于你希望严格控制构建过程,确保所有步骤都无错误完成的场景。例如,清理步骤对于构建的准确性至关重要,任何错误都可能导致后续步骤失败。
4.3、配置 <followSymLinks/> 元素

从项目默认输出目录中删除文件时是否应遵循符号链接。默认为 false。不遵循符号链接需要更多 IO 操作和堆内存,而不管符号链接是否实际存在。因此,如果项目的输出目录很大,并且故意不包含符号链接,则可以通过将此参数设置为 true 来提高性能。从 3.0.0 版本开始,该属性已从clean.followSymLinks 重命名为 maven.clean.followSymLinks

符号链接(Symbolic Link),也称为软链接(Soft Link),是一种特殊的文件类型,它包含指向另一个文件或目录的路径。符号链接本身并不包含数据,而是一个指针,指向目标文件或目录的位置(类似于 Windows 中的快捷方式)。

Ps:从 3.0.0 版本开始,该属性已从clean.followSymLinks 重命名为 maven.clean.followSymLinks

4.4、配置 <retryOnError/> 元素

指示如果第一次尝试删除失败,则是否应进行再次尝试(在短暂延迟后)删除文件。这是为了帮助删除由第三方工具(如病毒扫描程序或搜索索引)临时锁定的文件。

4.5、配置 <skip/> 元素

禁用插件的执行。

Ps:从 3.0.0 版本开始,对应的 property 已从 clean.skip 重命名为 maven.clean.skip

4.6、配置 <verbose/> 元素

设置插件是否以详细模式运行。从 2.3 版本开始,默认值来自 Maven 的全局 debug 标志(命令行开关 mvn clean -X)。

详细模式是一种调试模式,它使插件在执行过程中输出更多的详细信息。这些信息可以帮助开发人员了解构建过程中的每一步,特别是在排查问题时非常有用。详细模式通常包括以下内容:

  • 详细的操作步骤:包括每个文件的处理、删除等操作;
  • 详细的插件配置:展示插件的配置参数及其值;
  • 详细的日志信息:记录插件执行过程中生成的所有日志。

Ps:从 3.0.0 版本开始,该 property 已从 clean.verbose 重命名为 maven.clean.verbose

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/28031.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

java课设

项目简介:射击生存类小游戏 项目采用技术: 游戏引擎: Unity编程语言: Java图形处理: NVIDIA PhysX (物理引擎), HDRP (High Definition Render Pipeline)音效与音乐: FMOD, Wwise版本控制: Git 功能需求分析: 角色控制&#xff1a;玩家能够使用键盘和鼠标控制角色移动、瞄准…

前端面试题——React篇

文章目录 前言1.useEffect是异步还是同步为何是异步如何拿到最新的数据 2.微任务和宏任务概念优点 3.事件循环&#xff08;Event Loop&#xff09;概念执行机制 4.React性能优化手段 前言 准备了一些高频面试题&#xff0c;有需要的小伙伴可以收藏&#xff0c;需要的时候看看&…

基于RandLA-Net深度学习模型的激光点云语义分割

一、场景要素语义分割部分的文献阅读笔记 RandLA-Net是一种高效、轻量级的神经网络&#xff0c;其可直接逐点推理大规模点云的语义标签。RandLA-Net基于随机点采样获得了显著的计算和内存效率&#xff0c;并采用新的局部特征聚合模块有效地保留了几何细节&#xff0c;弥补了随机…

SpringBoot之自动装配原理DataSourceAutoConfiguration注解剖析

自动装配候选类满足候选bean流程如下&#xff1a; 解析Conditional & Conditional 引申出的相关注解【ConditionalOnClass、ConditionalOnMissingBean】判断当前自动装配类是否需要跳过skip作为候选bean的流程。候选类存在Component注解则加载其全部的内部类&#xff0c;当…

React@16.x(30)useImperativeHandle

目录 1&#xff0c;介绍2&#xff0c;使用 1&#xff0c;介绍 在介绍 ref 时提到&#xff0c;ref 不能作用于函数组件&#xff0c;所以有了 ref 转发。 举例&#xff1a; function Child(props, ref) {return <h1 ref{ref}>child</h1>; }const ChildWrap React…

最新下载:Folx【软件附加安装教程】

​Folx Pro是一款适合Mac的专业下载工具也是一款BT下载器&#xff0c;Folx中文版有一个支持Retina显示的现代界面&#xff0c;提供独特的系统排序、存储下载内容与预览下载文件&#xff0c;Folx中文官网提供Folx教程、激活码、下载。 Folx友好兼容浏览器&#xff1a;如果你在网…

Linux Ubuntu 24.04 C语言gcc编译过程详解

下面是Hello World程序源代码文件hello.c的内容&#xff0c;我们将以它为例来说明源文件到可执行文件的形成过程&#xff0c;主要分4步&#xff1a;预处理、汇编、机器码、链接。 #include <stdio.h> int main () {printf ( "hello, world \n " );return 0; }…

浅谈网络通信(3)

文章目录 一、TCP[!]1.1、TCP协议报文格式1.2、TCP十大机制1.2.1、确认应答机制1.2.2、超时重传机制1.2.3、连接管理机制1.2.3.1、三次握手[其流程至关重要&#xff0c;面试必考]1.2.3.2.1、那为啥要建立连接&#xff1f;&#xff1f;建立连接的意义是啥&#xff1f;&#xff1…

Jetson Linux 上安装ZMQ

1. 安装ZMQ 框架 apt-get install libzmq3-dev 2. 或者自己build ZMQ https://github.com/zeromq/libzmq.git 参考官网教程 3. 安装CPPZMQ CPPZMQ 是ZMQ 的友好的C封装&#xff0c;只需要一个zmq.hpp 头文件即可 git clone https://github.com/zeromq/cppzmq.git cd cppz…

Ubuntu安装部署

Ubuntu安装部署 一、Ubuntu概述1、Ubuntu介绍2、Ubuntu特点 二、Ubuntu和Centos的区别1、Centos2、Ubuntu3、Centos和Ubuntu区别 三、安装Ubuntu-Server1、Ubuntu官网2、创建新的机子3、创建名称以及虚拟机在磁盘上的位置4、Ubuntu初始化和安装 四、安装Ubuntu1、开始安装2、安…

SAP RFC 输入一张表(C# 使用 SapNwRfc 二)

SapNwRfc中的配置参数&#xff0c;记录日志关闭 Trace0&#xff0c;可以得到很好的性能。 有网友在问&#xff0c;SAP RFC返回多张表&#xff08;C# 使用 SapNwRfc 一&#xff09;中如何输入一张表的数据&#xff0c;正好博主也遇到了这个场景&#xff0c;今天做了一个DEMO&…

python显示神经网络训练时的1batch数据

python显示神经网络训练时的1batch数据 在Python中显示神经网络训练时的1个batch数据可以通过以下几个步骤实现&#xff1a; 加载数据集&#xff1a;首先加载你的训练数据集&#xff0c;通常是使用PyTorch的DataLoader。 迭代数据集&#xff1a;获取DataLoader的一个迭代器&a…

4D毫米波雷达技术及发展

文章目录 前言一、4D毫米波雷达是什么&#xff1f;二、毫米波雷达是什么&#xff1f;毫米波雷达的基本原理多普勒效应 三、4D毫米波雷达的基本结构3D毫米波4D毫米波对比 前言 现阶段自动驾驶技术中&#xff0c;主要用到的传感器有摄像头、激光雷达和毫米波雷达。 摄像头的光谱…

系统架构师考点--计算机硬件

大家好。今天我总结一下计算机硬件的一些考点。 一、中央处理单元&#xff08;CPU&#xff09; 我们知道&#xff0c;计算机的基本硬件系统由运算器、控制器、存储器、输入设备和输出设备5大部件组成。其中运算器、控制器等部件被集成在一起统称为中央处理单元(Central Proce…

jdk17详细安装步骤

本文以Windows系统&#xff0c;JDK17版本作为示例&#xff0c;其他版本的操作步骤类似。 一、下载 进入官网后往下翻&#xff0c;找到JAVA17&#xff0c;然后点击Windows 点击下载。 二、安装 安装 JDK的安装是无脑安装&#xff0c;就是一路下一步下一步。。直到完成。默认安…

编译安装qemu-devel @FreeBSD

缘起 使用cbsd创建riscv jail的时候提示&#xff1a; you have no qemu-user, please install qemu-devle with BSD_USER and STATIC ops (emulators/qemu-devel) 使用pkg安装之后&#xff0c;创建的riscv jail启动报错&#xff1a; Starting jail: fbriscv, parallel timeo…

【OpenHarmony4.1 之 U-Boot 2024.07源码深度解析】006 - Makefile 编译脚本 逐行深度解析

【OpenHarmony4.1 之 U-Boot 2024.07源码深度解析】005 - u-boot 二进制文件分析 系列文章汇总:《【OpenHarmony4.1 之 U-Boot 源码深度解析】000 - 文章链接汇总》 本文链接:《【OpenHarmony4.1 之 U-Boot 2024.07源码深度解析】006 - Makefile 编译脚本 逐行深度解析》 本文…

Spring 循环依赖详解

Spring 循环依赖详解 1. 引言 在Spring框架中&#xff0c;依赖注入&#xff08;Dependency Injection, DI&#xff09;是其核心功能之一&#xff0c;它通过配置来管理对象的创建和它们之间的依赖关系。然而&#xff0c;在复杂的应用程序中&#xff0c;开发人员有时会遇到循环…

婚前隐瞒重大疾病,如何起诉

2022年5月&#xff0c;原告李先生经人介绍结识了王女士&#xff0c;因工作原因李先生长期在外地务工&#xff0c;平时交往过程中王女士行为表现也与常人无异。同年10月&#xff0c;二人登记结婚。婚后为了准备生育&#xff0c;王女士停止服药&#xff0c;结果在行为、表达、与人…