Maven父子POM结合shade插件实现子项目配置标准化咨询

第一步：调整父POM配置 #

核心改动点： #

• 父项目打包类型必须改为pom（原配置为jar不符合多模块父项目规范）
• 新增可被子项目重写的自定义属性，实现动态配置
• 调整maven-shade-plugin配置，将硬编码内容替换为属性占位符

修改后的父POM完整示例：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>myParentgroupId</groupId>
        <artifactId>myParentArtifactId1</artifactId>
        <version>myParentVersion</version>
    </parent>

    <artifactId>myParentArtifactId2</artifactId>
    <!-- 父项目必须为pom打包类型 -->
    <packaging>pom</packaging>
    <name>${project.artifactId}</name>
    
    <!-- 声明子模块（新增子项目时在此处添加即可） -->
    <modules>
        <module>child1</module>
        <module>child2</module>
    </modules>

    <!-- 可继承的通用配置属性，子项目可重写 -->
    <properties>
        <!-- 子项目启动类，默认空，子项目必须重写该属性 -->
        <project.main.class></project.main.class>
        <!-- Manifest中版本字段的名称，子项目可自定义，默认统一为Application-Version -->
        <app.version.entry.name>Application-Version</app.version.entry.name>
        <!-- 统一源码路径，子项目路径一致的话无需单独配置 -->
        <common.source.dir>../../webapp/src/main/java</common.source.dir>
        <common.resource.dir>../../webapp/src/main/resources</common.resource.dir>
    </properties>

    <dependencies>
        ... 公共依赖 ...
    </dependencies>

    <build>
        <!-- 通用源码配置，子项目自动继承 -->
        <sourceDirectory>${common.source.dir}</sourceDirectory>
        <resources>
            <resource>
                <directory>${common.resource.dir}</directory>
            </resource>
        </resources>
        
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-shade-plugin</artifactId>
                    <version>3.4.1</version> <!-- 统一指定插件版本 -->
                    <executions>
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>shade</goal>
                            </goals>
                            <configuration>
                                <finalName>${project.artifactId}</finalName>
                                <transformers>
                                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                        <manifestEntries>
                                            <!-- 动态填充启动类和版本字段 -->
                                            <Main-Class>${project.main.class}</Main-Class>
                                            <${app.version.entry.name}>${project.version}</${app.version.entry.name}>
                                        </manifestEntries>
                                    </transformer>
                                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                        <resource>META-INF/spring.handlers</resource>
                                    </transformer>
                                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                        <resource>META-INF/spring.schemas</resource>
                                    </transformer>
                                </transformers>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </pluginManagement>
        <!-- 父项目声明启用插件，子项目自动继承执行逻辑 -->
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

第二步：简化子项目POM配置 #

子项目无需再重复写打包、插件、源码路径等公共配置，仅需声明父依赖、自身坐标和自定义属性即可，示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>myParentgroupId</groupId>
        <artifactId>myParentArtifactId2</artifactId>
        <version>myParentVersion</version>
    </parent>

    <artifactId>myChildArtifactId</artifactId>
    <name>${project.artifactId}</name>

    <!-- 仅需配置子项目个性化属性 -->
    <properties>
        <!-- 子项目自身启动类 -->
        <project.main.class>MyChildLauncherCLass</project.main.class>
        <!-- 如需自定义版本字段名则重写该属性，不需要则省略 -->
        <app.version.entry.name>Child1Version</app.version.entry.name>
    </properties>

</project>

配置说明 #

• 所有子项目的版本自动继承父项目版本，无需单独声明，统一版本规范
• 新增子项目时仅需复制子POM模板，修改artifactId和project.main.class属性即可，无需重复编写打包配置
• 若子项目源码路径与通用路径不一致，仅需在子项目properties中重写common.source.dir和common.resource.dir属性即可

内容的提问来源于stack exchange，提问作者lulu3131