Mybatis之如何攔截慢SQL日志記錄
Mybatis攔截慢SQL日志記錄
通過分析MySQL慢查詢?nèi)罩静环奖?,利用?shù)據(jù)源不直觀,無法了解上下文調(diào)用關系
要求通過可配置化的操作實現(xiàn)日志在控制臺的輸出和在數(shù)據(jù)庫中記錄
本文利用SpringBoot和Mybatis,基于Mybatis Interceptor實現(xiàn)慢SQL攔截日志記錄和打印輸出
服務配置
# slow-sql # 基于interceptor slow-sql-interceptor.enabled=true # 設置超時時間ms slow-sql.timeout=10 # 日志是否插入數(shù)據(jù)庫 slow-sql.insertDB=true
日志實體類
@Data public class SqlLog { // 主鍵 private Long id; // 調(diào)用方法名稱 private String methodName; // 參數(shù)列表 private String params; // 方法執(zhí)行時間 private Long runTime; // 執(zhí)行SQL private String executeSql; // SQL類型 private String sqlType; // 記錄創(chuàng)建時間 private Date createTime; }
SQL攔截器
@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}), @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}), @Signature(type = StatementHandler.class, method = "batch", args = {Statement.class})}) @Component @Slf4j // 配置文件讀取是否啟用此配置 @ConditionalOnProperty(prefix = "slow-sql-interceptor", name = "enabled", havingValue = "true") public class SqlExecuteTimeInterceptor implements Interceptor { // 日志記錄mapper @Autowired private LogMapper logMapper; // 是否插入數(shù)據(jù)庫標識 @Value("${slow-sql.insertDB}") private boolean isInsertDB; // 超時時間 @Value("${slow-sql.timeout}") private Long timeout; /** * @Author thailandking * @Date 2020/2/16 16:44 * @LastEditors thailandking * @LastEditTime 2020/2/16 16:44 * @Description sql攔截器 */ @Override public Object intercept(Invocation invocation) throws Throwable { Object target = invocation.getTarget(); long begin = System.currentTimeMillis(); StatementHandler statementHandler = (StatementHandler) target; try { return invocation.proceed(); } finally { long end = System.currentTimeMillis(); // 判斷超時 if ((end - begin) > timeout) { // 方法名稱、類型 MetaObject metaObject = MetaObject.forObject(statementHandler, SystemMetaObject.DEFAULT_OBJECT_FACTORY, SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY, new DefaultReflectorFactory()); MappedStatement mappedStatement = (MappedStatement) metaObject.getValue("delegate.mappedStatement"); String methodName = mappedStatement.getId(); String sqlType = mappedStatement.getSqlCommandType().toString(); // 控制臺打印日志 BoundSql boundSql = statementHandler.getBoundSql(); String sql = boundSql.getSql(); // 參數(shù)map Object parameterObject = boundSql.getParameterObject(); // 參數(shù)列表 List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings(); // 格式化sql語句,去除換行符,替換參數(shù) sql = formatSQL(sql, parameterObject, parameterMappingList); log.error("執(zhí)行 SQL:[ {} ], 執(zhí)行耗時[ {} ms ]", sql, (end - begin)); // 判斷是否寫入數(shù)據(jù)庫 if (isInsertDB) { // 轉(zhuǎn)換參數(shù)map為String String params = changeSqlMapParams(parameterObject, parameterMappingList); SqlLog log = new SqlLog(); log.setMethodName(methodName); log.setParams(params); log.setRunTime((end - begin)); log.setExecuteSql(sql); log.setSqlType(sqlType); logMapper.insertSqlLog(log); } } } } private String changeSqlMapParams(Object parameterObject, List<ParameterMapping> parameterMappingList) { StringBuilder sb = new StringBuilder(); Map<String, Object> params = (Map<String, Object>) parameterObject; for (ParameterMapping pm : parameterMappingList) { if (pm.getMode().name().equals("IN")) { String param = ",[" + params.get(pm.getProperty()).toString() + "]"; sb.append(param); } } return sb.length() > 0 ? sb.substring(1) : null; } private String formatSQL(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) { if (sql == null || sql.length() == 0) { return ""; } // 去除換行符 sql = sql.replaceAll("[\\s\n ]+", " "); // 替換參數(shù) Map<String, Object> params = (Map<String, Object>) parameterObject; for (ParameterMapping pm : parameterMappingList) { if (pm.getMode().name().equals("IN")) { sql = sql.replaceFirst("\\?", params.get(pm.getProperty()).toString()); } } return sql; } @Override public Object plugin(Object target) { return Plugin.wrap(target, this); } @Override public void setProperties(Properties properties) { } }
效果展示
Mybatis攔截器打印完整sql日志
開始創(chuàng)建攔截器,創(chuàng)建自定義攔截器必須實現(xiàn)Interceptor接口,那么我們新建一個SqlLoggerInterceptor類并實現(xiàn)Interceptor接口,并且通過@Intercepts和@Signature注解來配置攔截的方法和對象
我們經(jīng)常用到的就只有update和兩個query,因此在@Intercepts內(nèi)寫上3個Signature,如:
可以看出update、query、query中的args中的對象是和Executor中的update、query、query方法中的參數(shù)是一一對應的,實現(xiàn)Interceptor接口中的方法,主要有三個方法分別是plugin、setProperties、intercept,而我們主要做的就是intercept方法,plugin方法一般固定即可,setProperties是在外部傳近來的值
創(chuàng)建攔截器,實現(xiàn)
org.apache.ibatis.plugin.Interceptor
@Slf4j @Intercepts({ //type指定代理的是那個對象,method指定代理Executor中的那個方法,args指定Executor中的query方法都有哪些參數(shù)對象 //由于Executor中有兩個query,因此需要兩個@Signature @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),//需要代理的對象和方法 @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}), @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})//需要代理的對象和方法 }) public class SqlLoggerInterceptor implements Interceptor { @Override public Object intercept(Invocation invocation) throws Throwable { MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0]; Object parameter = null; if (invocation.getArgs().length > 1) { //獲得查詢方法的參數(shù),比如selectById(Integer id,String name),那么就可以獲取到四個參數(shù)分別是: //{id:1,name:"user1",param1:1,param2:"user1"} parameter = invocation.getArgs()[1]; } String sqlId = mappedStatement.getId();//獲得mybatis的*mapper.xml文件中映射的方法,如:com.best.dao.UserMapper.selectById //將參數(shù)和映射文件組合在一起得到BoundSql對象 BoundSql boundSql = mappedStatement.getBoundSql(parameter); //獲取配置信息 Configuration configuration = mappedStatement.getConfiguration(); Object returnValue = null; log.debug("/*---------------java:" + sqlId + "[begin]---------------*/"); //通過配置信息和BoundSql對象來生成帶值得sql語句 String sql = geneSql(configuration, boundSql); //打印sql語句 log.info("==> mysql : " + sql); //先記錄執(zhí)行sql語句前的時間 long start = System.currentTimeMillis(); try { //開始執(zhí)行sql語句 returnValue = invocation.proceed(); } catch (InvocationTargetException | IllegalAccessException e) { e.printStackTrace(); } //記錄執(zhí)行sql語句后的時間 long end = System.currentTimeMillis(); //得到執(zhí)行sql語句的用了多長時間 long time = (end - start); //以毫秒為單位打印 log.debug("<== sql執(zhí)行歷時:" + time + "毫秒"); //返回值,如果是多條記錄,那么此對象是一個list,如果是一個bean對象,那么此處就是一個對象,也有可能是一個map return returnValue; } /** * 如果是字符串對象則加上單引號返回,如果是日期則也需要轉(zhuǎn)換成字符串形式,如果是其他則直接轉(zhuǎn)換成字符串返回。 * * @param obj * @return */ private static String getParameterValue(Object obj) { String value; if (obj instanceof String) { value = "'" + obj.toString() + "'"; } else if (obj instanceof Date) { DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA); value = "'" + formatter.format(obj) + "'"; } else { if (obj != null) { value = obj.toString(); } else { value = ""; } } return value; } /** * 生成對應的帶有值得sql語句 * * @param configuration * @param boundSql * @return */ public static String geneSql(Configuration configuration, BoundSql boundSql) { Object parameterObject = boundSql.getParameterObject();//獲得參數(shù)對象,如{id:1,name:"user1",param1:1,param2:"user1"} List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();//獲得映射的對象參數(shù) String sql = boundSql.getSql().replaceAll("[\\s]+", " ");//獲得帶問號的sql語句 if (parameterMappings.size() > 0 && parameterObject != null) {//如果參數(shù)個數(shù)大于0且參數(shù)對象不為空,說明該sql語句是帶有條件的 TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {//檢查該參數(shù)是否是一個參數(shù) //getParameterValue用于返回是否帶有單引號的字符串,如果是字符串則加上單引號 sql = sql.replaceFirst("\\?", getParameterValue(parameterObject));//如果是一個參數(shù)則只替換一次,將問號直接替換成值 } else { MetaObject metaObject = configuration.newMetaObject(parameterObject);//將映射文件的參數(shù)和對應的值返回,比如:id,name以及對應的值。 for (ParameterMapping parameterMapping : parameterMappings) {//遍歷參數(shù),如:id,name等 String propertyName = parameterMapping.getProperty();//獲得屬性名,如id,name等字符串 if (metaObject.hasGetter(propertyName)) {//檢查該屬性是否在metaObject中 Object obj = metaObject.getValue(propertyName);//如果在metaObject中,那么直接獲取對應的值 sql = sql.replaceFirst("\\?", getParameterValue(obj));//然后將問號?替換成對應的值。 } else if (boundSql.hasAdditionalParameter(propertyName)) { Object obj = boundSql.getAdditionalParameter(propertyName); sql = sql.replaceFirst("\\?", getParameterValue(obj)); } } } } return sql;//最后將sql語句返回 } @Override public Object plugin(Object target) { return Plugin.wrap(target, this); } @Override public void setProperties(Properties properties) { //properties可以通過 System.out.println(properties); } }
此攔截寫好之后還需要springboot使用,如果是通過@Component掃描是無法正常注入到IOC容器中的,因此需要通過@Configuration和@Bean的方式進行,新建一個配置BatisPlusConfig類,代碼如下
@Configuration public class BatisPlusConfig { @Bean public String myInterceptor(SqlSessionFactory sqlSessionFactory) { //實例化插件 SqlLoggerInterceptor sqlInterceptor = new SqlLoggerInterceptor(); //創(chuàng)建屬性值 Properties properties = new Properties(); properties.setProperty("prop1", "value1"); //將屬性值設置到插件中 sqlInterceptor.setProperties(properties); //將插件添加到SqlSessionFactory工廠 sqlSessionFactory.getConfiguration().addInterceptor(sqlInterceptor); return "interceptor"; } }
總結
OK啦~以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
詳解OpenAPI開發(fā)如何動態(tài)的添加接口實現(xiàn)
這篇文章主要為大家介紹了OpenAPI開發(fā)如何動態(tài)的添加接口實現(xiàn)詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-04-04Springboot項目中如何讓非Spring管理的類獲得一個注入的Bean
這篇文章主要介紹了Springboot項目中如何讓非Spring管理的類獲得一個注入的Bean問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-12-12idea創(chuàng)建包含多個springboot module的maven project的方法
這篇文章主要介紹了idea創(chuàng)建包含多個springboot module的maven project的方法,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-09-09springboot如何設置請求參數(shù)長度和文件大小限制
這篇文章主要介紹了springboot如何設置請求參數(shù)長度和文件大小限制,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-09-09淺談Hibernate中的三種數(shù)據(jù)狀態(tài)(臨時、持久、游離)
下面小編就為大家?guī)硪黄獪\談Hibernate中的三種數(shù)據(jù)狀態(tài)(臨時、持久、游離)。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-09-09