怎麼利用Spring Boot監控SQL運作狀況

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);
    }
}

以上是怎麼利用Spring Boot監控SQL運作狀況的詳細內容。更多資訊請關注PHP中文網其他相關文章！