当前位置：首页 > news >正文

maven常用插件详解

news 来源：原创 2024/5/14 12:46:00

1. 简介

我们都知道Maven本质上是一个插件框架，它的核心并不执行任何具体的构建任务，所有这些任务都交给插件来完成，例如编译源代码是由maven- compiler-plugin完成的。进一步说，每个任务对应了一个插件目标（goal），每个插件会有一个或者多个目标，例如maven- compiler-plugin的compile目标用来编译位于src/main/java/目录下的主源码，testCompile目标用来编译位于src/test/java/目录下的测试源码。

2. 分类详解

2.1：spring-boot-maven-plugin

负责将源码和依赖、以及springboot loader相关内容打成一个包。保证打出的包能独立运行。后续有具体打包示例。

2.2：maven-jar-plugin

仅负责将源码打成jar包，不能独立运行。另外，可以根据你的设置，将依赖jar包路径和程序的主入口定义在所打jar包中的 MANIFEST.MF 文件里。这里只会对当前的主项目打出包，其主项目依赖的jar包则不管，常见配置如下；

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
        <!-- 打包时包含的文件配置，在暗黑我的这个工程中，只打包 com 文件夹 -->
        <includes>
            <include>
                **/com/**
            </include>
        </includes>
 
        <archive>
            <manifest>
                <!-- 配置加入依赖包 -->
                <addClasspath>true</addClasspath>
                <classpathPrefix>lib/</classpathPrefix>
                <useUniqueVersions>false</useUniqueVersions>
                <!-- Spring Boot 启动类(自行修改) -->
                <mainClass>com.ccccit.springdockerserver.SpringDockerServerApplication</mainClass>
            </manifest>
            <manifestEntries>
                <!-- 外部资源路径加入 manifest.mf 的 Class-Path -->
                <Class-Path>resources/</Class-Path>
            </manifestEntries>
        </archive>
        <!-- jar 输出目录 -->
        <outputDirectory>${project.build.directory}/pack/</outputDirectory>
    </configuration>
</plugin>

2.3：maven-dependency-plugin

负责将各种依赖打包。也可以根据你的设置，将所打的依赖jar包输出到指定位置。maven-dependency-plugin最大的用途是帮助分析项目依赖，dependency:list能够列出项目最终解析到的依赖列表，dependency:tree能进一步的描绘项目依赖树。maven-dependency-plugin还有很多目标帮助你操作依赖文件，例如dependency:copy-dependencies能将项目依赖从本地Maven仓库复制到某个特定的文件夹下面。

通常maven-dependency-plugin与maven-jar-plugin一块使用，可以打出当前项目包及其依赖包，但是要配置maven-dependency-plugin的输出路径，否则target无法看到依赖包。

常见配置如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>3.2.0</version>
    <!-- 复制依赖 -->
    <executions>
        <execution>
            <!-- 这里的id可以随意写，与下面的goal无名称上的必然联系 -->
            <id>copy-dependencies</id>
            <phase>package</phase>
            <goals>
                <goal>copy-dependencies</goal>
            </goals>
            <configuration>
                <!-- 依赖包 输出目录 -->
                <outputDirectory>${project.build.directory}/pack/lib</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

2.4：maven-resource-plugin

负责将正式与测试用到的资源文件导出到指定位置。还负责用资源文件中的参数替换pom文件中对应的占位符，常用配置如下：

<!-- 在打包时，动态将maven的参数传给resource文件夹下的参数 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-resources-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
        <encoding>UTF-8</encoding>
        <!-- 当这里为true，那么resource文件夹下的配置文件，比如application.yml这些文件里面的${}包起来的内容就可以被pom文件中profiles标签下的对应名称部分行替换了 -->
        <useDefaultDelimiters>true</useDefaultDelimiters>
    </configuration>
    <!-- 复制资源和bin文件夹  -->
    <executions>
        <execution>
            <id>copy-resources</id>
            <phase>package</phase>
            <goals>
                <goal>copy-resources</goal>
            </goals>
            <configuration>
                <resources>
                    <resource>
                        <!-- 文件来源 -->
                        <directory>src/main/resources</directory>
                    </resource>
                </resources>
                <!-- 资源文件的输出目录 -->
                <outputDirectory>${project.build.directory}/pack/resources</outputDirectory>
            </configuration>
        </execution>
        <execution>
            <id>copy-bin</id>
            <phase>package</phase>
            <goals>
                <goal>copy-resources</goal>
            </goals>
            <configuration>
                <resources>
                    <resource>
                        <!-- 文件来源 -->
                        <directory>src/main/bin</directory>
                    </resource>
                </resources>
                <!-- 资源文件的输出目录 -->
                <outputDirectory>${project.build.directory}/pack/bin</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

2.5：maven-assembly-plugin

负责打包。但是至少要指定需要打哪些内容，这个插件才能正常干活儿。

3. 最优实践

此处直接在start.spring.io上面配置一个spring-web项目，里面引入一个额外的jar包commons-lang来举例说明，代码如下：

package com.example.demo;

import org.apache.commons.lang3.StringUtils;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @ResponseBody
    @GetMapping("/getInfo")
    public String getInfo() {
        StringUtils.isNotBlank("```");
        return "555666";
    }

}

maven配置如下：