天天看點

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

什麼是profile

想必大家都有這種經曆,我們開發項目的時候要有多個環境,如開發環境、測試環境、生産環境,他們的配置檔案一般不同,如資料庫位址。當我們要向各個環境釋出程式時,需要人工處理這些配置檔案,這顯然麻煩且易錯。有了profile,一切問題就簡單了。簡單講profile就是一組配置,不同profile提供不同組合的配置,程式運作時可以選擇使用哪些profile來适應環境。

1. application-{profile}.properties檔案

我們先來搭建一個簡單的springboot項目快速了解多profile的使用。項目結構非常簡單:

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

       除了application.properties還有多個application-{profile}.properties(格式必須為這樣),在每個配置檔案中項目啟動的端口是不一樣的。

       在application.properties使用spring.profiles.active=prod來指定生效的配置檔案為application-prod.properties.啟動項目後可以在控制台看到啟動端口為application-prod.properties裡配置的server.port=8084

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

1.1 profile的多種激活方式

第一種就是上面的在配置檔案中通過spring.profiles.active=來指定,注意可以激活多個profile,如spring.profiles.active=prod,dev,如果都存在某值,執行last win政策。

通過指令行方式。優先級高于第一種的spring.profiles.active

       執行java -jar xxx.jar,可以觀察到服務端口被設定為8082。

       執行java -jar xxx.jar –spring.profiles.active=test,可以觀察到服務端口被設定為8083,也就是(test)環境的配置

通過虛拟機參數。-Dspring.profiles.active=dev使用程式設計的方式激活。

@SpringBootApplication
public class Application {
   public static void main(String[] args) {
       ConfigurableApplicationContext applicationContext = SpringApplication.run(Application.class, args);
       applicationContext.getEnvironment().setActiveProfiles("dev");
   }
}
           

1.2 spring.profiles.include屬性

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

意思是無論執行哪個profile,都會去加載application-mq.properties裡的配置

注意:

隻會去加載application-mq.properties裡獨有的配置,如果application-mq.properties也有server.port字段 和 主配置檔案的配置項沖突或者重複  并不會生效。

       可以利用這種方式簡化配置檔案的書寫,如在application-mq.properties書寫各個環境都有的mq配置資訊,不必都夾雜在application.properties裡。

1.3 總結

  1.  application.properties檔案是必定要加載的,而且是先加載的,
  2. 無論是通過哪種方式指定的。當加載完application檔案之後才加載指定的profiles檔案
  3. 、如果application檔案和指定的profile檔案有相同的配置或沖突的配置項,則以profile中的為基準
  4. application檔案中寫通用的配置項
  5. profile檔案中寫特定環境的配置項
  6. spring.profiles.include指定公共的配置項(起到了分離的作用)

這樣可以簡化配置檔案的書寫。

2. @Profile

通過@Profile注解,我們可以根據所激活的不同的環境,生成不同的bean。

如隻在dev環境下啟動swagger2:

@Configuration

@EnableSwagger2

@Profile("dev")

public class Swagger2Config {

}

@profile官方部落格介紹

2.1 注解可以使用的位置

@component 或 @Configuration修飾的類上作為元注解修飾自定義注解

任何@Bean修飾的方法上

2.2 自定義注解

       @Profile注解需要接受一個字元串,作為場景名。這樣每個地方都需要記住這個字元串。Spring的@Profile注解支援定義在其他注解之上,以建立自定義場景注解。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Profile("dev")
public @interface Dev{
}
           

       這樣就建立了一個@Dev注解,該注解可以辨別bean使用于@Dev這個場景。後續就不再需要使用@Profile(“dev”)的方式(這樣即可以簡化代碼)。

2.3 注意

@Profile({“p1”, “!p2”})的意思為p1的profile生效或p2的profile為生效時就會去生成修飾的類

如果要使用不同環境下生成不同配置的同一個bean,方法名不要相同,即盡量不要重載。

3. 和maven的profile一起使用

    在開發過程中,我們的項目會存在不同的運作環境,比如開發環境、測試環境、生産環境,而我們的項目在不同的環境中,有的配置可能會不一樣,比如資料源配置、日志檔案配置、以及一些軟體運作過程中的基本配置,那每次我們将軟體部署到不同的環境時,都需要修改相應的配置檔案,這樣來回修改,很容易出錯,而且浪費勞動力。

       在前面的文章profile之springboot,springboot為我們提供了一種解決方案,而maven也提供了一種更加靈活的解決方案,就是profile功能。

