Maven打包及其相关插件和高级特性

- 日理万妓 2023-10-09 23:07 143阅读 0赞

![format_png][]

在Java项目开发中，Maven是非常重要的构建工具之一，它可以帮助我们管理项目的依赖、构建和发布。本文将通过以下两个方面来介绍Maven打包相关的内容：

1.  Maven打包相关的相关插件
2.  Maven构建的高级特性

### 1. Maven打包相关插件 ###

#### 1.1 maven-jar-plugin ####

maven-jar-plugin是用于将Java项目编译、打包生成JAR文件的插件，它是Maven构建生命周期中的一个默认插件。在项目的pom.xml文件中，你可以配置该插件的相关参数，例如：

<build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-jar-plugin</artifactId>
          <version>3.2.0</version>
          <configuration>
            <finalName>${project.artifactId}-${project.version}</finalName>
          </configuration>
        </plugin>
      </plugins>
    </build>
    复制代码

#### 1.2 maven-shade-plugin ####

maven-shade-plugin可以将项目的所有依赖和资源文件打包成一个“胖”JAR文件，这种JAR文件包含了项目运行所需的所有组件，方便于部署和运行。在pom.xml文件中，你可以配置该插件的相关参数，例如：

<build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.2.4</version>
          <executions>
            <execution>
              <phase>package</phase>
              <goals>
                <goal>shade</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </build>
    复制代码

可能大家对这个不是很了解，这个jar包很有意思，一般我们多用于打包SDK给别人用时，可以用这个打包。他可以干什么事情呢？

1.  解决依赖项冲突

当您的项目中有多个依赖项，其中一些依赖项可能存在版本冲突，这时Maven Shade Plugin可以帮助您解决这些冲突。为此，您需要将插件配置添加到您的pom.xml文件中，并使用relocations元素来重定向依赖项。例如：

<build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.2.1</version>
          <configuration>
            <createDependencyReducedPom>false</createDependencyReducedPom>
            <relocations>
              <relocation>
                <pattern>org.slf4j</pattern>
                <shadedPattern>com.example.shaded.slf4j</shadedPattern>
              </relocation>
            </relocations>
          </configuration>
          <executions>
            <execution>
              <phase>package</phase>
              <goals>
                <goal>shade</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </build>
    复制代码

在上面的配置中，我们使用relocations元素将所有来自org.slf4j包的依赖项重定向（替换）到com.example.shaded.slf4j包中。

1.  排除无用的类和资源

Maven Shade Plugin还可以排除无用的类和资源，以减少打包后的文件大小。为此，您需要使用artifactSet元素来指定要排除的依赖项，使用filters元素来指定要排除的类和资源。例如：

<build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.2.1</version>
          <configuration>
            <createDependencyReducedPom>false</createDependencyReducedPom>
            <artifactSet>
              <excludes>
                <exclude>org.apache.logging.log4j:log4j-core</exclude>
              </excludes>
            </artifactSet>
            <filters>
              <filter>
                <artifact>*:*</artifact>
                <excludes>
                  <exclude>**/*.class</exclude>
                  <exclude>**/*.properties</exclude>
                </excludes>
              </filter>
            </filters>
          </configuration>
          <executions>
            <execution>
              <phase>package</phase>
              <goals>
                <goal>shade</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </build>
    复制代码

在上面的配置中，我们使用artifactSet元素将org.apache.logging.log4j:log4j-core依赖项排除在打包范围之外，并使用filters元素将所有.class和.properties文件排除在打包范围之外。

#### 1.3 spring-boot-maven-plugin ####

spring-boot-maven-plugin是Spring Boot项目专用的构建插件，它可以将项目打包成一个可执行的JAR文件，内置了一个嵌入式的Servlet容器，方便于开发、测试和部署。在pom.xml文件中，你可以配置该插件的相关参数，例如：

<build>
      <plugins>
        <plugin>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-maven-plugin</artifactId>
          <version>2.5.5</version>
          <executions>
            <execution>
              <goals>
                <goal>repackage</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </build>
    复制代码

### 2. Maven构建的高级特性 ###

#### 2.1 使用profiles ####

Maven的profiles功能允许我们根据不同的环境（如开发、测试、生产等）定制不同的构建配置。在项目的pom.xml文件中，你可以定义多个profiles，例如：

<profiles>
      <profile>
        <id>dev</id>
        <activation>
          <activeByDefault>true</activeByDefault>
        </activation>
        
      </profile>
      <profile>
        <id>prod</id>
        
      </profile>
    </profiles>
    复制代码

在构建时，你可以通过-P参数激活指定的profile，例如：mvn clean package -Pprod。

#### 2.2 profiles的传递性 ####

Maven的profiles具有传递性，当一个项目依赖于另一个项目时，可以将profiles从依赖的项目传递到当前项目。为了实现这一功能，需要在依赖项目的pom.xml文件中定义profiles，并在当前项目的pom.xml文件中引用这些profiles，例如：

<profiles>
      <profile>
        <id>shared</id>
        <properties>
          <shared.property>value</shared.property>
        </properties>
      </profile>
    </profiles>
    
    
    <profiles>
      <profile>
        <id>dev</id>
        <activation>
          <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
          <shared.property>${shared.property}</shared.property>
        </properties>
      </profile>
      <profile>
        <id>prod</id>
        <properties>
          <shared.property>${shared.property}</shared.property>
        </properties>
      </profile>
    </profiles>
    复制代码

#### 2.3 打包时过滤文件 ####

在项目构建过程中，我们可以通过Maven的资源过滤功能对资源文件进行处理。例如，根据不同的环境替换配置文件中的变量。在项目的pom.xml文件中，可以配置资源过滤规则：

<build>
      <resources>
        <resource>
          <directory>src/main/resources</directory>
          <filtering>true</filtering>
        </resource>
      </resources>
      <filters>
        <filter>src/main/filters/${env}.properties</filter>
      </filters>
    </build>
    复制代码

在上述配置中，$\{env\}.properties文件包含了不同环境下的变量定义。在构建时，使用-Denv=xxx参数指定环境，如：mvn clean package -Denv=prod。

### 结论 ###

Maven是一个功能强大的Java项目构建工具。通过使用不同的Maven插件，可以轻松地将项目打包成JAR文件，无论是普通的JAR还是包含所有依赖的“胖”JAR。此外，Maven还提供了高级特性，如profiles和资源过滤，以便根据不同的环境定制构建配置。

在实际项目中，我们可以根据需要选择适当的插件和配置，以实现高效的项目管理和构建。希望本文能为你在使用Maven打包时提供一些有益的参考。

希望大家能够喜欢我的文章，以上内容就到这里，感谢各位看官老爷们的观看，如果觉得写得好，给个赞支持一下哈！！！

[format_png]: https://img-blog.csdnimg.cn/img_convert/c1db63e23163a737b8e4ebfb9c742f39.webp?x-oss-process=image/format,png