c语言编程笔录

首页 >   > 笔记大全

笔记大全

Maven怎么修改打包文件名称

更新时间：2023-10-17
前言： 在使用Maven进行项目构建时，默认生成的打包文件名称是项目模块名加上版本号，如：project-1.0.0.jar。然而，在某些情况下，我们可能需要修改默认的打包文件名称，例如根据项目类型、目的等进行区分，以方便版本管理和发布。下面将介绍几种常见的修改打包文件名称的方法。 第一段：使用Maven插件修改打包文件名称 Maven提供了maven-assembly-plugin和maven-shade-plugin两个插件，可以用来修改打包文件名称。这两个插件在项目的pom.xml文件中配置，在构建过程中会根据配置生成新的打包文件。具体配置如下：

Maven Assembly Plugin：

1. 在pom.xml文件的build标签内添加以下插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.3.0</version>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>com.example.MainClass</mainClass>
                    </manifest>
                </archive>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
                <finalName>custom-name</finalName>
            </configuration>
            <executions>
                <execution>
                    <id>make-assembly</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 在上述配置中，我们通过finalName标签指定了新的打包文件名称，这里将文件名设置为custom-name。在执行mvn package命令后，新的打包文件将会生成。

Maven Shade Plugin：

1. 在pom.xml文件的build标签内添加以下插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.2.2</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <finalName>custom-name</finalName>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 在上述配置中，我们同样通过finalName标签指定了新的打包文件名称，这里将文件名设置为custom-name。在执行mvn package命令后，新的打包文件将会生成。

第二段：使用maven-assembly-plugin进行高级修改 maven-assembly-plugin除了可以修改打包文件名称，还可以进一步修改打包文件的目录结构和内容。下面将介绍如何通过maven-assembly-plugin进行高级修改。

1. 在pom.xml文件的build标签内添加以下插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.3.0</version>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>project</descriptorRef>
                </descriptorRefs>
                <appendAssemblyId>false</appendAssemblyId>
                <finalName>custom-name</finalName>
                <outputDirectory>target/custom-dir</outputDirectory>
                <archive>
                    <manifest>
                        <mainClass>com.example.MainClass</mainClass>
                    </manifest>
                </archive>
            </configuration>
            <executions>
                <execution>
                    <id>make-assembly</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 在上述配置中，我们可以对打包文件进行更多的自定义设置：

- appendAssemblyId：默认为true，为false时打包文件不再添加assemblyId。

- finalName：设置新的打包文件名称。

- outputDirectory：设置打包文件的输出目录。

第三段：通过Maven属性修改打包文件名称 另一种修改打包文件名称的方法是通过Maven属性来实现。这种方式可以使得打包文件名称更加灵活，可以根据不同的环境、构建参数或者其他条件来进行动态修改。下面是一个示例：

1. 在pom.xml文件的build标签内添加以下配置：

<build>
    <finalName>${project.artifactId}-${project.version}</finalName>
    ...
</build>

2. 创建一个名为build.properties的属性文件：

在项目的根目录下创建一个名为build.properties的属性文件，用于存放属性值。

new.build.name=custom-name

3. 在pom.xml文件的build标签内添加以下插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-resources-plugin</artifactId>
            <version>3.2.0</version>
            <executions>
                <execution>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <phase>validate</phase>
                    <configuration>
                        <outputDirectory>${project.build.directory}/filtered-resources</outputDirectory>
                        <resources>
                            <resource>
                                <directory>src/main/resources</directory>
                                <filtering>true</filtering>
                            </resource>
                        </resources>
                        <filters>
                            <filter>${project.basedir}/build.properties</filter>
                        </filters>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

4. 在src/main/resources目录下的配置文件中使用占位符：

在src/main/resources目录下的配置文件中使用`${new.build.name}`来作为打包文件名称的占位符。

例如，在一个名为application.properties的配置文件中可以这样使用：

app.name=${new.build.name}
第四段：总结 通过上述介绍的方法，我们可以在Maven项目中修改打包文件名称。使用maven-assembly-plugin和maven-shade-plugin可以直接在pom.xml中配置修改的方法较为简单，而且可以进行一些基本的高级修改。而通过Maven属性的方式可以实现更灵活的打包文件名称修改，可以根据不同的环境和需求来动态设置。根据实际情况选择适合的方法来修改打包文件名称，可以提高项目的可维护性和可管理性。

图文推荐