Spring Boot監控SQL執行情況的全過程

2022-02-15 16:00:26

前言

今天想和大家聊一聊 Druid 中的監控功能。

Druid 資料庫連線池相信很多小夥伴都用過，個人感覺 Druid 是阿里比較成功的開源專案了，不像 Fastjson 那麼多槽點，Druid 各方面一直都比較出色，功能齊全，使用也方便，基本的用法就不說了，今天我們來看看 Druid 中的監控功能。

1. 準備工作

首先我們來建立一個 Spring Boot 工程，引入 MyBatis 等，如下：

選一下 MyBatis 和 MySQL 驅動，做一個簡單的測試案例。

先來連線一下資料庫：

spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql:///test05?serverTimezone=Asia/Shanghai

建立一個 User 實體類，做一個簡單的查詢案例，如下：

public class User {
    private Integer id;
    private String username;
    private String address;
    private String password;
    private String email;
    //省略 getter/setter
}
@Mapper
public interface UserMapper {
    List<User> getUserByUsername(String username);
}
@Service
public class UserService {
    @Autowired
    UserMapper userMapper;
    public List<User> getUserByUsername(String username){
        return userMapper.getUserByUsername(username);
    }
}
@RestController
public class UserController {
    @Autowired
    UserService userService;

    @GetMapping("/user")
    public List<User> getUser(String username) {
        return userService.getUserByUsername(username);
    }
}

UserMapper.xml 如下：

<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.javaboy.druid_monitor.mapper.UserMapper">
    <select id="getUserByUsername" resultType="org.javaboy.druid_monitor.model.User">
        select * from user where username=#{username}
    </select>
</mapper>

一個很簡單的測試，沒啥好說的。

這個環境搭建大家隨意，如果你已經有持久化的案例了，那就直接看第二小節引入 Druid。

現在這個工程預設的使用的資料庫連線池是 HikariDataSource，這是 Spring Boot 中預設的一個資料庫連線池，其實這個也還不錯。

2. 引入 Druid

接下來我們引入 Druid：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.2.8</version>
</dependency>

注意，Spring Boot 引入的 Druid 是上面這個，這個將來設定監控的時候方便一些。

接下來我們在 application.properties 中設定 WebStatFilter，WebStatFilter 用於採集 web-jdbc 關聯監控的資料：

# 啟用 WebStatFilter
spring.datasource.druid.web-stat-filter.enabled=true
# 設定攔截規則
spring.datasource.druid.web-stat-filter.url-pattern=/*
# 排除一些不必要的 url，這些 URL 不會涉及到 SQL 查詢
spring.datasource.druid.web-stat-filter.exclusions=*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*
# 開啟 session 統計功能
spring.datasource.druid.web-stat-filter.session-stat-enable=true
# 預設 sessionStatMaxCount 是 1000 個，我們可以按需要進行設定
spring.datasource.druid.web-stat-filter.session-stat-max-count=1000
# 設定 principalSessionName，使得 druid 能夠知道當前的 session 的使用者是誰
# 根據需要，這個引數的值是 user 資訊儲存在 session 中的 sessionName
#spring.datasource.druid.web-stat-filter.principal-session-name=
# 下面這個設定的作用和上面設定的作用類似，這個是通過 Cookie 來識別使用者
#spring.datasource.druid.web-stat-filter.principal-cookie-name=
# 開啟 profile 後就能夠監控單個 URL 地址呼叫列表
#spring.datasource.druid.web-stat-filter.profile-enable=

我們設定前面五個就可以了，後面三個可以不用設定，各項設定的含義鬆哥已經在程式碼中列出來了。

接下來開啟 StatViewServlet 的設定，如下：

# 啟用內建的監控頁面
spring.datasource.druid.stat-view-servlet.enabled=true
# 內建監控頁面的地址
spring.datasource.druid.stat-view-servlet.url-pattern=/druid/*
# 開啟 Reset All 功能
spring.datasource.druid.stat-view-servlet.reset-enable=true
# 設定登入使用者名稱
spring.datasource.druid.stat-view-servlet.login-username=javaboy
# 設定登入密碼
spring.datasource.druid.stat-view-servlet.login-password=123
# 白名單（如果allow沒有設定或者為空，則允許所有存取）
spring.datasource.druid.stat-view-servlet.allow=127.0.0.1
# 黑名單（deny 優先於 allow，如果在 deny 列表中，就算在 allow 列表中，也會被拒絕）
spring.datasource.druid.stat-view-servlet.deny=

設定一下頁面地址，設定一下黑白名單即可。

需要注意的是，reset-enable 屬性即使設定為 false，重置按鈕也會顯示，只是點選該按鈕並不會重置而已。

好啦，這就完事了。

3. 測試

好啦，接下來我們啟動 Spring Boot 專案進行測試。

Spring Boot 專案啟動成功後，首先存取如下地址：

http://localhost:8080/druid/login.html

此時我們會看到登入認證頁面，如下：

輸入我們前面設定的使用者名稱/密碼（javaboy/123）進行登入，登入成功後，可以看到如下頁面：

從標題列就可以看到，資料來源、SQL 監控、SQL 防火牆等功能都是一應俱全。

接下來我們存取 http://localhost:8080/user?username=aaa 地址，執行一條 SQL，執行完成後，我們來檢視 SQL 監控：

可以看到，此時就有 SQL 執行的監控記錄了。

其他的監控資料也都可以看到，我就不一一列舉了。如果小夥伴們覺得這裡展示的資料不直觀，想自己畫 HTML 頁面，那也是可以的，點選最後面的 JSON API，可以看到每一個監控項的 JSON 地址，拿著 JSON 自己想怎麼顯示就怎麼顯示。

4. 去廣告

如果想直接用這個監控頁面，這個上面有阿里的廣告，如下圖，公司用的話就特別彆扭：

我們可能想去掉這個廣告，這也很容易。

首先，經過分析，我們發現廣告是由一個叫做 common.js 的檔案構建出來的，該檔案位於 druid-1.2.8.jar!/support/http/resources/js/common.js 這裡，common.js 檔案中有如下幾行：

init : function() {
 this.buildFooter();
 druid.lang.init();
},
buildFooter : function() {
 var html ='';
 $(document.body).append(html);
},

大概邏輯就是上面這樣，buildFooter 方法負責構建頁面末尾的廣告，在 init 方法中完成對 buildFooter 方法的呼叫。

那麼想要去除廣告，就別呼叫 buildFooter 方法就行了。

所以我們的去廣告思路也很簡單，寫一個過濾器，攔截下對 common.js 的請求，然後做一點點修改，如下：

@WebFilter(urlPatterns = "/druid/js/common.js")
public class RemoveAdFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        String text = Utils.readFromResource("support/http/resources/js/common.js");
        text = text.replace("this.buildFooter();", "");
        servletResponse.getWriter().write(text);
    }
}

可以看到，這個過濾器就是攔截 /druid/js/common.js 請求，攔截到之後，自己去檔案中讀取 common.js 檔案，然後手動替換掉 this.buildFooter(); 這一句就行了，最後再把檔案寫出去就行了。

當然，記得在啟動類中掃描 Filter，如下：

@SpringBootApplication
@ServletComponentScan("org.javaboy.druid_monitor.filter")
public class DruidMonitorApplication {

    public static void main(String[] args) {
        SpringApplication.run(DruidMonitorApplication.class, args);
    }

}

好啦，這就可以啦，有了這個過濾器，廣告就沒了。

本文案例：https://github.com/lenve/javaboy-code-samples/tree/master/druid_monitor

參考資料：

https://github.com/alibaba/druid/wiki/