Spring?Boot監(jiān)控SQL運(yùn)行情況的全過程
前言
今天想和大家聊一聊 Druid 中的監(jiān)控功能。
Druid 數(shù)據(jù)庫(kù)連接池相信很多小伙伴都用過,個(gè)人感覺 Druid 是阿里比較成功的開源項(xiàng)目了,不像 Fastjson 那么多槽點(diǎn),Druid 各方面一直都比較出色,功能齊全,使用也方便,基本的用法就不說(shuō)了,今天我們來(lái)看看 Druid 中的監(jiān)控功能。
1. 準(zhǔn)備工作
首先我們來(lái)創(chuàng)建一個(gè) Spring Boot 工程,引入 MyBatis 等,如下:

選一下 MyBatis 和 MySQL 驅(qū)動(dòng),做一個(gè)簡(jiǎn)單的測(cè)試案例。
先來(lái)連接一下數(shù)據(jù)庫(kù):
spring.datasource.username=root spring.datasource.password=123 spring.datasource.url=jdbc:mysql:///test05?serverTimezone=Asia/Shanghai
創(chuàng)建一個(gè) User 實(shí)體類,做一個(gè)簡(jiǎn)單的查詢案例,如下:
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>
一個(gè)很簡(jiǎn)單的測(cè)試,沒啥好說(shuō)的。
這個(gè)環(huán)境搭建大家隨意,如果你已經(jīng)有持久化的案例了,那就直接看第二小節(jié)引入 Druid。
現(xiàn)在這個(gè)工程默認(rèn)的使用的數(shù)據(jù)庫(kù)連接池是 HikariDataSource,這是 Spring Boot 中默認(rèn)的一個(gè)數(shù)據(jù)庫(kù)連接池,其實(shí)這個(gè)也還不錯(cuò)。
2. 引入 Druid
接下來(lái)我們引入 Druid:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.8</version>
</dependency>
注意,Spring Boot 引入的 Druid 是上面這個(gè),這個(gè)將來(lái)配置監(jiān)控的時(shí)候方便一些。
接下來(lái)我們?cè)?application.properties 中配置 WebStatFilter,WebStatFilter 用于采集 web-jdbc 關(guān)聯(lián)監(jiān)控的數(shù)據(jù):
# 啟用 WebStatFilter spring.datasource.druid.web-stat-filter.enabled=true # 配置攔截規(guī)則 spring.datasource.druid.web-stat-filter.url-pattern=/* # 排除一些不必要的 url,這些 URL 不會(huì)涉及到 SQL 查詢 spring.datasource.druid.web-stat-filter.exclusions=*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/* # 開啟 session 統(tǒng)計(jì)功能 spring.datasource.druid.web-stat-filter.session-stat-enable=true # 缺省 sessionStatMaxCount 是 1000 個(gè),我們可以按需要進(jìn)行配置 spring.datasource.druid.web-stat-filter.session-stat-max-count=1000 # 配置 principalSessionName,使得 druid 能夠知道當(dāng)前的 session 的用戶是誰(shuí) # 根據(jù)需要,這個(gè)參數(shù)的值是 user 信息保存在 session 中的 sessionName #spring.datasource.druid.web-stat-filter.principal-session-name= # 下面這個(gè)配置的作用和上面配置的作用類似,這個(gè)是通過 Cookie 來(lái)識(shí)別用戶 #spring.datasource.druid.web-stat-filter.principal-cookie-name= # 開啟 profile 后就能夠監(jiān)控單個(gè) URL 地址調(diào)用列表 #spring.datasource.druid.web-stat-filter.profile-enable=
我們配置前面五個(gè)就可以了,后面三個(gè)可以不用配置,各項(xiàng)配置的含義松哥已經(jīng)在代碼中列出來(lái)了。
接下來(lái)開啟 StatViewServlet 的配置,如下:
# 啟用內(nèi)置的監(jiān)控頁(yè)面 spring.datasource.druid.stat-view-servlet.enabled=true # 內(nèi)置監(jiān)控頁(yè)面的地址 spring.datasource.druid.stat-view-servlet.url-pattern=/druid/* # 開啟 Reset All 功能 spring.datasource.druid.stat-view-servlet.reset-enable=true # 設(shè)置登錄用戶名 spring.datasource.druid.stat-view-servlet.login-username=javaboy # 設(shè)置登錄密碼 spring.datasource.druid.stat-view-servlet.login-password=123 # 白名單(如果allow沒有配置或者為空,則允許所有訪問) spring.datasource.druid.stat-view-servlet.allow=127.0.0.1 # 黑名單(deny 優(yōu)先于 allow,如果在 deny 列表中,就算在 allow 列表中,也會(huì)被拒絕) spring.datasource.druid.stat-view-servlet.deny=
配置一下頁(yè)面地址,配置一下黑白名單即可。
需要注意的是,reset-enable 屬性即使設(shè)置為 false,重置按鈕也會(huì)顯示,只是點(diǎn)擊該按鈕并不會(huì)重置而已。
好啦,這就完事了。
3. 測(cè)試
好啦,接下來(lái)我們啟動(dòng) Spring Boot 項(xiàng)目進(jìn)行測(cè)試。
Spring Boot 項(xiàng)目啟動(dòng)成功后,首先訪問如下地址:
http://localhost:8080/druid/login.html
此時(shí)我們會(huì)看到登錄認(rèn)證頁(yè)面,如下:

