Spring Boot文档阅读笔记-DataSource configuration

「爱情、让人受尽委屈。」 2022-10-23 11:11 109阅读 0赞

DataSource：一个工厂可以连接任意厂家的数据库。通常使用URL以及一些认证去建立数据库连接。

DataSource在代码中是一个对象，这个对象贯彻并落实了javax.sql.DataSource接口中注册JNDI服务，并且这个对象能发现并使用JNDI的名称。

DataSource可以用来获取：

a. 标志Connection对象；

b. 使用了连接池的connection;

c. 使用了事务及连接池的connection；

下面是DataSource的配置

SpringBoot中可以通过两种方式配置DataSource，一种是在Java代码中，一种是在properties文件中。DataSourceAutoConfiguration检测classpath下的DataSource.class或EmbeddedDatabaseType.class需要配置DataSource的bean。

maven中需要的配置：

以H2 db为例：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
     
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <version>2.4.1</version> 
        <scope>runtime</scope> 
    </dependency>

application.properties中的配置

在application.properties可以直接配置DataSource，配置相关属性为spring.datasource.\*。

这种配置方式不需要在程序中敲代码。

下面给出关于H2，MySQL，Oracle，SQL server相关的配置。

提示：driver-class-name不是必须的，SpringBoot会通过databases的url进行推算，得出其driver-class-name

# H2
    spring.datasource.url=jdbc:h2:file:C:/temp/test
    spring.datasource.username=sa
    spring.datasource.password=
    spring.datasource.driverClassName=org.h2.Driver
    spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
     
    # MySQL
    #spring.datasource.url=jdbc:mysql://localhost:3306/test
    #spring.datasource.username=dbuser
    #spring.datasource.password=dbpass
    #spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.jpa.database-platform=org.hibernate.dialect.MySQL5InnoDBDialect
     
    # Oracle
    #spring.datasource.url=jdbc:oracle:thin:@localhost:1521:orcl
    #spring.datasource.username=dbuser
    #spring.datasource.password=dbpass
    #spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
    #spring.jpa.database-platform=org.hibernate.dialect.Oracle10gDialect
     
    # SQL Server
    #spring.datasource.url=jdbc:sqlserver://localhost;databaseName=springbootdb
    #spring.datasource.username=dbuser
    #spring.datasource.password=dbpass
    #spring.datasource.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
    #spring.jpa.hibernate.dialect=org.hibernate.dialect.SQLServer2012Dialect

DataSource Bean

推荐使用DataSourceBuilder用于建立DataSource。代码如下：

@Configuration
    public class JpaConfig {
          
        @Bean
        public DataSource getDataSource() 
        {
            DataSourceBuilder dataSourceBuilder = DataSourceBuilder.create();
            dataSourceBuilder.driverClassName("org.h2.Driver");
            dataSourceBuilder.url("jdbc:h2:file:C:/temp/test");
            dataSourceBuilder.username("sa");
            dataSourceBuilder.password("");
            return dataSourceBuilder.build();
        }
    }

JNDI DataSource

如果将SpringBoot部署成应用服务，可以通过使用应用服务的内置特性配置和管理数据源，并使用JNDI访问数据源。

如下：

#JBoss defined datasource using JNDI
     
    spring.datasource.jndi-name = java:jboss/datasources/testDB

Connection pooling

在配置文件中通过调整特定的前缀进行配置spring.datasource.hikari.\*或spring.datasource.tomcat.\*或spring.datasource.dbcp2.\*

如下配置：

spring.datasource.dbcp2.initial-size = 50
    spring.datasource.dbcp2.max-idle = 50
    spring.datasource.dbcp2.default-query-timeout = 10000
    spring.datasource.dbcp2.default-auto-commit = true
     
    ...

SpringBoot配置Multiple DataSources

配置多个数据源，需要配置多个bean，其中一个要带上@Primary。这里要注意，如果自己配置数据源，那么自动配置将会停止。代码如下：

@Configuration
    public class JpaConfig {
          
        @Bean(name = "h2DataSource")
        public DataSource h2DataSource() 
        {
            DataSourceBuilder dataSourceBuilder = DataSourceBuilder.create();
            dataSourceBuilder.driverClassName("org.h2.Driver");
            dataSourceBuilder.url("jdbc:h2:file:C:/temp/test");
            dataSourceBuilder.username("sa");
            dataSourceBuilder.password("");
            return dataSourceBuilder.build();
        }
     
        @Bean(name = "mySqlDataSource")
        @Primary
        public DataSource mySqlDataSource() 
        {
            DataSourceBuilder dataSourceBuilder = DataSourceBuilder.create();
            dataSourceBuilder.url("jdbc:mysql://localhost/testdb");
            dataSourceBuilder.username("dbuser");
            dataSourceBuilder.password("dbpass");
            return dataSourceBuilder.build();
        }
    }

使用的时候带上@Qualifier

@Autowired
    @Qualifier("h2DataSource") 
    DataSource dataSource;