为SpringBoot应用创建自定义classpath.idx控制Jar加载顺序

一、把classpath.idx放到BOOT-INF目录的具体方法 #

Spring Boot的fat jar结构里，classpath.idx需要放在BOOT-INF/根目录下，默认放src/main/resources会被打包到BOOT-INF/classes，可以通过Maven资源插件配置文件复制规则解决：

1. 在项目根目录创建src/main/boot-inf目录，将自定义classpath.idx放入该目录。
2. 在pom.xml中添加maven-resources-plugin配置，指定打包阶段将文件复制到fat jar的BOOT-INF目录：

<build>
    <plugins>
        <!-- 配置资源插件复制classpath.idx到BOOT-INF -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-resources-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-boot-inf-resources</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.directory}/${project.build.finalName}/BOOT-INF</outputDirectory>
                        <resources>
                            <resource>
                                <directory>src/main/boot-inf</directory>
                                <includes>
                                    <include>classpath.idx</include>
                                </includes>
                            </resource>
                        </resources>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- 保留原有Spring Boot Maven插件配置 -->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

打包后classpath.idx就会出现在fat jar的BOOT-INF/目录下，Spring Boot启动时会优先读取该文件指定的类路径顺序。

二、为什么调整pom依赖顺序没用 #

Spring Boot的fat jar生成类路径时，不会遵循pom.xml里的依赖顺序，而是默认按依赖的groupId、artifactId、version字典序排列，所以手动调整pom中的依赖位置无法改变fat jar中依赖的加载顺序，这也是你之前尝试无效的原因。

三、其他可选解决方案 #

如果自定义classpath.idx的方式不够灵活，还可以尝试以下方法：

• 排除冲突类：通过spring-boot-maven-plugin的<excludes>配置，直接排除问题jar中的冲突类。比如问题jar是legacy-artifact，冲突类是com.example.conflict.ClassA：

  <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
      <configuration>
          <excludes>
              <exclude>
                  <groupId>com.legacy.group</groupId>
                  <artifactId>legacy-artifact</artifactId>
                  <classes>
                      <class>com.example.conflict.ClassA</class>
                      <!-- 可添加同包其他冲突类 -->
                  </classes>
              </exclude>
          </excludes>
      </configuration>
  </plugin>
  

• 排除不必要的传递依赖：执行mvn dependency:tree命令分析依赖树，若问题jar是某个依赖的传递依赖，可在对应依赖中添加<exclusions>排除它，只保留需要的依赖。
• 自定义类路径布局（Spring Boot 2.4+）：使用spring-boot-maven-plugin的<classpathLayoutType>配置自定义类路径排序规则，但这种方式不如classpath.idx直接针对特定依赖调整。

内容的提问来源于stack exchange，提问作者David M. Karr