Spring Boot + Druid 實現監控 MySQL 性能，簡單又實用！

來源：blog.csdn.net/lvoelife/article/details/128092586 ## **1. 基本概念** 我們都使用過連接池，比如`C3P0，DBCP，hikari， Druid`，雖然HikariCP的速度稍快，但Druid能夠提供強大的監控和擴展功能，也是阿裡巴巴的開 ...

來源：blog.csdn.net/lvoelife/article/details/128092586

1. 基本概念

我們都使用過連接池，比如C3P0，DBCP，hikari， Druid，雖然HikariCP的速度稍快，但Druid能夠提供強大的監控和擴展功能，也是阿裡巴巴的開源項目。

Druid是阿裡巴巴開發的號稱為監控而生的資料庫連接池，在功能、性能、擴展性方面，都超過其他資料庫連接池，包括DBCP、C3P0、BoneCP、Proxool、JBoss DataSource等等，秒殺一切。

Druid可以很好的監控DB池連接和SQL的執行情況，天生就是針對監控而生的DB連接池。

Spring Boot預設數據源HikariDataSource與JdbcTemplate中已經介紹Spring Boot 2.x預設使用Hikari數據源，可以說Hikari與Driud都是當前Java Web上最優秀的數據源。

而Druid已經在阿裡巴巴部署了超過600個應用，經過好幾年生產環境大規模部署的嚴苛考驗！

stat： Druid內置提供一個StatFilter，用於統計監控信息。
wall： Druid防禦SQL註入攻擊的WallFilter就是通過Druid的SQL Parser分析。Druid提供的SQL Parser可以在JDBC層攔截SQL做相應處理，比如說分庫分表、審計等。
log4j2： 這個就是日誌記錄的功能，可以把sql語句列印到log4j2供排查問題。

2. 相關配置

2.1 添加依賴

Spring Boot 基礎就不介紹了，推薦看這個實戰項目：

https://github.com/javastacks/spring-boot-best-practice

<properties>
    <java.version>1.8</java.version>
    <alibabaDruidStarter.version>1.2.11</alibabaDruidStarter.version>
</properties>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>${alibabaDruidStarter.version}</version>
</dependency>

2.2 配置屬性

配置Druid數據源（連接池）： 如同c3p0、dbcp數據源可以設置數據源連接初始化大小、最大連接數、等待時間、最小連接數等一樣，Druid數據源同理可以進行設置。
配置Druid web監控filter（WebStatFilter）： 這個過濾器的作用就是統計web應用請求中所有的資料庫信息，比如發出的sql語句，sql執行的時間、請求次數、請求的url地址、以及seesion監控、資料庫表的訪問次數等等。
配置Druid後臺管理Servlet（StatViewServlet）： Druid數據源具有監控的功能，並提供了一個web界面方便用戶查看，類似安裝路由器時，人家也提供了一個預設的web頁面；需要設置Druid的後臺管理頁面的屬性，比如登錄賬號、密碼等。

【註意】：Druid Spring Boot Starter配置屬性的名稱完全遵照Druid，可以通過Spring Boot配置文件來配置Druid資料庫連接池和監控，如果沒有配置則使用預設值，如下在application.yml配置相關屬性：

