spring @profile註解的使用

will的猜想發表於2017-10-17
Spring
本文主要介紹spring中@profile的使用方法以及在什麼情況下使用。
本文主要參考：
http://www.cnblogs.com/davidwang456/p/4429058.html

好，下面上貨。

首先說一下為什麼要使用這個@profile註解。@profile註解是spring提供的一個用來標明當前執行環境的註解。我們正常開發的過程中經常遇到的問題是，開發環境是一套環境，qa測試是一套環境，線上部署又是一套環境。這樣從開發到測試再到部署，會對程式中的配置修改多次，尤其是從qa到上線這個環節，讓qa的也不敢保證改了哪個配置之後能不能線上上執行。
為了解決上面的問題，我們一般會使用一種方法，就是配置檔案，然後通過不同的環境讀取不同的配置檔案，從而在不同的場景中跑我們的程式。
那麼，spring中的@profile註解的作用就體現在這裡。在spring使用DI來依賴注入的時候，能夠根據當前制定的執行環境來注入相應的bean。最常見的就是使用不同的DataSource了。

下面詳細的介紹一下，如何通過spring的@profile註解實現上面的功能。

首先是新建maven工程
mvn archetype:generate -DarchetypeCatalog=internal

下面是pom檔案：
[html] view plain copy
  1. <properties>  
  2.     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
  3.     <springframework.version>4.3.7.RELEASE</springframework.version>  
  4.   </properties>  
  5.   
  6.   <dependencies>  
  7.     <dependency>  
  8.       <groupId>junit</groupId>  
  9.       <artifactId>junit</artifactId>  
  10.       <version>4.12</version>  
  11.       <scope>test</scope>  
  12.     </dependency>  
  13.     <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->  
  14.     <dependency>  
  15.       <groupId>org.springframework</groupId>  
  16.       <artifactId>spring-context</artifactId>  
  17.       <version>${springframework.version}</version>  
  18.     </dependency>  
  19.     <!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->  
  20.     <dependency>  
  21.       <groupId>org.springframework</groupId>  
  22.       <artifactId>spring-test</artifactId>  
  23.       <version>${springframework.version}</version>  
  24.     </dependency>  
  25.   
  26.   </dependencies>  
  27.   <build>  
  28.     <plugins>  
  29.       <plugin>  
  30.         <groupId>org.apache.maven.plugins</groupId>  
  31.         <artifactId>maven-compiler-plugin</artifactId>  
  32.         <configuration>  
  33.           <source>1.8</source>  
  34.           <target>1.8</target>  
  35.           <encoding>utf-8</encoding>  
  36.         </configuration>  
  37.       </plugin>  
  38.       <plugin>  
  39.         <artifactId>maven-assembly-plugin</artifactId>  
  40.         <version>3.0.0</version>  
  41.         <configuration>  
  42.           <archive>  
  43.             <manifest>  
  44.               <mainClass>com.xueyou.demo</mainClass>  
  45.             </manifest>  
  46.           </archive>  
  47.           <descriptorRefs>  
  48.             <descriptorRef>jar-with-dependencies</descriptorRef>  
  49.           </descriptorRefs>  
  50.         </configuration>  
  51.         <executions>  
  52.           <execution>  
  53.             <id>make-assembly</id> <!-- this is used for inheritance merges -->  
  54.             <phase>package</phase> <!-- bind to the packaging phase -->  
  55.             <goals>  
  56.               <goal>single</goal>  
  57.             </goals>  
  58.           </execution>  
  59.         </executions>  
  60.       </plugin>  
  61.     </plugins>  
  62.   </build>  

整體看一下工程中的類和介面：


首先是Person類中有一個speak的方法，這個方法是MoveFactor這個藉口提供的。Chinese、English和German都實現了這個介面。但是這三個類的@profile中的值是不同的。通過SpringTest中分配不同的activeprofile就能夠實現呼叫不同的speak方法。

下面看程式碼：
MoveFactor.interface
[java] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3.   
  4. public interface MoveFactor {  
  5.     void speak();  
  6. }  

