Springboot怎么使用maven打包指定mainClass

在使用Spring Boot进行项目开发时，通常我们会使用Maven作为项目的构建工具。Maven不仅可以帮助我们管理项目的依赖，还可以通过配置来打包项目。在某些情况下，我们可能需要指定一个特定的mainClass来作为项目的启动类。本文将详细介绍如何在Spring Boot项目中使用Maven打包并指定mainClass。

1. 为什么需要指定mainClass？

在Spring Boot项目中，通常我们会有一个主类（mainClass），这个类包含public static void main(String[] args)方法，作为应用程序的入口。Spring Boot默认会扫描项目中的@SpringBootApplication注解的类，并将其作为启动类。

然而，在某些情况下，我们可能会有多个包含main方法的类，或者我们希望在不同的环境中使用不同的启动类。这时，我们就需要显式地指定mainClass，以确保Maven在打包时使用正确的启动类。

2. 使用Maven打包Spring Boot项目

在Spring Boot项目中，Maven通常使用spring-boot-maven-plugin插件来打包项目。这个插件可以将项目打包成一个可执行的JAR文件，其中包含了所有的依赖项和资源文件。

2.1 默认打包方式

默认情况下，Spring Boot项目使用spring-boot-maven-plugin插件进行打包，并且会自动识别带有@SpringBootApplication注解的类作为启动类。以下是一个典型的pom.xml配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

在这种情况下，Maven会自动找到带有@SpringBootApplication注解的类，并将其作为启动类。

2.2 指定mainClass

如果我们需要指定一个特定的mainClass，可以通过在spring-boot-maven-plugin插件中配置mainClass属性来实现。以下是一个示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <mainClass>com.example.MyApplication</mainClass>
            </configuration>
        </plugin>
    </plugins>
</build>

在这个配置中，我们指定了com.example.MyApplication作为启动类。Maven在打包时会使用这个类作为应用程序的入口。

2.3 使用Maven Profiles指定不同的mainClass

在某些情况下，我们可能需要在不同的环境中使用不同的启动类。例如，在开发环境和生产环境中，我们可能需要使用不同的配置或启动类。这时，我们可以使用Maven的profiles功能来实现。

以下是一个使用Maven Profiles指定不同mainClass的示例：

<profiles>
    <profile>
        <id>dev</id>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <mainClass>com.example.DevApplication</mainClass>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </profile>
    <profile>
        <id>prod</id>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <mainClass>com.example.ProdApplication</mainClass>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>

在这个配置中，我们定义了两个Profile：dev和prod。在dev Profile中，我们指定了com.example.DevApplication作为启动类；在prod Profile中，我们指定了com.example.ProdApplication作为启动类。

在打包时，我们可以通过指定Profile来选择使用哪个启动类。例如，使用以下命令打包开发环境的应用程序：

mvn clean package -Pdev

或者使用以下命令打包生产环境的应用程序：

mvn clean package -Pprod

3. 使用Maven Assembly Plugin打包

除了使用spring-boot-maven-plugin插件外，我们还可以使用Maven的maven-assembly-plugin插件来打包项目。这个插件可以将项目打包成一个包含所有依赖项的JAR文件，并且可以指定mainClass。

3.1 配置maven-assembly-plugin

以下是一个使用maven-assembly-plugin插件打包并指定mainClass的示例配置：

<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.MyApplication</mainClass>
                    </manifest>
                </archive>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
            <executions>
                <execution>
                    <id>make-assembly</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在这个配置中，我们指定了com.example.MyApplication作为启动类，并且使用jar-with-dependencies描述符来打包项目。打包后的JAR文件将包含所有的依赖项。

3.2 打包命令

使用maven-assembly-plugin插件打包项目时，可以使用以下命令：

mvn clean package

打包完成后，会在target目录下生成一个包含所有依赖项的JAR文件，文件名通常为<artifactId>-<version>-jar-with-dependencies.jar。

4. 使用Maven Shade Plugin打包

maven-shade-plugin是另一个常用的Maven插件，用于打包项目并指定mainClass。与maven-assembly-plugin类似，maven-shade-plugin也可以将项目打包成一个包含所有依赖项的JAR文件。

4.1 配置maven-shade-plugin

以下是一个使用maven-shade-plugin插件打包并指定mainClass的示例配置：

<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>
                    <configuration>
                        <transformers>
                            <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                <mainClass>com.example.MyApplication</mainClass>
                            </transformer>
                        </transformers>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在这个配置中，我们指定了com.example.MyApplication作为启动类，并且使用shade目标来打包项目。打包后的JAR文件将包含所有的依赖项。

4.2 打包命令

使用maven-shade-plugin插件打包项目时，可以使用以下命令：

mvn clean package

打包完成后，会在target目录下生成一个包含所有依赖项的JAR文件，文件名通常为<artifactId>-<version>-shaded.jar。

5. 总结

在Spring Boot项目中使用Maven打包并指定mainClass是一个常见的需求。通过配置spring-boot-maven-plugin、maven-assembly-plugin或maven-shade-plugin插件，我们可以轻松地实现这一目标。

• 使用spring-boot-maven-plugin插件时，可以通过<mainClass>属性指定启动类。
• 使用maven-assembly-plugin插件时，可以通过<mainClass>元素指定启动类。
• 使用maven-shade-plugin插件时，可以通过<mainClass>元素指定启动类。

此外，我们还可以使用Maven的profiles功能来在不同的环境中使用不同的启动类。通过合理配置Maven插件，我们可以灵活地控制项目的打包过程，确保在不同的场景下使用正确的启动类。