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

Posted on 2022-02-15 by WalkonNet

前言

今天想和大傢聊一聊 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/

總結

到此這篇關於Spring Boot監控SQL運行情況的文章就介紹到這瞭,更多相關SpringBoot監控SQL運行內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

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

目錄

前言

1. 準備工作

2. 引入 Druid

3. 測試

4. 去廣告

總結

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

前言

1. 準備工作

2. 引入 Druid

3. 測試

4. 去廣告

總結

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