由于項目需要，最近研究了一下基于spring Boot與Spring Data JPA的多數據源配置問題。以下是傳統的單數據源配置代碼。這里使用的是Spring的Annotation在代碼內部直接配置的方式，沒有使用任何XML文件。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
@Configuration@EnableJpaRepositories(basePackages = "org.lyndon.repository") @EnableTransactionManagement@PropertySource("classpath:application.properties") public class JpaConfig { private static final String DATABASE_DRIVER = "db.driver"; private static final String DATABASE_URL = "db.url"; private static final String DATABASE_USER = "db.user"; private static final String DATABASE_PASSWORD = "db.password"; private static final String PACKAGES_TO_SCAN = "packages.to.scan"; private static final String HIBERNATE_DIALECT = "hibernate.dialect"; private static final String HIBERNATE_SHOW_SQL = "hibernate.show.sql"; @Resource private Environment env; @Bean public DataSource dataSource() { DruidDataSource source = new DruidDataSource(); source.setDriverClassName(env.getRequiredProperty(DATABASE_DRIVER)); source.setUrl(env.getRequiredProperty(DATABASE_URL)); source.setUsername(env.getRequiredProperty(DATABASE_USER)); source.setPassword(env.getRequiredProperty(DATABASE_PASSWORD)); return source; } @Bean public LocalContainerEntityManagerFactoryBean entityManagerFactory() { LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean(); factory.setDataSource(dataSource()); factory.setPersistenceProviderClass(HibernatePersistenceProvider.class); factory.setPackagesToScan(env.getRequiredProperty(PACKAGES_TO_SCAN)); factory.setJpaProperties(hibernateProperties()); factory.afterPropertiesSet(); return factory; } @Bean public PlatformTransactionManager transactionManager() { JpaTransactionManager manager = new JpaTransactionManager(); manager.setEntityManagerFactory(entityManagerFactory().getObject()); return manager; } @Bean public HibernateExceptionTranslator hibernateExceptionTranslator() { return new HibernateExceptionTranslator(); } private Properties hibernateProperties() { Properties properties = new Properties(); properties.put(HIBERNATE_DIALECT, env.getRequiredProperty(HIBERNATE_DIALECT)); properties.put(HIBERNATE_SHOW_SQL, env.getRequiredProperty(HIBERNATE_SHOW_SQL)); return properties; } } |
但是這一配置是不能簡單地擴展到多數據源配置的，因為Spring Boot默認會為開發人員做很多工作，而這些工作與多數據源的配置相沖突，因此需要修改原來的配置內容。網上有很多講解多數據源配置的文章，但是這些文章大多使用的是XML配置的方式，而且沒有使用Spring Boot等比較新的Spring框架技術（比如很多人使用實現AbstractRoutingDataSource這一Spring提供的抽象類的方式，還需要切面的支持，無疑是相當繁瑣的），已經不適用于在最新的工程項目中使用了，因為最新的Spring框架可以為我們完成很多事情，我們只需要去適應新的方法即可。為此，我通過研究Spring的官方文檔和不斷調試，實現了新的多數據源配置的方法，在此貼出，僅供參考。
首先，Spring的JPA是直接支持多數據源配置的，因此我們可以在配置文件或者代碼中直接配置多個數據源。由于多數據源配置可能會共享一些配置信息，因此使用繼承體系實現這種配置是最合適的。在例子中，我的ORM框架使用的是hibernate，而與Hibernate相關的配置信息我都放在了配置基類BaseJpaConfg中，代碼如下。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
@Configuration@EnableTransactionManagement@PropertySource("classpath:application.properties") public class BaseJpaConfig { private static final String HIBERNATE_DIALECT = "hibernate.dialect"; private static final String HIBERNATE_SHOW_SQL = "hibernate.show.sql"; @Resource protected Environment env; @Bean public HibernateExceptionTranslator hibernateExceptionTranslator() { return new HibernateExceptionTranslator(); } protected Properties hibernateProperties() { Properties properties = new Properties(); properties.put(HIBERNATE_DIALECT, env.getRequiredProperty(HIBERNATE_DIALECT)); properties.put(HIBERNATE_SHOW_SQL, env.getRequiredProperty(HIBERNATE_SHOW_SQL)); return properties; } } |
該類提供Hibernate相關信息。它有兩個子類，分別是SpringJpaConfig以及MysqlJpaConfig，分別配置了兩個數據源，連接到兩個不同的數據庫Schema，代碼如下。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
@Configuration@EnableJpaRepositories(basePackages = {"org.lyndon.repository1"}, entityManagerFactoryRef = "springEntityManagerFactory", transactionManagerRef = "springTransactionManager") public class SpringJpaConfig extends BaseJpaConfig { private static final String DATABASE_DRIVER = "db.driver"; private static final String DATABASE_URL = "db.url"; private static final String DATABASE_USER = "db.user"; private static final String DATABASE_PASSWORD = "db.password"; private static final String PACKAGES_TO_SCAN = "packages.to.scan"; @Bean @ConfigurationProperties(prefix = "datasource.primary") public DataSource dataSource() { DruidDataSource source = new DruidDataSource(); source.setDriverClassName(env.getRequiredProperty(DATABASE_DRIVER)); source.setUrl(env.getRequiredProperty(DATABASE_URL)); source.setUsername(env.getRequiredProperty(DATABASE_USER)); source.setPassword(env.getRequiredProperty(DATABASE_PASSWORD)); return source; } @Bean(name = "springEntityManagerFactory") public LocalContainerEntityManagerFactoryBean springEntityManagerFactory() { LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean(); factory.setDataSource(dataSource()); factory.setPersistenceProviderClass(HibernatePersistenceProvider.class); factory.setPackagesToScan(env.getRequiredProperty(PACKAGES_TO_SCAN).split(",")); factory.setJpaProperties(hibernateProperties()); factory.afterPropertiesSet(); return factory; } @Bean(name = "springTransactionManager") @Primary public PlatformTransactionManager transactionManager() { JpaTransactionManager manager = new JpaTransactionManager(); manager.setEntityManagerFactory(springEntityManagerFactory().getObject()); return manager; } } |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
@Configuration@EnableJpaRepositories(basePackages = {"org.lyndon.repository2"}, entityManagerFactoryRef = "mysqlEntityManagerFactory", transactionManagerRef = "mysqlTransactionManager") public class MysqlJpaConfig extends BaseJpaConfig { private static final String DATABASE_DRIVER = "db.driver"; private static final String DATABASE_URL = "db.url2"; private static final String DATABASE_USER = "db.user"; private static final String DATABASE_PASSWORD = "db.password"; private static final String PACKAGES_TO_SCAN = "packages.to.scan2"; @Bean @ConfigurationProperties(prefix = "datasource.secondary") public DataSource dataSource2() { DruidDataSource source = new DruidDataSource(); source.setDriverClassName(env.getRequiredProperty(DATABASE_DRIVER)); source.setUrl(env.getRequiredProperty(DATABASE_URL)); source.setUsername(env.getRequiredProperty(DATABASE_USER)); source.setPassword(env.getRequiredProperty(DATABASE_PASSWORD)); return source; } @Bean(name = "mysqlEntityManagerFactory") public LocalContainerEntityManagerFactoryBean mysqlEntityManagerFactory() { LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean(); factory.setDataSource(dataSource2()); factory.setPersistenceProviderClass(HibernatePersistenceProvider.class); factory.setPackagesToScan(env.getRequiredProperty(PACKAGES_TO_SCAN).split(",")); factory.setJpaProperties(hibernateProperties()); factory.afterPropertiesSet(); return factory; } @Bean(name = "mysqlTransactionManager") public PlatformTransactionManager transactionManager() { JpaTransactionManager manager = new JpaTransactionManager(); manager.setEntityManagerFactory(mysqlEntityManagerFactory().getObject()); return manager; } } |
兩份配置代碼使用了各自的數據源、實體管理對象以及事務管理對象。這里要注意的有兩點，首先是實體管理對象。Spring Boot框架為方便開發者，默認會尋找名為“entityManagerFactory”的Bean作為實體管理的實現，但是我們這里使用了兩個實體管理對象，名稱也并不是默認的“entityManagerFactory”，因此必須在各自的EnableJpaRepositories的Annotation中指明使用的實體管理對象。第二點，就是事務管理對象。Spring Boot會提供一個默認的事務管理對象的實現，但是我們在這里使用了兩個不同的事務管理對象，因此我們也需要在各自的EnableJpaRepositories的Annotation中指明使用的事務管理對象。除此以外，我們還必須指定其中一個事務管理對象為主要對象（使用Primary這一Annotation），讓Spring能有主次地使用相應的事務管理對象。
以上就是本文的主要內容。關于Service的配置等問題，由于和單數據源時是一樣的，因此就不再贅述了。基于上述代碼，我們就可以使用Spring Boot實現多數據源之間的無縫切換了，是不是很輕松？如果你不想使用代碼配置的方式，也可以使用XML文件代替，配置的核心屬性與上文相同，可以自己加以琢磨。希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：http://blog.csdn.net/gabriel_2/article/details/46329461
