技術文章 » 阿里druid-spring-boot-starter 設定，個人整理以及遇到的問題（防止之後找不到）

阿里druid-spring-boot-starter 設定，個人整理以及遇到的問題（防止之後找不到）

2022-09-03 15:00:26

​

簡介，什麼是Druid

Druid是阿里巴巴開源平臺上的一個專案，整個專案由資料庫連線池、外掛框架和SQL解析器組成。該專案主要是為了擴充套件JDBC的一些限制，可以讓程式設計師實現一些特殊的需求，比如向金鑰服務請求憑證、統計SQL資訊、SQL效能收集、SQL隱碼攻擊檢查、SQL翻譯等，程式設計師可以通過客製化來實現自己需要的功能。

1、Druid官方github地址（這個可以多看看）

https://github.com/alibaba/druid

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>
        <!-- https://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設定範例：

https://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();
    }