Person.java
[plain] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3. import org.springframework.beans.factory.annotation.Autowired;  
  4. import org.springframework.stereotype.Component;  
  5.   
  6. @Component  
  7. public class Person {  
  8.   
  9.     @Autowired  
  10.     private MoveFactor moveFactor;  
  11.   
  12.     public void speak(){  
  13.         moveFactor.speak();  
  14.     }  
  15. }  


Chinese.java
[java] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3. import org.springframework.context.annotation.Configuration;  
  4. import org.springframework.context.annotation.Profile;  
  5. import org.springframework.stereotype.Component;  
  6.   
  7.   
  8. @Configuration  
  9. @Profile(value = "dev")  
  10. @Component  
  11. public class Chinese implements MoveFactor {  
  12.     @Override  
  13.     public void speak() {  
  14.         System.out.println("我是中國人");  
  15.     }  
  16. }  

English.java
[java] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3. import org.springframework.context.annotation.Profile;  
  4. import org.springframework.stereotype.Component;  
  5.   
  6. @Component  
  7. @Profile("qa")  
  8. public class English implements MoveFactor{  
  9.     @Override  
  10.     public void speak() {  
  11.         System.out.println("i am an English");  
  12.     }  
  13. }  

German.java
[plain] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3. import org.springframework.context.annotation.Profile;  
  4. import org.springframework.stereotype.Component;  
  5.   
  6.   
  7. @Component  
  8. @Profile("prod")  
  9. public class German implements MoveFactor{  
  10.     @Override  
  11.     public void speak() {  
  12.         System.out.println("i am a German");  
  13.     }  
  14. }  

使用springtest進行測試
[plain] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3. import org.junit.Test;  
  4. import org.junit.runner.RunWith;  
  5. import org.springframework.beans.factory.annotation.Autowired;  
  6. import org.springframework.test.context.ActiveProfiles;  
  7. import org.springframework.test.context.ContextConfiguration;  
  8. import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;  
  9.   
  10.   
  11. @RunWith(SpringJUnit4ClassRunner.class)  
  12. @ContextConfiguration(classes = App.class)  
  13. @ActiveProfiles("dev")  
  14. public class SpringTest {  
  15.   
  16.     @Autowired  
  17.     Person p;  
  18.   
  19.     @Test  
  20.     public void testProfile(){  
  21.         p.speak();  
  22.     }  
  23.   
  24. }  

執行結果：


當修改@ActiveProfile中的值時，輸出的內容也會隨之改變。



如果使用的是main函式進行真正的開發、測試和上線時，我們需要設定一下執行引數：


-D 後面加上需要設定的spring的屬性，就能夠在main函式中使用了。

App.java
[java] view plain copy
  1. package com.xueyou.demo;  
  2.   
  3. import org.springframework.context.ConfigurableApplicationContext;  
  4. import org.springframework.context.annotation.AnnotationConfigApplicationContext;  
  5. import org.springframework.context.annotation.ComponentScan;  
  6. import org.springframework.context.annotation.Configuration;  
  7.   
  8. /** 
  9.  * Hello world! 
  10. // */  
  11. @Configuration  
  12. @ComponentScan(basePackages = {"com.xueyou.demo"})  
  13. public class App {  
  14.     public static void main(String[] args) {  
  15.         ConfigurableApplicationContext context = new AnnotationConfigApplicationContext(com.xueyou.demo.App.class);  
  16.         Person p = context.getBean(Person.class);  
  17.         p.speak();  
  18.     }  
  19. }  

執行結果：


如果需要得到當前的activeprofile可以通過ConfigurableApplicationContext的例項來的到。



最後提一下，如果是在web的後臺專案中如何進行設定。這個時候我們通過xml的方式進行設定：
[html] view plain copy
  1. <context-param>  
  2.   <param-name>spring.profiles.active</param-name>  
  3.   <param-value>DOUBLEUPMINT</param-value>  
  4. </context-param>  

相關文章