Maven Clean Plugin 使用教程

Maven Clean Plugin 使用教程

maven-clean-pluginApache Maven Clean Plugin项目地址:https://gitcode.com/gh_mirrors/ma/maven-clean-plugin

1. 项目的目录结构及介绍

Maven Clean Plugin 是一个用于清理 Maven 项目构建过程中生成的文件的插件。以下是该项目的目录结构及其介绍：

maven-clean-plugin/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── org/
│   │   │       └── apache/
│   │   │           └── maven/
│   │   │               └── plugins/
│   │   │                   └── clean/
│   │   │                       ├── CleanMojo.java
│   │   │                       └── ...
│   │   └── resources/
│   │       └── META-INF/
│   │           └── plexus/
│   │               └── components.xml
│   └── test/
│       ├── java/
│       │   └── org/
│       │       └── apache/
│       │           └── maven/
│       │               └── plugins/
│       │                   └── clean/
│       │                       ├── CleanMojoTest.java
│       │                       └── ...
│       └── resources/
│           └── ...
├── pom.xml
└── README.md

• src/main/java/：包含插件的主要 Java 源代码。
• src/main/resources/：包含插件的配置文件和资源文件。
• src/test/java/：包含插件的测试代码。
• src/test/resources/：包含测试资源文件。
• pom.xml：Maven 项目的配置文件。
• README.md：项目的介绍和使用说明。

2. 项目的启动文件介绍

Maven Clean Plugin 的主要启动文件是 CleanMojo.java，位于 src/main/java/org/apache/maven/plugins/clean/CleanMojo.java。这个文件定义了插件的主要行为，包括如何清理项目目录。

package org.apache.maven.plugins.clean;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

@Mojo(name = "clean")
public class CleanMojo extends AbstractMojo {
    @Parameter(defaultValue = "${project.build.directory}", required = true)
    private File directory;

    public void execute() throws MojoExecutionException, MojoFailureException {
        // 清理逻辑
    }
}

• @Mojo(name = "clean")：定义了插件的目标名称为 clean。
• @Parameter：定义了插件的参数，例如 directory，默认值为 ${project.build.directory}。
• execute()：插件的主要执行方法，包含清理逻辑。

3. 项目的配置文件介绍

Maven Clean Plugin 的配置文件主要是 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>org.apache.maven.plugins</groupId>
    <artifactId>maven-clean-plugin</artifactId>
    <version>3.0.0</version>
    <packaging>maven-plugin</packaging>

    <dependencies>
        <!-- 依赖列表 -->
    </dependencies>

    <build>
        <plugins>
            <!-- 插件配置 -->
        </plugins>
    </build>
</project>

• <modelVersion>：定义了 POM 的版本。
• <groupId>、<artifactId>、<version>：定义了插件的坐标。
• <packaging>：定义了打包类型为 maven-plugin。
• <dependencies>：定义了插件的依赖。

maven-clean-pluginApache Maven Clean Plugin项目地址:https://gitcode.com/gh_mirrors/ma/maven-clean-plugin