spring boot多數據源配置(mysql，redis，mongodb)實戰

使用Spring Boot Starter提升效率

雖然不同的starter實現起來各有差異，但是他們基本上都會使用到兩個相同的內容：ConfigurationProperties和AutoConfiguration。因為Spring Boot堅信“約定大於配置”這一理念，

所以我們使用ConfigurationProperties來保存我們的配置，並且這些配置都可以有一個默認值，即在我們沒有主動覆寫原始配置的情況下，默認值就會生效，這在很多情況下是非常有用的。

除此之外，starter的ConfigurationProperties還使得所有的配置屬性被聚集到一個文件中（一般在resources目錄下的application.properties），這樣我們就告別了Spring項目中XML地獄。

關於數據源的start主要有以下幾種：

spring-boot-starter-jdbc：通過jdbc連接數據庫

spring-boot-starter-data-redis：通過Spring Data Redis 、Jedis client使用Redis鍵值存儲數據庫。

spring-boot-starter-data-mongodb：使用 MongoDB 文件存儲數據庫、Spring Data MongoDB，Spring Data是一個用於簡化數據庫訪問，並支持雲服務的開源框架。

1. 背景：

Spring Boot auto-configuration嘗試根據添加的jar依賴項目自動配置Spring應用程序。

例如，如果HSQLDB在您的類路徑上，且您沒有手動配置任何數據庫連接bean，那么Spring Boot將自動配置一個HSQLDB內存數據庫模板bean。

如果需要自定義配置的話，可以通過將@EnableAutoConfiguration或@SpringBootApplication注釋添加到您的@Configuration類之一來選擇自動配置。

在實際項目中，一個工程配置多個數據源很常見，工程可能會根據業務或者模塊訪問不同的數據源；

2.解決方式

  2.1 @EnableAutoConfiguration配置類全局方式

  在啟動類上增加@EnableAutoConfiguration注解，並使用exclue屬性

@SpringBootApplication
@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class}) public class Application { public static void main(String[] args) { SpringApplication.run(PayPalApplication.class, args); } }

 2.2 EnableAutoConfiguration配置類局部方式

     使用@EnableAutoConfiguration(exclude={。。。。。})，示例如下：

import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;

@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

2.3配置文件application.yml

　　使用spring.autoconfigure.exclude屬性 ，示例如下：

spring:
 
  autoconfigure:
 
    exclude: org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration

 

 

3.多種數據源的實現（mysql,redis,mongodb）

  3.1 mysql多數據源

　　3.1.1 啟動類修改

@SpringBootApplication
@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

 　　3.1.2 application.properties 新增配置

#Database
database1.datasource.url=jdbc:mysql://localhost/testdb
database1.datasource.username=root
database1.datasource.password=root
database1.datasource.driver-class-name=com.mysql.jdbc.Driver

database2.datasource.url=jdbc:mysql://localhost/testdb2
database2.datasource.username=root
database2.datasource.password=root
database2.datasource.driver-class-name=com.mysql.jdbc.Driver

    3.1.3 增加數據庫配置類

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

import javax.sql.DataSource;

@Configuration
public class DataSourceConfiguration {

    @Bean(name = "datasource1")
    @ConfigurationProperties("database1.datasource")
    @Primary
    public DataSource dataSource(){
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "datasource2")
    @ConfigurationProperties("database2.datasource")
    public DataSource dataSource2(){
        return DataSourceBuilder.create().build();
    }

    @Bean(name="tm1")
    @Autowired
    @Primary
    DataSourceTransactionManager tm1(@Qualifier ("datasource1") DataSource datasource) {
        DataSourceTransactionManager txm  = new DataSourceTransactionManager(datasource);
        return txm;
    }

    @Bean(name="tm2")
    @Autowired
    DataSourceTransactionManager tm2(@Qualifier ("datasource2") DataSource datasource) {
        DataSourceTransactionManager txm  = new DataSourceTransactionManager(datasource);
        return txm;
    }
}

  3.2 redis多數據源

     spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration

　　或者org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration
　　並且設置: spring.data.redis.repositories.enabled=false

  3.3 mongo多數據源

    3.3.1 配置文件修改 application.yml

spring:
  autoconfigure:
    exclude: org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration

　　3.3.2 配置多個mongodb的屬性文件類MultipleMongoProperties

import org.springframework.boot.autoconfigure.mongo.MongoProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import lombok.Data;
@Data
@ConfigurationProperties(prefix = "mongodb")
public class MultipleMongoProperties {
    private MongoProperties primary = new MongoProperties();
    private MongoProperties secondary = new MongoProperties();
}

   3.3.3 增加多個mongo數據源application.yml

mongodb:
  primary:
    host: localhost
    port: 27017
    database: first
  secondary:
    host: localhost
    port: 27017
    database: second

3.3.4 添加配置類

import com.mongodb.MongoClient;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.mongo.MongoProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.SimpleMongoDbFactory;
import lombok.RequiredArgsConstructor;
@Configuration
@RequiredArgsConstructor
@EnableConfigurationProperties(MultipleMongoProperties.class)
public class MultipleMongoConfig {
    private final MultipleMongoProperties mongoProperties;
    @Primary
    @Bean(name = "primaryMongoTemplate")
    public MongoTemplate primaryMongoTemplate() throws Exception {
        return new MongoTemplate(primaryFactory(this.mongoProperties.getPrimary()));
    }
    @Bean(name = "secondaryMongoTemplate")
    public MongoTemplate secondaryMongoTemplate() throws Exception {
        return new MongoTemplate(secondaryFactory(this.mongoProperties.getSecondary()));
    }
    @Bean
    @Primary public MongoDbFactory primaryFactory(final MongoProperties mongo) throws Exception {
        return new SimpleMongoDbFactory(new MongoClient(mongo.getHost(), mongo.getPort()),
                mongo.getDatabase());
    }
    @Bean
    public MongoDbFactory secondaryFactory(final MongoProperties mongo) throws Exception {
        return new SimpleMongoDbFactory(new MongoClient(mongo.getHost(), mongo.getPort()),
                mongo.getDatabase());
    }
}

注意：在多數據源的時候，使用@Primary注解用於指定其中一個作為主數據源，即如果數據庫操作沒有指明使用哪個數據源的時候，默認使用主數據源，這個時候我們就使用到了@primary這個注解。

參考資料：

【1】https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-auto-configuration.html

【2】https://www.cnblogs.com/davidwang456/articles/10410652.html

【3】https://stackoverflow.com/questions/36387265/disable-all-database-related-auto-configuration-in-spring-boot

【4】http://roufid.com/spring-boot-multiple-databases-configuration/

【5】https://www.surasint.com/spring-boot-with-multiple-databases-example/

【6】https://stackoverflow.com/questions/45970684/disable-redis-autoconfig-in-spring-boot-when-testing

【7】https://segmentfault.com/p/1210000011564985/read