Spring Boot 2.x基礎教程:預設資料來源Hikari的配置詳解
通過上一節的學習,我們已經學會如何應用Spring中的JdbcTemplate
來完成對MySQL的資料庫讀寫操作。接下來通過本篇文章,重點說說在訪問資料庫過程中的一個重要概念:資料來源(Data Source),以及Spring Boot中對資料來源的建立與配置。
基本概念
在開始說明Spring Boot中的資料來源配置之前,我們先搞清楚關於資料訪問的這些基本概念:
什麼是JDBC?
Java資料庫連線(Java Database Connectivity,簡稱JDBC)是Java語言中用來規範客戶端程式如何來訪問資料庫的應用程式介面,提供了諸如查詢和更新資料庫中資料的方法。JDBC也是Sun Microsystems的商標。我們通常說的JDBC是面向關係型資料庫的。
JDBC API主要位於JDK中的java.sql
包中(之後擴充套件的內容位於javax.sql
包中),主要包括(斜體代表介面,需驅動程式提供者來具體實現):
- DriverManager:負責載入各種不同驅動程式(Driver),並根據不同的請求,向呼叫者返回相應的資料庫連線(Connection)。
- Driver:驅動程式,會將自身載入到DriverManager中去,並處理相應的請求並返回相應的資料庫連線(Connection)。
- Connection:資料庫連線,負責與進行資料庫間通訊,SQL執行以及事務處理都是在某個特定Connection環境中進行的。可以產生用以執行SQL的Statement。
- Statement:用以執行SQL查詢和更新(針對靜態SQL語句和單次執行)。PreparedStatement:用以執行包含動態引數的SQL查詢和更新(在伺服器端編譯,允許重複執行以提高效率)。
- CallableStatement:用以呼叫資料庫中的儲存過程。
- SQLException:代表在資料庫連線的建立和關閉和SQL語句的執行過程中發生了例外情況(即錯誤)。
什麼是資料來源?
可以看到,在java.sql
中並沒有資料來源(Data Source)的概念。這是由於在java.sql
中包含的是JDBC核心API,另外還有個javax.sql
包,其中包含了JDBC標準的擴充套件API。而關於資料來源(Data Source)的定義,就在javax.sql
實際上,在JDBC核心API的實現下,就已經可以實現對資料庫的訪問了,那麼我們為什麼還需要資料來源呢?主要出於以下幾個目的:
- 封裝關於資料庫訪問的各種引數,實現統一管理
- 通過對資料庫的連線池管理,節省開銷並提高效率
在Java這個自由開放的生態中,已經有非常多優秀的開源資料來源可以供大家選擇,比如:DBCP、C3P0、Druid、HikariCP等。
而在Spring Boot 2.x中,對資料來源的選擇也緊跟潮流,採用了目前效能最佳的HikariCP。接下來,我們就來具體說說,這個Spring Boot中的預設資料來源配置。
預設資料來源:HikariCP
由於Spring Boot的自動化配置機制,大部分對於資料來源的配置都可以通過配置引數的方式去改變。只有一些特殊情況,比如:更換預設資料來源,多資料來源共存等情況才需要去修改覆蓋初始化的Bean內容。本節我們主要講Hikari的配置,所以對於使用其他資料來源或者多資料來源的情況,在之後的教程中學習。
在Spring Boot自動化配置中,對於資料來源的配置可以分為兩類:
- 通用配置:以
spring.datasource.*
的形式存在,主要是對一些即使使用不同資料來源也都需要配置的一些常規內容。比如:資料庫連結地址、使用者名稱、密碼等。這裡就不做過多說明了,通常就這些配置:
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
- 資料來源連線池配置:以
spring.datasource.<資料來源名稱>.*
的形式存在,比如:Hikari的配置引數就是spring.datasource.hikari.*
形式。下面這個是我們最常用的幾個配置項及對應說明:
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=20
spring.datasource.hikari.idle-timeout=500000
spring.datasource.hikari.max-lifetime=540000
spring.datasource.hikari.connection-timeout=60000
spring.datasource.hikari.connection-test-query=SELECT 1
這些配置的含義:
spring.datasource.hikari.minimum-idle
: 最小空閒連線,預設值10,小於0或大於maximum-pool-size,都會重置為maximum-pool-sizespring.datasource.hikari.maximum-pool-size
: 最大連線數,小於等於0會被重置為預設值10;大於零小於1會被重置為minimum-idle的值spring.datasource.hikari.idle-timeout
: 空閒連線超時時間,預設值600000(10分鐘),大於等於max-lifetime且max-lifetime>0,會被重置為0;不等於0且小於10秒,會被重置為10秒。spring.datasource.hikari.max-lifetime
: 連線最大存活時間,不等於0且小於30秒,會被重置為預設值30分鐘.設定應該比mysql設定的超時時間短spring.datasource.hikari.connection-timeout
: 連線超時時間:毫秒,小於250毫秒,否則被重置為預設值30秒spring.datasource.hikari.connection-test-query
: 用於測試連線是否可用的查詢語句
更多完整配置項可查看下錶:
name | 描述 | 構造器預設值 | 預設配置validate之後的值 | validate重置 |
---|---|---|---|---|
autoCommit | 自動提交從池中返回的連線 | TRUE | TRUE | – |
connectionTimeout | 等待來自池的連線的最大毫秒數 | SECONDS.toMillis(30) = 30000 | 30000 | 如果小於250毫秒,則被重置回30秒 |
idleTimeout | 連線允許在池中閒置的最長時間 | MINUTES.toMillis(10) = 600000 | 600000 | 如果idleTimeout+1秒>maxLifetime 且 maxLifetime>0,則會被重置為0(代表永遠不會退出);如果idleTimeout!=0且小於10秒,則會被重置為10秒 |
maxLifetime | 池中連線最長生命週期 | MINUTES.toMillis(30) = 1800000 | 1800000 | 如果不等於0且小於30秒則會被重置回30分鐘 |
connectionTestQuery | 如果您的驅動程式支援JDBC4,我們強烈建議您不要設定此屬性 | null | null | – |
minimumIdle | 池中維護的最小空閒連線數 | -1 | 10 | minIdle<0或者minIdle>maxPoolSize,則被重置為maxPoolSize |
maximumPoolSize | 池中最大連線數,包括閒置和使用中的連線 | -1 | 10 | 如果maxPoolSize小於1,則會被重置。當minIdle<=0被重置為DEFAULT_POOL_SIZE則為10;如果minIdle>0則重置為minIdle的值 |
metricRegistry | 該屬性允許您指定一個 Codahale / Dropwizard MetricRegistry 的例項,供池使用以記錄各種指標 | null | null | – |
healthCheckRegistry | 該屬性允許您指定池使用的Codahale / Dropwizard HealthCheckRegistry的例項來報告當前健康資訊 | null | null | – |
poolName | 連線池的使用者定義名稱,主要出現在日誌記錄和JMX管理控制檯中以識別池和池配置 | null | HikariPool-1 | – |
initializationFailTimeout | 如果池無法成功初始化連線,則此屬性控制池是否將 fail fast | 1 | 1 | – |
isolateInternalQueries | 是否在其自己的事務中隔離內部池查詢,例如連線活動測試 | FALSE | FALSE | – |
allowPoolSuspension | 控制池是否可以通過JMX暫停和恢復 | FALSE | FALSE | – |
readOnly | 從池中獲取的連線是否預設處於只讀模式 | FALSE | FALSE | – |
registerMbeans | 是否註冊JMX管理Bean(MBeans) | FALSE | FALSE | – |
catalog | 為支援 catalog 概念的資料庫設定預設 catalog | driver default | null | – |
connectionInitSql | 該屬性設定一個SQL語句,在將每個新連線建立後,將其新增到池中之前執行該語句。 | null | null | – |
driverClassName | HikariCP將嘗試通過僅基於jdbcUrl的DriverManager解析驅動程式,但對於一些較舊的驅動程式,還必須指定driverClassName | null | null | – |
transactionIsolation | 控制從池返回的連線的預設事務隔離級別 | null | null | – |
validationTimeout | 連線將被測試活動的最大時間量 | SECONDS.toMillis(5) = 5000 | 5000 | 如果小於250毫秒,則會被重置回5秒 |
leakDetectionThreshold | 記錄訊息之前連線可能離開池的時間量,表示可能的連線洩漏 | 0 | 0 | 如果大於0且不是單元測試,則進一步判斷:(leakDetectionThreshold < SECONDS.toMillis(2) or (leakDetectionThreshold > maxLifetime && maxLifetime > 0),會被重置為0 . 即如果要生效則必須>0,而且不能小於2秒,而且當maxLifetime > 0時不能大於maxLifetime |
dataSource | 這個屬性允許你直接設定資料來源的例項被池包裝,而不是讓HikariCP通過反射來構造它 | null | null | – |
schema | 該屬性為支援模式概念的資料庫設定預設模式 | driver default | null | – |
threadFactory | 此屬性允許您設定將用於建立池使用的所有執行緒的java.util.concurrent.ThreadFactory的例項。 | null | null | – |
scheduledExecutor | 此屬性允許您設定將用於各種內部計劃任務的java.util.concurrent.ScheduledExecutorService例項 | null | null | – |
程式碼示例
本文的相關例子可以檢視下面倉庫中的chapter3-2
目錄:
- Github:https://github.com/dyc87112/SpringBoot-Learning/
- Gitee:https://gitee.com/didispace/SpringBoot-Learning/
如果您覺得本文不錯,歡迎Star
支援,您的關注是我堅持的動力!
參考資料
- 百度百科:JDBC
- HikariCP官方文件
Spring Boot預設HikariDataSource配置
歡迎關注我的公眾號:程式猿DD,獲得獨家整理的學習資源和日常乾貨推送。
如果您對我的專題內容感興趣,也可以關注我的部落格:didispace.com