Maven 不同環(huán)境靈活構(gòu)建的步驟

更新時間：2024年10月27日 09:30:12 作者：知楠行易

在項目開發(fā)過程中,合理地使用Maven管理不同的構(gòu)建環(huán)境（開發(fā)、測試、生產(chǎn)）是提高項目管理效率和應對復雜項目需求的關(guān)鍵,本文就來介紹一下Maven 不同環(huán)境靈活構(gòu)建的步驟,感興趣的可以了解一下

一、項目分層

一般的初創(chuàng)項目不會有特別多的配置文件，所以使用 spring.profiles.active就可以滿足需求，但伴隨項目規(guī)模擴大，引入的依賴/中間件越多，配置文件越多，僅僅靠單一的文件無法滿足，可以參考下面的結(jié)構(gòu)：

├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── github
│   │   └── resources
│   │       ├── resources-env
│   │       │   ├── dev
│   │       │   └── prod
│   │       └── static

1. 使用 Maven 配置不同環(huán)境

在 Maven 中，<profiles> 是一個非常強大的功能，它允許你根據(jù)不同的構(gòu)建環(huán)境（如開發(fā)、測試、生產(chǎn)）來定義不同的配置。在 pom.xml 文件中使用 <profiles>，可以對插件、依賴、屬性等進行差異化配置，進而實現(xiàn)靈活的構(gòu)建管理。

1.1 配置不同的環(huán)境

pom.xml配置如下：

<profiles>
  <!-- 本地開發(fā) -->
  <profile>
    <id>dev</id>
    <properties>
      <env>dev</env>
    </properties>
    <activation>
      <activeByDefault>true</activeByDefault> <!-- 默認使用 dev -->
    </activation>
  </profile>
  <!-- 測試 -->
  <profile>
    <id>test</id>
    <properties>
      <env>test</env>
    </properties>
  </profile>
  <!-- 預發(fā) -->
  <profile>
    <id>pre</id>
    <properties>
      <env>pre</env>
    </properties>
  </profile>
  <!-- 生產(chǎn) -->
  <profile>
    <id>prod</id>
    <properties>
      <env>prod</env>
    </properties>
  </profile>
</profiles>

1.2 配置構(gòu)建信息

pom.xml文件如下：

 <build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
        </resource>
        <resource>
            <directory>src/main/resources/resources-env/${env}</directory>
            <filtering>true</filtering> <!-- 啟用資源過濾 -->
        </resource>
    </resources>

   
    <plugins>
      <!--     spring 配置文件可以使用占位符讀取pom.xml中的變量 例如 @env@       -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-resources-plugin</artifactId>
            <version>3.2.0</version>
            <configuration>
                <delimiters>
                    <delimiter>@</delimiter>
                </delimiters>
                <useDefaultDelimiters>false</useDefaultDelimiters>
            </configuration>
        </plugin>
    </plugins>

 </build>

1.3 Spring 配置文件激活不同環(huán)境的配置文件

application.properties 文件配置如下：

spring.profiles.active=@env@

1.4 構(gòu)建項目

命令參考：

mvn clean package -Pprod

二、可能遇到的問題

2.1 IDEA直接啟動項目，讀取不到環(huán)境配置文件

項目環(huán)境變量設置有問題。

解決方法：
IDEA 操作 File -> Project Structure -> Modules 設置 Resources 就可以了

在這里插入圖片描述

2.2 啟動項目，報錯：IOException: DerInputStream.getLength()

錯誤原因是因為 <filtering>true</filtering> 會進行文件過濾，非純文本文件（例如.p12二進制文件）需要進一步配置。

參考：http://chabaoo.cn/program/3294793jy.htm

2.3 Maven 打包缺少環(huán)境配置文件

Spring 項目配置文件位置：

默認 src/main/resources 目錄下的文件
config 子目錄下的配置文件

打包時需要進一步處理。

參考：進一步的，打包時時可以進一步優(yōu)化，即開發(fā)環(huán)境，構(gòu)建時只將測試資源文件打包到應用中，進一步提升項目的安全性。

 <!--    打包時將 將不同環(huán)境的配置文件復制到jar包中        -->
 <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-resources-plugin</artifactId>
     <version>3.2.0</version>
     <executions>
         <execution>
             <id>copy-resources</id>
             <phase>process-resources</phase>
             <goals>
                 <goal>copy-resources</goal>
             </goals>
             <configuration>
                 <outputDirectory>${project.build.outputDirectory}</outputDirectory>
                 <resources>
                     <resource>
                         <directory>src/main/resources/resources-env/${env}</directory>
                         <filtering>false</filtering>
                     </resource>
                 </resources>
             </configuration>
         </execution>
     </executions>
 </plugin>

<plugin>
   <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
       	<!-- 環(huán)境隔離 排除不需要的文件-->
        <excludes>
            <exclude>resources-env/**</exclude>
        </excludes>
    </configuration>
</plugin>