# spring 配置
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    password: 123456
    username: root
    url: jdbc:mysql://localhost:3306/superjson?useUnicode=true&characterEncoding=utf8&useSSL=false
    # 連接池配置
    druid:
      # 初始化大小，最小，最大
      initial-size: 5
      min-idle: 5
      max-active: 20
      # 配置獲取連接等待超時的時間
      max-wait: 60000
      # 配置間隔多久才進行一次檢測，檢測需要關閉的空閑連接，單位毫秒
      time-between-eviction-runs-millis: 60000
      # 配置一個連接在池中最小生存時間
      min-evictable-idle-time-millis: 300000
      validation-query: SELECT 1 FROM user
      test-while-idle: true
      test-on-borrow: false
      test-on-return: false
      # 打開 PSCache，並且指定每個連接上 PSCache 的大小
      pool-prepared-statements: true
      max-pool-prepared-statement-per-connection-size: 20
      # 配置監控統計攔截的 Filter，去掉後監控界面 SQL 無法統計，wall 用於防火牆
      filters: stat,wall,slf4j
      # 通過 connection-properties 屬性打開 mergeSql 功能；慢 SQL 記錄
      connection-properties: druid.stat.mergeSql\=true;druid.stat.slowSqlMillis\=5000
      # 配置 DruidStatFilter
      web-stat-filter:
        enabled: true
        url-pattern: /*
        exclusions: .js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*
      # 配置 DruidStatViewServlet
      stat-view-servlet:
        url-pattern: /druid/*
        # IP 白名單，沒有配置或者為空，則允許所有訪問
        allow: 127.0.0.1
        # IP 黑名單，若白名單也存在，則優先使用
        deny: 192.168.31.253
        # 禁用 HTML 中 Reset All 按鈕
        reset-enable: false
        # 登錄用戶名/密碼
        login-username: root
        login-password: 123456
        # 需要設置enabled=true,否則會報出There was an unexpected error (type=Not Found, status=404).錯誤，或者將druid-spring-boot-starter的版本降低到1.1.10及以下
        # 是否啟用StatViewServlet（監控頁面）預設值為false（考慮到安全問題預設並未啟動，如需啟用建議設置密碼或白名單以保障安全）
        enabled: true

上述配置文件的參數可以在com.alibaba.druid.spring.boot.autoconfigure.properties.DruidStatProperties和 org.springframework.boot.autoconfigure.jdbc.DataSourcePropertie中找到。

推薦一個開源免費的 Spring Boot 實戰項目：

https://github.com/javastacks/spring-boot-best-practice

2.3 配置Filter

可以通過spring.datasource.druid.filters=stat,wall,log4j ...的方式來啟用相應的內置Filter，不過這些Filter都是預設配置。如果預設配置不能滿足需求，可以放棄這種方式，通過配置文件來配置Filter，如下所示：

# 配置StatFilter
spring.datasource.druid.filter.stat.enabled=true
spring.datasource.druid.filter.stat.db-type=h2
spring.datasource.druid.filter.stat.log-slow-sql=true
spring.datasource.druid.filter.stat.slow-sql-millis=2000

# 配置WallFilter
spring.datasource.druid.filter.wall.enabled=true
spring.datasource.druid.filter.wall.db-type=h2
spring.datasource.druid.filter.wall.config.delete-allow=false
spring.datasource.druid.filter.wall.config.drop-table-allow=false

目前為以下Filter提供了配置支持，根據（spring.datasource.druid.filter.*）進行配置。

StatFilter
WallFilter
ConfigFilter
EncodingConvertFilter
Slf4jLogFilter
Log4jFilter
Log4j2Filter
CommonsLogFilter

不想使用內置的Filters，要想使自定義Filter配置生效需要將對應Filter的enabled設置為true，Druid Spring Boot Starter預設禁用StatFilter，可以將其enabled設置為true來啟用它。

3 監控頁面

啟動項目後，訪問http://localhost:8081/druid/login.html來到登錄頁面，輸入用戶名密碼登錄，如下所示：

數據源頁面是當前DataSource配置的基本信息，上述配置的Filter可以在裡面找到，如果沒有配置 Filter（一些信息會無法統計，例如SQL監控會無法獲取JDBC相關的SQL執行信息）

SQL監控頁面

統計了所有SQL語句的執行情況

URL監控頁面

統計了所有Controller介面的訪問以及執行情況

Spring監控頁面

利用aop對指定介面的執行時間，jdbc數進行記錄

SQL防火牆頁面

druid提供了黑白名單的訪問，可以清楚的看到sql防護情況。

Session監控頁面

可以看到當前的session狀況，創建時間、最後活躍時間、請求次數、請求時間等詳細參數。

JSONAPI頁面

通過api的形式訪問Druid的監控介面，api介面返回Json形式數據。

4. sql監控

配置Druid web監控filter（WebStatFilter）這個過濾器，作用就是統計web應用請求中所有的資料庫信息，比如發出的sql語句，sql執行的時間、請求次數、請求的url地址、以及seesion監控、資料庫表的訪問次數，如下配置：

spring:
  datasource:
    druid:
      ########## 配置WebStatFilter，用於採集web關聯監控的數據 ##########
      web-stat-filter:
        enabled: true                   # 啟動 StatFilter
        url-pattern: /*                 # 過濾所有url
        exclusions: "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*" # 排除一些不必要的url
        session-stat-enable: true       # 開啟session統計功能
        session-stat-max-count: 1000    # session的最大個數,預設100

5. 慢sql記錄

有時候，系統中有些SQL執行很慢，我們希望使用日誌記錄下來，可以開啟Druid的慢SQL記錄功能，如下配置：

spring:
  datasource:
    druid:
      filter:
        stat:
          enabled: true         # 開啟DruidDataSource狀態監控
          db-type: mysql        # 資料庫的類型
          log-slow-sql: true    # 開啟慢SQL記錄功能
          slow-sql-millis: 2000 # 預設3000毫秒，這裡超過2s，就是慢，記錄到日誌

啟動後，如果遇到執行慢的SQL，便會輸出到日誌中

6. spring 監控

訪問之後spring監控預設是沒有數據的，但需要導入SprngBoot的AOP的Starter，如下所示：

<!--SpringBoot 的aop 模塊-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

同時需要在application.yml按如下配置:

Spring監控AOP切入點，如com.springboot.template.dao.*,配置多個英文逗號分隔

spring.datasource.druid.aop-patterns="com.springboot.template.dao.*"

7. 去廣告(Ad)

訪問監控頁面的時候，你可能會在頁面底部（footer）看到阿裡巴巴的廣告，如下所示：

原因：引入的druid的jar包中的common.js(裡面有一段js代碼是給頁面的footer追加廣告的)

如果想去掉，有兩種方式：

1. 直接手動註釋這段代碼

如果是使用Maven，直接到本地倉庫中，查找這個jar包，註釋如下代碼：

// this.buildFooter();

common.js的位置：

com/alibaba/druid/1.1.23/druid-1.1.23.jar!/support/http/resources/js/common.js

2. 使用過濾器過濾

註冊一個過濾器，過濾common.js的請求，使用正則表達式替換相關的廣告內容，如下代碼所示：

@Configuration
@ConditionalOnWebApplication
@AutoConfigureAfter(DruidDataSourceAutoConfigure.class)
@ConditionalOnProperty(name = "spring.datasource.druid.stat-view-servlet.enabled",
havingValue = "true", matchIfMissing = true)
public class RemoveDruidAdConfig {

    /**
    * 方法名: removeDruidAdFilterRegistrationBean
    * 方法描述 除去頁面底部的廣告
    * @param properties com.alibaba.druid.spring.boot.autoconfigure.properties.DruidStatProperties
    * @return org.springframework.boot.web.servlet.FilterRegistrationBean
    */
    @Bean
    public FilterRegistrationBean removeDruidAdFilterRegistrationBean(DruidStatProperties properties) {

        // 獲取web監控頁面的參數
        DruidStatProperties.StatViewServlet config = properties.getStatViewServlet();
        // 提取common.js的配置路徑
        String pattern = config.getUrlPattern() != null ? config.getUrlPattern() : "/druid/*";
        String commonJsPattern = pattern.replaceAll("\\*", "js/common.js");

        final String filePath = "support/http/resources/js/common.js";

        //創建filter進行過濾
        Filter filter = new Filter() {
            @Override
            public void init(FilterConfig filterConfig) throws ServletException {}

            @Override
            public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
                chain.doFilter(request, response);
                // 重置緩衝區，響應頭不會被重置
                response.resetBuffer();
                // 獲取common.js
                String text = Utils.readFromResource(filePath);
                // 正則替換banner, 除去底部的廣告信息
                text = text.replaceAll("<a.*?banner\"></a><br/>", "");
                text = text.replaceAll("powered.*?shrek.wang</a>", "");
                response.getWriter().write(text);
            }

            @Override
            public void destroy() {}
        };

        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        registrationBean.setFilter(filter);
        registrationBean.addUrlPatterns(commonJsPattern);
        return registrationBean;
    }
}

兩種方式都可以，建議使用的是第一種，從根源解決。

8. 獲取 Druid 的監控數據

Druid的監控數據可以在開啟StatFilter後，通過DruidStatManagerFacade進行獲取;

DruidStatManagerFacade#getDataSourceStatDataList該方法可以獲取所有數據源的監控數據，除此之外DruidStatManagerFacade還提供了一些其他方法，可以按需選擇使用。

@RestController
@RequestMapping(value = "/druid")
public class DruidStatController {

    @GetMapping("/stat")
    public Object druidStat(){
        // 獲取數據源的監控數據
        return DruidStatManagerFacade.getInstance().getDataSourceStatDataList();
    }
}

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了。。。

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發佈，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！