SpringBoot整合HikariCP數(shù)據(jù)庫(kù)連接池方式

更新時(shí)間：2024年03月05日 10:06:40 作者：喵喵@香菜

這篇文章主要介紹了SpringBoot整合HikariCP數(shù)據(jù)庫(kù)連接池方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

一、使用工具

JDK1.8
springToolSuit(STS)
maven

二、創(chuàng)建項(xiàng)目

1.首先創(chuàng)建一個(gè)SpringBoot項(xiàng)目，勾選web，mysql等具體怎樣創(chuàng)建可以參考我的上兩個(gè)博客；傳送門(mén)

2.maven 依賴(lài)如下：

1）Java 8 maven artifact:

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>2.6.1</version>
    <scope>compile</scope>
</dependency>

2）Java 7 maven artifact:

<dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP-java7</artifactId>
        <version>2.4.11</version>
        <scope>compile</scope>
   </dependency>

我的maven依賴(lài)為：

<dependencies>
		<!-- spring aop -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>
		<!-- spring data jpa -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-jpa</artifactId>
		</dependency>
		<!-- hibernate 依賴(lài) -->
		<dependency>
            <groupId>org.hibernate.javax.persistence</groupId>
            <artifactId>hibernate-jpa-2.1-api</artifactId>
            <version>1.0.0.Final</version>
        </dependency>
		<!-- JDBC連接數(shù)據(jù)庫(kù)，因?yàn)橐肏ikariCP，所以需要將SpringBoot中的tomcat-jdbc排除 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-jdbc</artifactId>
			<exclusions>
           		<exclusion>
               		<groupId>org.apache.tomcat</groupId>
               		<artifactId>tomcat-jdbc</artifactId>
           		</exclusion>
       		</exclusions>
		</dependency>
		<!-- HikariCP 連接池依賴(lài)，從父依賴(lài)獲取額版本 -->
		<dependency>
			<groupId>com.zaxxer</groupId>
			<artifactId>HikariCP</artifactId>
			<!-- <scope>runtime</scope> -->
		</dependency> 
		
		<!-- 因?yàn)榕渲昧藅hymeleaf 模板，可以將此注釋
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency> -->
		<!-- thymeleaf 模板   默認(rèn)包含spring-boot-starter-web-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-thymeleaf</artifactId>
		</dependency>
		
		<!-- 連接mysql數(shù)據(jù)庫(kù)驅(qū)動(dòng) -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
		<!-- spring boot 內(nèi)置tomcat -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
			<scope>provided</scope>
		</dependency>
		
		<!--@ConfigurationProperties注解-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
		
		<!-- net json 這個(gè)必須配置jdk的版本號(hào) -->
		<dependency>
		    <groupId>net.sf.json-lib</groupId>
		    <artifactId>json-lib</artifactId>
		    <version>2.4</version>
		    <classifier>jdk15</classifier>
		</dependency>
		<!-- https://mvnrepository.com/artifact/com.thoughtworks.xstream/xstream -->
		
		<!-- LEGACYHTML5需要搭配一個(gè)額外的庫(kù)NekoHTML才可用,解決嚴(yán)格的html驗(yàn)證問(wèn)題 -->
		<dependency>  
       		<groupId>net.sourceforge.nekohtml</groupId>  
      		<artifactId>nekohtml</artifactId>  
		</dependency>
		
		<!-- 單元測(cè)試相關(guān)依賴(lài) -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

SpringBoot父依賴(lài)如下：

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.6.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

這里需要注意的是，因?yàn)橛昧俗钚碌腟pringBoot版本，HikarICP從SpringBoot繼承版本，所以JDK需要配置為1.8，如果不是將會(huì)出現(xiàn)錯(cuò)誤，錯(cuò)誤原因?qū)?huì)在下面展示。

3.數(shù)據(jù)庫(kù)連接配置文件如下(我將數(shù)據(jù)庫(kù)連接配置單獨(dú)寫(xiě)在了一個(gè)配置文件，這樣找起來(lái)比較清晰，文件名為 datasource.properties ，后面的配置類(lèi)中要用到此名字)：

