阿里druid-spring-boot-starter 配置，個人整理以及遇到的問題（防止之後找不到）
- 2022 年 9 月 3 日
- 筆記
- springboot
簡介，什麼是Druid
Druid是阿里巴巴開源平台上的一個項目，整個項目由資料庫連接池、插件框架和SQL解析器組成。該項目主要是為了擴展JDBC的一些限制，可以讓程式設計師實現一些特殊的需求，比如向密鑰服務請求憑證、統計SQL資訊、SQL性能收集、SQL注入檢查、SQL翻譯等，程式設計師可以通過訂製來實現自己需要的功能。
1、Druid官方github地址（這個可以多看看）
2、需要導入一些依賴
Druid數據池依賴
<!-- 資料庫-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- //mvnrepository.com/artifact/com.alibaba/druid -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.11</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.11</version>
</dependency>
<!-- 資料庫日誌實現-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!--SpringBoot 的aop 模組-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
3、Druid配置資訊
現版本其實有大量的默認值都已經配置好了，可以自己去看看源碼
(配置資訊多，用yaml）
（對於Druid配置，只需要選用自己需要的就行了，我這裡是寫的一個總結，後面自己有需要其他還會加）
spring:
#資料庫配置項
# JDBC 配置(驅動類自動從url的mysql識別,數據源類型自動識別)(yaml相對來說配置資訊更加好觀看)
datasource:
druid:
type: com.alibaba.druid.pool.DruidDataSource
url: jdbc:mysql://localhost:3306/crm
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 2003
# 連接池配置資訊(通常來說，只需要修改initialSize、minIdle、maxActive
# 如果用Oracle，則把poolPreparedStatements配置為true，mysql可以配置為false。分庫分表較多的資料庫，建議配置為false。removeabandoned不建議在生產環境中打開如果用SQL Server，建議追加配置)
# 初始化大小
initial-size: 5
min-idle: 5
max-active: 20
# 配置獲取連接等待超時的時間
max-wait: 60000
# 配置間隔多久才進行一次檢測，檢測需要關閉的空閑連接，單位是毫秒
time-between-eviction-runs-millis: 60000
# 配置一個連接在池中最小生存的時間，單位是毫秒
min-evictable-idle-time-millis: 300000
# 申請連接的時候檢測，建議配置為true，不影響性能，並且保證安全性
test-while-idle: true
# 獲取連接時執行檢測，建議關閉，影響性能
test-on-borrow: false
# 是否開啟PSCache,PSCahce對支援游標的資料庫性能提示巨大，oracle建議開啟，mysql下建議關閉
pool-prepared-statements: false
# 開啟poolPreparedStatments後生效
max-pool-prepared-statement-per-connection-size: 20
# 配置監控統計攔截的filters，去掉後監控介面sql無法統計，『wall』用於防火牆·，log4j2：日誌
filters: stat,wall,log4j2
# Spring監控配置，說明請參考Druid Github Wiki，配置_Druid和Spring關聯監控配置
# Spring監控AOP切入點，如x.y.z.service.*,配置多個英文逗號分隔
aop-patterns: 'com.haoyang.webadmin.*'
# 配置監控屬性： 在druid-starter的： com.alibaba.druid.spring.boot.autoconfigure.stat包下進行的邏輯配置
web-stat-filter: # WebStatFilter配置，
enabled: true #默認為false，表示不使用WebStatFilter配置，就是屬性名去短線
url-pattern: /* #攔截該項目下的一切請求
exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*' #對這些請求放行
session-stat-enable: true
principal-session-name: session_name
principal-cookie-name: cookie_name
# profile-enable:
# session-stat-max-count:
stat-view-servlet: # StatViewServlet配置
enabled: true #默認為false，表示不使用StatViewServlet配置，就是屬性名去短線
url-pattern: /druid/* #配置DruidStatViewServlet的訪問地址。後台監控頁面的訪問地址
reset-enable: false #禁用HTML頁面上的「重置」功能，會把所有監控的數據全部清空，一般不使用
login-username: admin #監控頁面登錄的用戶名
login-password: 2003 #監控頁面登錄的密碼
# StatViewSerlvet展示出來的監控資訊比較敏感，是系統運行的內部情況，如果你需要做訪問控制，可以配置allow和deny這兩個參數
# deny優先於allow，如果在deny列表中，就算在allow列表中，也會被拒絕。如果allow沒有配置或者為空，則允許所有訪問
# 配置的格式
# <IP>
# 或者<IP>/<SUB_NET_MASK_size>其中128.242.127.1/24
# 24表示，前面24位是子網掩碼，比對的時候，前面24位相同就匹配,不支援IPV6。
allow: 127.0.0.1,192.168.2.111 #IP白名單(沒有配置或者為空，則允許所有訪問)。允許誰訪問druid後台，默認允許全部用戶訪問。
deny: #IP黑名單 (存在共同時，deny優先於allow)。不允許誰訪問druid後台
filter:
stat:
enabled: true # 開啟DruidDataSource狀態監控
db-type: mysql # 資料庫的類型
log-slow-sql: true # 開啟慢SQL記錄功能
slow-sql-millis: 2000 # 默認3000毫秒，這裡超過2s，就是慢，記錄到日誌
wall:
enabled: true
config:
drop-table-allow: false
4、問題
以前學習並沒有仔細觀看，現在回來看一遍發現了一些問題（後續繼續添加，目前學的不深）
1、配置問題
一開始把所有的資料庫連接池配置資訊全部寫進spring.datasource.druid下,這樣子
spring:
datasource:
druid:
filters: stat,wall,log4j2
# 初始化大小
initial-szie: 5
min-idle: 5
max-active: 20
然後寫了一個測試類
測試類
@SpringBootTest
class ApplicationTests {
@Autowired
DataSource dataSource;
@Test
void contextLoads() throws SQLException {
System.out.println(dataSource.getClass());
//獲得連接
Connection connection = dataSource.getConnection();
System.out.println(connection);
DruidDataSource druidDataSource = (DruidDataSource) dataSource;
System.out.println(druidDataSource.getMaxActive());
System.out.println(druidDataSource.getInitialSize());
System.out.println(druidDataSource.getMinIdle());
//關閉連接
connection.close();
}
}
然後經過了一些列斷點，源碼查看之後，發現spring.datasource.druid配置並沒有生效，發現是支援監控配置，但連接池配置並沒有寫進去
這裡看了一下官方的SpringBoot配置示例：
//github.com/alibaba/druid/tree/master/druid-spring-boot-starter
最後發現我自己寫了一個自定義注入類，然後注入的並不是spring.datasource.druid下的，而是spring.datasource下的，所以會報錯，如果並沒有寫這個類也沒事，SpringBoot會自動注入
/**
* 將自定義的Druid數據源添加到容器中，不再讓Spring Boot 自動創建
* 這樣做的目的是： 綁定全局配置文件中的druid 數據源屬性注入到 com.alibaba.druid.pool.DruidDataSource
* 從而讓它們生效
*
* @ConfigurationProperties(prefix = "spring.datasource"):
* 作用就是將 全局配置文件中前綴為Spring.dataSource的屬性值注入到com.alibaba.druid.pool.DruidDataSource的同名參數中
*/
@Configuration
public class DruidConfig {
/**
* 將所有前綴為spring.datasource下的配置項都載入DataSource中
*/
//@ConfigurationProperties("spring.datasource"),這樣注入，無法將druid配置文件下的連接池配置自動注入，所以我加一個.druid，這樣就是將spring.datasource.druid的屬性值注入到com.alibaba.druid.pool.DruidDataSource的同名參數中，而不是spring.datasource
@ConfigurationProperties("spring.datasource.druid")
@Bean
public DataSource druidDataSource() {
return new DruidDataSource();
}
