Maven个性化打包说明

发表于 | 更新于 | 分类于 ， ， | 评论数： | 阅读次数：

以实际项目为例，介绍maven打包插件的使用，实现个性化打包。

工程目录结构

miapp项目分为两个模块

yd-miapp模块为web项目

java代码部分

其中，function目录下，存在不同中心的组件代码

静态资源部分

其中，views目录下，存在不同中心的静态资源

目前war包目录结构

目前war包中包含了全部的组件代码和静态资源，与工程目录结构类似。

独立打包

war包目录结构

比如，我们打包的是城市代码为00031400。独立打包时，只包含00031400城市的组件和静态资源。

注意，00000000和99999999是特殊的城市代码，d00000000存放的是公共资源，d99999999存放的是模板资源。

打包操作

新建配置文件

在yd-miapp/src/main/resources/filters目录下新建配置文件，配置文件命名规则是product-centerid.xml，比如product-00031400.xml、product-00055500.xml

编写配置项

配置文件中的配置项请参考sample-db2、sample-mysql、sample-oracle

执行以下maven打包命令

进入miapp目录下，执行以下maven命令。其中centerid是中心编码，比如00031400、00055500

1
2
mvn clean package -Dp=centerid
mvn clean package -Dp=00031400

原理

maven提供了一个打包插件，maven-war-plugin，负责收集Web应用程序的所有的依赖，类和资源，并将它们打包到war包中。

打包插件提供了一系列参数，通过配置这些参数，可以个性化输出的war包。

我们使用了以下参数来进行独立打包。

属性 类型 支持版本 描述
<warSourceExcludes> String - 在编译周期完成后，向target目录复制文件时忽略的目录列表，用逗号分隔。使用表达式％regex []，可以使用正则表达式语法。
<packagingExcludes> String 2.1-alpha-2 最终构建war包之前，从target目录抽取war包文件时忽略的目录列表，用逗号分隔。使用表达式％regex []，可以使用正则表达式语法。

我们在独立打包时，想要忽略的就是除当前城市以外的组件和资源文件，而且需要保留d00000000和d99999999目录。因此，使用如下表达式过滤资源。

1
2
3
%regex[WEB-INF/classes/function/d(?!(?:${p}|00000000|99999999).+$).+],
%regex[WEB-INF/views/assets/plugins/d(?!(?:${p}|00000000|99999999).+$).+],
%regex[WEB-INF/views/d(?!(?:${p}|00000000|99999999).+$).+]

首先，在pom.xml中配置了maven-war-plugin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <configuration>
        <webResources>
            <resource>
                <directory>src/main/webapp</directory>
                <includes>
                    <include>WEB-INF/web.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </webResources>
        <warSourceExcludes>${packagingExcludes}</warSourceExcludes>
        <packagingExcludes>${packagingExcludes}</packagingExcludes>
    </configuration>
</plugin>

然后在pom.xml中配置了一个生产环境使用的公共profile。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<profile>
    <id>product</id>
    <build>
        <filters>
            <filter>${basedir}/src/main/resources/filters/product-${p}.properties</filter>
        </filters>
    </build>
    <properties>
        <packagingExcludes>
            %regex[WEB-INF/classes/function/d(?!(?:${p}|00000000|99999999).+$).+],
            %regex[WEB-INF/views/assets/plugins/d(?!(?:${p}|00000000|99999999).+$).+],
            %regex[WEB-INF/views/d(?!(?:${p}|00000000|99999999).+$).+]
        </packagingExcludes>
    </properties>
    <activation>
        <property>
            <name>p</name>
            <value></value>
        </property>
    </activation>
</profile>

公共profile激活条件是，执行maven命令时，传入参数p（maven命令传参数的方式是：-D参数名=参数值，比如：-Dp=00031400）
公共profile激活后，会使用product-centerid.properties进行参数初始化，根据资源过滤表达式进行打包，最终实现独立打包。

多中心打包

war包目录结构

我们可能还需要单独打包某几个中心的源码，比如建设云平台应用。

比如，我们想要打包的是中心为00031400、00055500。多中心打包时，只包含00031400、00055500城市的组件和静态资源。

注意，00000000和99999999是特殊的城市代码，d00000000存放的是公共资源，d99999999存放的是模板资源

打包操作

新建配置文件

在yd-miapp/src/main/resources/filters目录下新建配置文件，配置文件命名规则是product-centerid.xml。这里的centerid不再代表中心编码，仅起唯一标识的作用，可以任意命名，需保证易读性。比如product-yun.xml、product-jlcloud.xml

编写配置项

配置文件中的配置项请参考sample-db2、sample-mysql、sample-oracle

配置多个中心码

在配置文件product-centerid.xml中，新建一个配置项centerids

1
2
#centerids=centerid1|centerid2|...
centerids=00031400|00055500

执行以下maven打包命令

进入miapp目录下，执行以下maven命令。其中centerid是唯一标识，比如yun、jlcloud，与第1步中创建的配置文件后缀保持一致

1
2
3
mvn clean package -Dp=centerid
mvn clean package -Dp=yun
mvn clean package -Dp=jlcloud

原理

我们依然使用了maven的打包插件。除打包插件外，还使用了属性插件，properties-maven-plugin，用于在maven项目生命周期的各个阶段进行资源过滤。

我们使用了read-project-properties来进行多中心打包。read-project-properties是属性插件提供的一个goal（可以理解为任务），可以读取属性文件，并将属性存储为项目属性，可作为在pom.xml中硬编码属性值的替代方法。尤其适合我们的需求，即在构建时，才指定属性占位符的来源。

我们在多中心打包时，想要忽略的就是除指定城市以外的组件和资源文件，而且需要保留d00000000和d99999999目录。因此，使用如下表达式过滤资源。

1
2
3
%regex[WEB-INF/classes/function/d(?!(?:${p}|${centerids}|00000000|99999999).+$).+],
%regex[WEB-INF/views/assets/plugins/d(?!(?:${p}|${centerids}|00000000|99999999).+$).+],
%regex[WEB-INF/views/d(?!(?:${p}|${centerids}|00000000|99999999).+$).+]

表达式中的${centerids}是占位符，在打包时属性插件将使用filter文件中定义的centerids属性值，替换占位符。如果filter文件中没有定义centerids属性，那么将使用parent.properties中的属性值，替换占位符。

基于上文提到的独立打包配置，只需要在pom.xml中配置properties-maven-plugin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>properties-maven-plugin</artifactId>
    <version>1.0-alpha-2</version>
    <executions>
        <execution>
            <phase>initialize</phase>
            <goals>
                <goal>read-project-properties</goal>
            </goals>
            <configuration>
                <files>
                    <file>${basedir}/src/main/resources/filters/parent.properties</file>
                    <file>${basedir}/src/main/resources/filters/product-${p}.properties</file>
                </files>
                <quiet>true</quiet>
            </configuration>
        </execution>
    </executions>
</plugin>

0%