1. 原理

1.1 先看一段pom檔案中的profile定義

<profiles>
        <profile>
            <!--不同環境Profile的唯一id-->
            <id>dev</id>
            <properties>
                <!--profiles.active是自定義的字段(名字随便起),自定義字段可以有多個-->
                <profiles.active>dev</profiles.active>
            </properties>
        </profile>
        <profile>
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profiles.active>test</profiles.active>
            </properties>
        </profile>
    </profiles>
           

     可以看到定義了多個profile,每個profile都有唯一的id,也包含properties屬性。這裡為每個profile都定義一個名為profiles.active的properties,每個環境的值不同。當我們打包項目時,激活不同的環境,profiles.active字段就會被賦予不同的值。

1.2 結合resource屬性

       這個profiles.active字段可以應用到許多地方,及其靈活。可以在配置檔案裡被引用(參考此部落格);也可以結合pom檔案裡的resource和filter屬性,作為檔案名的一部分或者檔案夾名的一部分,下面會詳細講解這個用法。

注意:maven的profile用法有許多種,但基本原理就是根據激活環境的不同,自定義字段被賦予不同的值。

2. 應用示範

2.1 項目結構

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

       這裡定義了dev,prod,test三個檔案夾,用來示範maven中profile的使用。注意,每個檔案夾裡還定義了application-{xxx}.properties件,這裡相當于結合springboot的Profile的使用,是我比較推薦的方式,和本文maven的profile使用無關系,在application.properties都有spring.profiles.active=xxx去加載對應的application-{xxx}.properties。

pom檔案裡的關鍵配置為

可以看到我們利用resource屬性來配置打包時,根據激活的環境來選取要打包的檔案夾。我們使用maven指令

mvn clean package

prod環境被預設激活,打包後的包結構為

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

可以看到prod檔案夾下的配置檔案被打包進去,通過激活不同的profile也就實作了動态切換配置檔案。

2.2 激活方式

profile的激活方式有很多種

1. 通過maven指令參數

即在使用maven打包時通過-P參數,-P後跟上profile的唯一id,如mvn clean package -Ptest

打包時test的profile被激活,打包後的包結構為:

Profile之springboot、Maven什麼是profile        2. @Profile3. 和maven的profile一起使用        

2. 通過pom檔案裡的activation屬性

<profile>
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
            <!--activation用來指定激活方式,可以根據jdk環境,環境變量,檔案的存在或缺失-->
            <activation>
                <!--配置預設激活-->
                <activeByDefault>true</activeByDefault>
                
                <!--通過jdk版本-->
                <!--當jdk環境版本為1.5時,此profile被激活-->
                <jdk>1.5</jdk>
                <!--當jdk環境版本1.5或以上時,此profile被激活-->
                <jdk>[1.5,)</jdk>

 

                <!--根據目前作業系統-->
                <os>
                    <name>Windows XP</name>
                    <family>Windows</family>
                    <arch>x86</arch>
                    <version>5.1.2600</version>
                </os>

                <!--通過系統環境變量,name-value自定義-->
                <property>
                    <name>env</name>
                    <value>test</value>
                </property>

                <!--通過檔案的存在或缺失-->
                <file>
                    <missing>target/generated-sources/axistools/wsdl2java/
                        com/companyname/group</missing>
                    <exists/>
                </file>
            </activation>
        </profile>
           

       這裡我寫了多種方式,可以通過activeByDefault、jdk版本、作業系統、系統環境變量(在win10我試了不成功,win7可以,不知道為啥)、檔案的存在或缺失,實際項目可以根據需要選取一種即可。這種的優先級低于maven指令參數指定的方式。

3. settings.xml中使用activeProfiles指定(了解即可)

即mave目錄下的settings.xml也可以添加下面的代碼來指定激活哪個profile。

<activeProfiles>  

     <activeProfile>profileTest1</activeProfile>  

</activeProfiles>  

       值得注意的是

1. setting.xml在目前系統使用者的.m2檔案夾有(如沒有可手動拷貝過去也會生效),針對的目前使用者的profile配置,在maven的安裝目錄下“conf/settings.xml”,針對的是全局的profile配置。

2.profile也可以定義在setting.xml檔案中,但是這種方式個人感覺并不實用的,不推薦。

繼續閱讀