輸入我們前面配置的用戶名/密碼(javaboy/123)進(jìn)行登錄,登錄成功后,可以看到如下頁(yè)面:

從標(biāo)題欄就可以看到,數(shù)據(jù)源、SQL 監(jiān)控、SQL 防火墻等功能都是一應(yīng)俱全。
接下來(lái)我們?cè)L問 http://localhost:8080/user?username=aaa 地址,執(zhí)行一條 SQL,執(zhí)行完成后,我們來(lái)查看 SQL 監(jiān)控:

可以看到,此時(shí)就有 SQL 執(zhí)行的監(jiān)控記錄了。
其他的監(jiān)控?cái)?shù)據(jù)也都可以看到,我就不一一列舉了。如果小伙伴們覺得這里展示的數(shù)據(jù)不直觀,想自己畫 HTML 頁(yè)面,那也是可以的,點(diǎn)擊最后面的 JSON API,可以看到每一個(gè)監(jiān)控項(xiàng)的 JSON 地址,拿著 JSON 自己想怎么顯示就怎么顯示。
4. 去廣告
如果想直接用這個(gè)監(jiān)控頁(yè)面,這個(gè)上面有阿里的廣告,如下圖,公司用的話就特別別扭:

我們可能想去掉這個(gè)廣告,這也很容易。
首先,經(jīng)過分析,我們發(fā)現(xiàn)廣告是由一個(gè)叫做 common.js 的文件構(gòu)建出來(lái)的,該文件位于 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 方法負(fù)責(zé)構(gòu)建頁(yè)面末尾的廣告,在 init 方法中完成對(duì) buildFooter 方法的調(diào)用。
那么想要去除廣告,就別調(diào)用 buildFooter 方法就行了。
所以我們的去廣告思路也很簡(jiǎn)單,寫一個(gè)過濾器,攔截下對(duì) common.js 的請(qǐng)求,然后做一點(diǎn)點(diǎn)修改,如下:
@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);
}
}
可以看到,這個(gè)過濾器就是攔截 /druid/js/common.js 請(qǐng)求,攔截到之后,自己去文件中讀取 common.js 文件,然后手動(dòng)替換掉 this.buildFooter(); 這一句就行了,最后再把文件寫出去就行了。
當(dāng)然,記得在啟動(dòng)類中掃描 Filter,如下:
@SpringBootApplication
@ServletComponentScan("org.javaboy.druid_monitor.filter")
public class DruidMonitorApplication {
? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(DruidMonitorApplication.class, args);
? ? }
}好啦,這就可以啦,有了這個(gè)過濾器,廣告就沒了。
本文案例:https://github.com/lenve/javaboy-code-samples/tree/master/druid_monitor
參考資料:
https://github.com/alibaba/druid/wiki/
總結(jié)
到此這篇關(guān)于Spring Boot監(jiān)控SQL運(yùn)行情況的文章就介紹到這了,更多相關(guān)SpringBoot監(jiān)控SQL運(yùn)行內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java實(shí)現(xiàn)文件名倒序排序的技術(shù)指南
在實(shí)際開發(fā)過程中,我們經(jīng)常需要對(duì)文件進(jìn)行操作和處理,一個(gè)常見的需求是按文件名倒序排列文件列表,以便于文件的管理和查找,本文將介紹如何在Java中實(shí)現(xiàn)文件名倒序排序,并提供詳細(xì)的代碼案例,需要的朋友可以參考下2024-08-08
Java的super關(guān)鍵字與instanceof運(yùn)算符使用方法
這篇文章主要介紹了Java的super關(guān)鍵字與instanceof運(yùn)算符使用方法,是Java入門學(xué)習(xí)中的基礎(chǔ)知識(shí),需要的朋友可以參考下2015-09-09
Java實(shí)現(xiàn)入?yún)?shù)據(jù)批量數(shù)據(jù)校驗(yàn)詳解
在業(yè)務(wù)處理中一般入?yún)⑹菃螚l數(shù)據(jù),這樣數(shù)據(jù)校驗(yàn)比較容易,但是這種方法對(duì)于集合數(shù)據(jù)的校驗(yàn)不適用,下面我們就來(lái)看看如何對(duì)入?yún)?shù)據(jù)進(jìn)行批量數(shù)據(jù)校驗(yàn)吧2024-02-02
Java Apache Shiro安全框架快速開發(fā)詳解流程
Apache Shiro是一個(gè)強(qiáng)大且易用的Java安全框架,執(zhí)行身份驗(yàn)證、授權(quán)、密碼和會(huì)話管理。使用Shiro的易于理解的API,您可以快速、輕松地獲得任何應(yīng)用程序,從最小的移動(dòng)應(yīng)用程序到最大的網(wǎng)絡(luò)和企業(yè)應(yīng)用程序2021-10-10
SpringBoot使用前綴樹實(shí)現(xiàn)敏感詞過濾示例
最近項(xiàng)目用到了敏感詞過濾,本文主要就來(lái)介紹一下SpringBoot使用前綴樹實(shí)現(xiàn)敏感詞過濾示例,具有一定的參考價(jià)值,感興趣的可以了解一下2023-10-10
spring整合redis消息監(jiān)聽通知使用的實(shí)現(xiàn)示例
在電商系統(tǒng)中,秒殺,搶購(gòu),紅包優(yōu)惠卷等操作,一般都會(huì)設(shè)置時(shí)間限制,本文主要介紹了spring整合redis消息監(jiān)聽通知使用,具有一定的參考價(jià)值,感興趣的可以了解一下2021-12-12
Spring Cloud微服務(wù)使用webSocket的方法
WebSocket在現(xiàn)代瀏覽器中的應(yīng)用已經(jīng)算是比較普遍了,在某些業(yè)務(wù)場(chǎng)景下,要求必須能夠在服務(wù)器端推送消息至客戶端,本文給大家介紹Spring Cloud微服務(wù)使用webSocket的方法,感興趣的朋友一起看看吧2021-06-06
SpringCloud Feign多參數(shù)傳遞及需要注意的問題
這篇文章主要介紹了SpringCloud Feign多參數(shù)傳遞及需要注意的問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03

