Spring入門實戰(zhàn)之Profile詳解
前言
Spring中的Profile功能其實早在Spring 3.1的版本就已經(jīng)出來,它可以理解為我們在Spring容器中所定義的Bean的邏輯組名稱,只有當這些Profile被激活的時候,才會將Profile中所對應(yīng)的Bean注冊到Spring容器中。
看到Profile這個關(guān)鍵字,或許你從來沒有正眼瞧過他,又或者腦海中有些模糊的印象,比如除了這里Springmvc中的Profile,maven中也有Profile的標簽。
從字面意思來看,Profile表示側(cè)面,那什么情況下才會用到側(cè)面這個功能呢,而側(cè)面具體又有什么含義呢
打一個比方,對于數(shù)據(jù)庫的配置問題,在開發(fā)的眼中可以使用嵌入的數(shù)據(jù)庫,并且加載測試數(shù)據(jù)(后面會給出代碼示例)。但是在測試的眼中,可能會配一個數(shù)據(jù)庫連接池類似這樣
@Bean(destroyMethod="close") public DataSource dataSource () { BasicDataSource dataSource = new BasicDataSource(); dataSource.setUrl("jdbc:h2:tcp://dbserver/~/test"); dataSource.setDriverClassName("org.h2.Driver"); dataSource.setUsername("sa"); dataSource.setPassword("password"); dataSource.setInitialSize(20); dataSource.setMaxActive(30); return dataSource; }
當然還有產(chǎn)品環(huán)境下的配置等等。對于這種百花齊放的配置方式你還能說什么,默默的為這一套套的環(huán)境都部署相應(yīng)的配置文件啊,沒有profile這套我們一直都是這么做。
但是現(xiàn)在有了Profile,我們就多了一種選擇,一種更加智能省心的配置方式。通過Profile配置,Spring可以在根據(jù)環(huán)境在運行階段來決定bean的創(chuàng)建與否,先舉例如下,主要從Profile bean的配置和激活來展開。
Profile bean的配置
通過注解@Profile配置
對于上面比方中的第一種情況,在開發(fā)環(huán)境中我們配置一個數(shù)據(jù)源可能是這樣的
@Bean(destroyMethod = "shutdown") public DataSource embeddedDataSource() { return new EmbeddedDatabaseBuilder() .addScript("classpath:schema.sql") .addScript("classpath:test-data.sql") .build(); }
這里會使用EmbeddedDatabaseBuilder創(chuàng)建一個嵌入式數(shù)據(jù)庫,模式定義在類文件下的schema.sql文件中
schema.sql
create table Things ( id identity, name varchar(100) );
這里定義了一張Things表包含了兩個字段
除了模式文件,還需要通過test-data.sql加載測試數(shù)據(jù)
test-data.sql
insert into Things (name) values ('A')
對于這個@Bean完全不知道是放在開發(fā)的環(huán)境下創(chuàng)建還是產(chǎn)品的環(huán)境下。所以我們這里可以使用注解@Profile幫助我們?yōu)檫@個bean打上標識。
從Spring 3.1版本中就引入了bean profile的功能,可以讓你將不同的bean定義到一個或者多個profile里,然后在部署應(yīng)用時告知要激活那個profile,則相應(yīng)的bean就會被創(chuàng)建。
比如這里
@Configuration @Profile("dev") public class DevelopmentProfileConfig { @Bean(destroyMethod = "shutdown") public DataSource embeddedDataSource() { return new EmbeddedDatabaseBuilder() .setType(EmbeddedDatabaseType.H2) .addScript("classpath:schema.sql") .addScript("classpath:test-data.sql") .build(); } }
通過@Profile("dev")
為EmbedderDataSource bean標記為dev環(huán)境下要創(chuàng)建的bean。
注意:1. @Profile被加載類級別上,如果dev profile沒有被激活,那么類中對應(yīng)的所有bean就不會被創(chuàng)建
2. 如果當前是dev環(huán)境被激活了,那么對于沒有使用@Profile的bean都會被創(chuàng)建,被標記為其他的profile如prod,則不會創(chuàng)建相應(yīng)的bean
3. 從3.2開始@Profile不僅僅可以加載類級別上,還可以加載方法上,具體代碼如下
package com.myapp; import javax.sql.DataSource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType; import org.springframework.jndi.JndiObjectFactoryBean; @Configuration public class DataSourceConfig { @Bean(destroyMethod = "shutdown") @Profile("dev") public DataSource embeddedDataSource() { return new EmbeddedDatabaseBuilder() .setType(EmbeddedDatabaseType.H2) .addScript("classpath:schema.sql") .addScript("classpath:test-data.sql") .build(); } @Bean @Profile("prod") public DataSource jndiDataSource() { JndiObjectFactoryBean jndiObjectFactoryBean = new JndiObjectFactoryBean(); jndiObjectFactoryBean.setJndiName("jdbc/myDS"); jndiObjectFactoryBean.setResourceRef(true); jndiObjectFactoryBean.setProxyInterface(javax.sql.DataSource.class); return (DataSource) jndiObjectFactoryBean.getObject(); } }
通過xml配置文件配置
除了簡單的注解方式,我們哈可以通過在xml配置文件中聲明的方式,具體配置如下
datasource-config.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:jee="http://www.springframework.org/schema/jee" xmlns:p="http://www.springframework.org/schema/p" xsi:schemaLocation=" http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee.xsd http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <beans profile="dev"> <jdbc:embedded-database type="H2"> <jdbc:script location="classpath:schema.sql" /> <jdbc:script location="classpath:test-data.sql" /> </jdbc:embedded-database> </beans> <beans profile="prod"> <jee:jndi-lookup lazy-init="true" jndi-name="jdbc/myDatabase" resource-ref="true" proxy-interface="javax.sql.DataSource" /> </beans> </beans>
這里分別聲明了兩種環(huán)境以及對應(yīng)的profile。
profile激活
雖然我們已經(jīng)配置好了profile,但是如何激活相應(yīng)的環(huán)境呢。這里我們需要兩個屬性spring.profile.active
以及spring.profile.default
。
如果spring.profile.active
被賦值了,則spring.profile.default
就不會起作用,如果spring.profie.active
沒有賦值,則使用默認的spring.profile.default
設(shè)置的值。當然,如果兩者都沒有設(shè)置的話,則只會創(chuàng)建那些定義在相應(yīng)的profile中的bean。
設(shè)置這兩個屬性的方式有很多:
作為DispactcherServlet的初始化參數(shù)
作為Web應(yīng)用上下文參數(shù)
作為JNDI條目
作為環(huán)境變量
作為JVM的系統(tǒng)屬性
在集成測試類上,使用@ActiveProfiles注解設(shè)置
比如我們在web.xml中可以聲明代碼如下
<?xml version="1.0" encoding="UTF-8"?> <web -app version="2.5" ...> //為上下文設(shè)置默認的profile <context-param> <param-name>spring.profile.default</param-name> <param-value>dev</param-value> </context-param> ... <servlet> ... //為Serlvet設(shè)置默認的profile <init-param> <param-name>spring-profiles.default</param-name> <param-value>dev</param-value> </init-prama> ... <web-app>
這樣就可以指定需要啟動那種環(huán)境,并準備相應(yīng)的bean。
另外對于測試,spring為什么提供了一個簡單的注解可以使用@ActiveProfiles,它可以指定運行測試的時候應(yīng)該要激活那個profile。比如這里的測試類DevDataSourceTest
package profiles; import static org.junit.Assert.*; import java.sql.ResultSet; import java.sql.SQLException; import java.util.List; import javax.sql.DataSource; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.jdbc.core.RowMapper; import org.springframework.test.context.ActiveProfiles; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; import com.myapp.DataSourceConfig; public class DataSourceConfigTest { @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(classes=DataSourceConfig.class) @ActiveProfiles("dev") public static class DevDataSourceTest { @Autowired private DataSource dataSource; @Test public void shouldBeEmbeddedDatasource() { assertNotNull(dataSource); JdbcTemplate jdbc = new JdbcTemplate(dataSource); List<String> results = jdbc.query("select id, name from Things", new RowMapper<String>() { @Override public String mapRow(ResultSet rs, int rowNum) throws SQLException { return rs.getLong("id") + ":" + rs.getString("name"); } }); assertEquals(1, results.size()); assertEquals("1:A", results.get(0)); } } @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(classes=DataSourceConfig.class) @ActiveProfiles("prod") public static class ProductionDataSourceTest { @Autowired private DataSource dataSource; @Test public void shouldBeEmbeddedDatasource() { // should be null, because there isn't a datasource configured in JNDI assertNull(dataSource); } } @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration("classpath:datasource-config.xml") @ActiveProfiles("dev") public static class DevDataSourceTest_XMLConfig { @Autowired private DataSource dataSource; @Test public void shouldBeEmbeddedDatasource() { assertNotNull(dataSource); JdbcTemplate jdbc = new JdbcTemplate(dataSource); List<String> results = jdbc.query("select id, name from Things", new RowMapper<String>() { @Override public String mapRow(ResultSet rs, int rowNum) throws SQLException { return rs.getLong("id") + ":" + rs.getString("name"); } }); assertEquals(1, results.size()); assertEquals("1:A", results.get(0)); } } @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration("classpath:datasource-config.xml") @ActiveProfiles("prod") public static class ProductionDataSourceTest_XMLConfig { @Autowired(required=false) private DataSource dataSource; @Test public void shouldBeEmbeddedDatasource() { // should be null, because there isn't a datasource configured in JNDI assertNull(dataSource); } } }
運行shouldBeEmbeddedDatasource方法,測試通過
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作能帶來一定的幫助,如果有疑問大家可以留言交流。
相關(guān)文章
spring cloud gateway轉(zhuǎn)發(fā)服務(wù)報錯的解決
這篇文章主要介紹了spring cloud gateway轉(zhuǎn)發(fā)服務(wù)報錯的解決,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09關(guān)于解決雪花算法生成的ID傳輸前端后精度丟失問題
這篇文章主要介紹了關(guān)于解決雪花算法生成的ID傳輸前端后精度丟失問題,雪花算法生成的ID傳輸?shù)角岸藭r,會出現(xiàn)后三位精度丟失,本文提供了解決思路,需要的朋友可以參考下2023-03-03Java調(diào)用opencv實現(xiàn)圖片矯正功能
這篇文章主要為大家詳細介紹了Java如何調(diào)用opencv實現(xiàn)圖片矯正功能,文中的示例代碼簡潔易懂,感興趣的小伙伴可以跟隨小編一起學習一下2023-09-09