#第一個(gè)數(shù)據(jù)源（多數(shù)據(jù)源將會(huì)在后面介紹,primary表示為第一個(gè)數(shù)據(jù)源）
spring.datasource.primary.dataSourceClassName=com.mysql.jdbc.jdbc2.optional.MysqlDataSource
spring.datasource.primary.dataSourceProperties.serverName=localhost
spring.datasource.primary.dataSourceProperties.portNumber=3306
spring.datasource.primary.dataSourceProperties.databaseName=newrecruit
spring.datasource.primary.username=root
spring.datasource.primary.password=yourpassword
# 下面為連接池的補(bǔ)充設(shè)置，應(yīng)用到上面所有數(shù)據(jù)源中
#自動(dòng)提交
spring.datasource.default-auto-commit=true
#指定updates是否自動(dòng)提交
spring.datasource.auto-commit=true
spring.jpa.show-sql = true
spring.datasource.maximum-pool-size=100
spring.datasource.max-idle=10
spring.datasource.max-wait=10000
spring.datasource.min-idle=5
spring.datasource.initial-size=5
spring.datasource.validation-query=SELECT 1
spring.datasource.test-on-borrow=false
spring.datasource.test-while-idle=true
# 配置間隔多久才進(jìn)行一次檢測(cè)，檢測(cè)需要關(guān)閉的空閑連接，單位是毫秒 
spring.datasource.time-between-eviction-runs-millis=18800
# 配置一個(gè)連接在池中最小生存的時(shí)間，單位是毫秒 
spring.datasource.minEvictableIdleTimeMillis=300000

# Hibernate ddl auto (create, create-drop, update)
spring.jpa.hibernate.ddl-auto=update  
#spring.jpa.database-platform=org.hibernate.dialect.MySQL5Dialect  
spring.jpa.hibernate.naming_strategy=org.hibernate.cfg.ImprovedNamingStrategy  
#spring.jpa.database=org.hibernate.dialect.MySQL5InnoDBDialect 
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

數(shù)據(jù)庫(kù)配置文件寫(xiě)好以后，開(kāi)始寫(xiě)配置類(lèi) :

package com.zlc.config;

import javax.sql.DataSource;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.context.annotation.PropertySource;


/**
  * <p>Company: </p> 
  * @Description: 
  * @Create Date: 2017年8月13日下午11:59:49
  * @Version: V1.00 
  * @Author: 追到烏云的盡頭找太陽(yáng)
  */
@Configuration
@PropertySource("classpath:datasource.properties")
public class DataSourceConfig {
	
	private Logger logger = LoggerFactory.getLogger(DataSourceConfig.class);
	
	
	@Bean(name = "primaryDataSource")
	@Primary
    @Qualifier("primaryDataSource")
    @ConfigurationProperties(prefix="spring.datasource.primary" )
    public DataSource primaryDataSource() {
		logger.info("數(shù)據(jù)庫(kù)連接池創(chuàng)建中.......");
        return DataSourceBuilder.create().build();
    }

}

一個(gè)@PropertySource(“classpath:datasource.properties”)注解，就可以免去我們自己寫(xiě)讀取配置文件的麻煩

第一個(gè)數(shù)據(jù)源的配置類(lèi)如下：

package com.zlc.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.orm.jpa.JpaTransactionManager;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;

import javax.persistence.EntityManager;
import javax.sql.DataSource;

import java.util.Map;

/**
  * <p>Company: 信息技術(shù)研究所 </p> 
  * @Description: 第一個(gè)數(shù)據(jù)源的配置類(lèi)
  * @Create Date: 2017年5月11日下午9:22:12
  * @Version: V1.00 
  * @Author: 追到烏云的盡頭找太陽(yáng)
  */
@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
        entityManagerFactoryRef="entityManagerFactoryPrimary",
        transactionManagerRef="transactionManagerPrimary",
        basePackages= { "com.zlc.dao" }) //設(shè)置Repository所在位置
public class PrimaryDataSouceConfig {
	
	@Autowired @Qualifier("primaryDataSource")
    private DataSource primaryDataSource;

    @Primary
    @Bean(name = "entityManagerPrimary")
    public EntityManager entityManager(EntityManagerFactoryBuilder builder) {
        return entityManagerFactoryPrimary(builder).getObject().createEntityManager();
    }

    @Primary
    @Bean(name = "entityManagerFactoryPrimary")
    public LocalContainerEntityManagerFactoryBean entityManagerFactoryPrimary (EntityManagerFactoryBuilder builder) {
        return builder
                .dataSource(primaryDataSource)
                .properties(getVendorProperties(primaryDataSource))
                .packages("com.zlc.entity") //設(shè)置實(shí)體類(lèi)所在位置
                .persistenceUnit("primaryPersistenceUnit")
                .build();
    }

    @Autowired
    private JpaProperties jpaProperties;

    private Map<String, String> getVendorProperties(DataSource dataSource) {
        return jpaProperties.getHibernateProperties(dataSource);
    }

    @Primary
    @Bean(name = "transactionManagerPrimary")
    public PlatformTransactionManager transactionManagerPrimary(EntityManagerFactoryBuilder builder) {
        return new JpaTransactionManager(entityManagerFactoryPrimary(builder).getObject());
    }

}

上面有連個(gè)需要注意的地方，一個(gè)是JPA所在的包名： basePackages= { “com.b505.dao” }) //設(shè)置Repository所在位置，一定不能寫(xiě)錯(cuò)，一個(gè)JPA實(shí)體類(lèi)所在的位置： .packages(“com.b505.entity”) //設(shè)置實(shí)體類(lèi)所在位置。

我們?cè)趍ain方法中我們可以檢查一下（一定要注意SpringBoot項(xiàng)目的結(jié)構(gòu)，因?yàn)镾pringBoot是自動(dòng)掃描并注冊(cè)類(lèi)注冊(cè)到Spring的上下文中所以main所在的類(lèi)的包名一定是最大的，這樣用其他注解的類(lèi)才能正常注冊(cè)，我的項(xiàng)目結(jié)構(gòu)如下）：

如果你的controller寫(xiě)在了com.zlca.web；那么項(xiàng)目編譯不會(huì)產(chǎn)生錯(cuò)誤，但是此web層的映射全都不能用，因?yàn)闆](méi)有注冊(cè)到Spring中。

SpringBoot是掃描@SpringBootApplication下的類(lèi)以及此注解的子文件夾下的類(lèi)；

main方法如下：

package com.zlc;

import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;

import javax.sql.DataSource;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;

import com.zaxxer.hikari.HikariDataSource;

/**
 * <p>Company: 信息技術(shù)研究所 </p> 
 * @Description: 程序的入口
 * @Create Date: 2017年9月14日下午1:11:05
 * @Version: V1.00 
 * @Author: 追到烏云的盡頭找太陽(yáng)
 */
@SpringBootApplication
public class RecruitmentApp {
	
	public static void main(String[] args) {
		ApplicationContext applicationContext = SpringApplication.run(
				RecruitmentApp.class, args);
		DataSource dataSource = applicationContext.getBean(DataSource.class);
		System.out.println("datasource is :" + dataSource);
		//檢查數(shù)據(jù)庫(kù)是否是hikar數(shù)據(jù)庫(kù)連接池
		if (!(dataSource instanceof HikariDataSource)) {
			System.err.println(" Wrong datasource type :"
					+ dataSource.getClass().getCanonicalName());
			System.exit(-1);
		}
		try {
			Connection connection = dataSource.getConnection();
			ResultSet rs = connection.createStatement()
					.executeQuery("SELECT 1");
			if (rs.first()) {
				
				System.out.println("Connection OK!");
			} else {
				System.out.println("Something is wrong");
			}
			// connection.close();
			// System.exit(0);

		} catch (SQLException e) {
			System.out.println("FAILED");
			e.printStackTrace();
			System.exit(-2);
			// TODO: handle exception
		}

	}

}

好了，HIkariCP已經(jīng)配置好了，啟動(dòng)main；