Mybatis的sql語句執(zhí)行異常后打印到日志問題
Mybatis的sql語句執(zhí)行異常后打印到日志
最近做的一個(gè)運(yùn)維提的需求。希望插入和更新的sql語句時(shí),如果執(zhí)行失敗,能打印到一個(gè)專門的日志文件里。他可以用來恢復(fù)數(shù)據(jù)庫里的數(shù)據(jù)。
在網(wǎng)上調(diào)研了下可以實(shí)現(xiàn)這個(gè)功能的方案:
1、可以通過Mybatis攔截器可以獲取到執(zhí)行的sql語句
2、由于我們的數(shù)據(jù)庫都是異步寫的,所以會(huì)存在多線程的問題,如果用一個(gè)變量存,可能會(huì)出現(xiàn)這條sql還沒讀出來就被別的線程的sql語句覆蓋的問題,線程不安全。所以考慮用ThreadLocal存Mybatis攔截器的sql語句。
3、在異常的catch代碼段里,將ThreadLocal存的sql語句取出,打印到單獨(dú)的日志文件里。
具體實(shí)現(xiàn)代碼
Mybatis攔截器(只攔截插入更新操作,拼接sql后塞入ThreadLocal):
/** * Mybatis攔截器,用于拼接sql語句 * * @author lightonyang * @date 2022/10/27 */ @Intercepts({ @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}), }) public class MybatisInterceptor implements Interceptor { // 如果參數(shù)是String,則添加單引號(hào), 如果是日期,則轉(zhuǎn)換為時(shí)間格式器并加單引號(hào); 對(duì)參數(shù)是null和不是null的情況作了處理 private static String getParameterValue(Object obj) { String value = null; 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(new Date()) + "'"; } else { if (obj != null) { value = obj.toString(); } else { value = "null" ; } } return value; } // 進(jìn)行?的替換 public static String showSql(Configuration configuration, BoundSql boundSql) { // 獲取參數(shù) Object parameterObject = boundSql.getParameterObject(); List<ParameterMapping> parameterMappings = boundSql.getParameterMappings(); // sql語句中多個(gè)空格都用一個(gè)空格代替 String sql = boundSql.getSql().replaceAll("[\\s]+", " "); if (CollectionUtils.isNotEmpty(parameterMappings) && parameterObject != null) { // 獲取類型處理器注冊(cè)器,類型處理器的功能是進(jìn)行java類型和數(shù)據(jù)庫類型的轉(zhuǎn)換 TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); // 如果根據(jù)parameterObject.getClass()可以找到對(duì)應(yīng)的類型,則替換 if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) { sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject))); } else { // MetaObject主要是封裝了originalObject對(duì)象,提供了get和set的方法用于獲取和設(shè)置originalObject的屬性值,主要支持對(duì)JavaBean、Collection、Map三種類型對(duì)象的操作 MetaObject metaObject = configuration.newMetaObject(parameterObject); for (ParameterMapping parameterMapping : parameterMappings) { String propertyName = parameterMapping.getProperty(); if (metaObject.hasGetter(propertyName)) { Object obj = metaObject.getValue(propertyName); sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj))); } else if (boundSql.hasAdditionalParameter(propertyName)) { // 該分支是動(dòng)態(tài)sql Object obj = boundSql.getAdditionalParameter(propertyName); sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj))); } else { // 打印出缺失,提醒該參數(shù)缺失并防止錯(cuò)位 sql = sql.replaceFirst("\\?", "缺失"); } } } } return sql; } @Override public Object intercept(Invocation invocation) throws Throwable { try { // 獲取xml中的一個(gè)select/update/insert/delete節(jié)點(diǎn),是一條SQL語句 MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0]; Object parameter = null; // 獲取參數(shù),if語句成立,表示sql語句有參數(shù),參數(shù)格式是map形式 if (invocation.getArgs().length > 1) { parameter = invocation.getArgs()[1]; System.out.println("parameter = " + parameter); } String sqlId = mappedStatement.getId(); // 獲取到節(jié)點(diǎn)的id,即sql語句的id System.out.println("sqlId = " + sqlId); BoundSql boundSql = mappedStatement.getBoundSql(parameter); // BoundSql就是封裝myBatis最終產(chǎn)生的sql類 Configuration configuration = mappedStatement.getConfiguration(); // 獲取節(jié)點(diǎn)的配置 String sql = showSql(configuration, boundSql); // 獲取到最終的sql語句 TheadLocalUtil.instance().sql(sql); System.out.println("sql = " + sql); } catch (Exception e) { e.printStackTrace(); } // 執(zhí)行完上面的任務(wù)后,不改變?cè)械膕ql執(zhí)行過程 return invocation.proceed(); } }
將Mybatis攔截器加入配置:
@Configuration public class SqlMonitorConfiguration { @Autowired SqlSessionFactory sqlSessionFactory; @Bean @DependsOn("sqlSessionFactory") public MybatisInterceptor mybatisInterceptor() { MybatisInterceptor mybatisInterceptor = new MybatisInterceptor(); sqlSessionFactory.getConfiguration().addInterceptor(mybatisInterceptor); return mybatisInterceptor; } }
ThreadLocalUtil:
/** * 由于運(yùn)維需求,數(shù)據(jù)庫異常后輸出sql語句,引入TheadLocal * 用于異步多線程寫數(shù)據(jù)庫時(shí),存sql語句,保持線程安全 * <p> * 用完要記得finally里reset,防止內(nèi)存泄漏 * * @author lightonyang * @date 2022/10/31 */ public class TheadLocalUtil { private static final ThreadLocal<TheadLocalUtil> LOCAL = ThreadLocal.withInitial(TheadLocalUtil::new); private String sql; private TheadLocalUtil() { } public static TheadLocalUtil instance() { return LOCAL.get(); } public TheadLocalUtil reset() { sql = null; LOCAL.remove(); return this; } /*用于鏈?zhǔn)教砑?/ public TheadLocalUtil sql(String sql) { this.sql = sql; return this; } public String getSql() { return sql; } public void setSql(String sql) { this.sql = sql; } }
日志配置(將異常日志打印到單獨(dú)的日志文件mysqlfail.log里):
<Appenders> <RollingFile name="mysqlFailFixedTimeFileAppender" fileName="${sys:mumble.log.home}/idap-idasc-mysqlfail.log" filePattern="${sys:mumble.log.home}/idap-idasc-mysqlfail.log.%d{yyyy-MM-dd_HH}-%i.log"> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p %c{1}(%F:%L) - %m%n"/> <Policies> <TimeBasedTriggeringPolicy/> <SizeBasedTriggeringPolicy size="200 MB"/> </Policies> <DefaultRolloverStrategy max="24"/> </RollingFile> </Appenders> <Loggers> <AsyncLogger name="mysqlFail" level="info" additivity="false" includeLocation="true"> <AppenderRef ref="mysqlFailFixedTimeFileAppender"/> </AsyncLogger> </Loggers>
日志使用(在操作數(shù)據(jù)的Impl中catch異常,從ThreadLocal中拿出sql語句打印日志):
private static final Logger MYSQL_FAIL_LOG = LoggerFactory.getLogger("mysqlFail"); try{ ··· }catch{ MYSQL_FAIL_LOG.info(TheadLocalUtil.instance().getSql(sql);); }finally{ TheadLocalUtil.reset(); }
這種實(shí)現(xiàn)方法也經(jīng)過了測(cè)試的壓測(cè),沒有出現(xiàn)多線程下的sql語句覆蓋的問題,也沒有出現(xiàn)內(nèi)存泄漏和性能問題,滿足了需求的使用。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
SpringMVC實(shí)現(xiàn)controller中獲取session的實(shí)例代碼
本篇文章主要介紹了SpringMVC實(shí)現(xiàn)controller中獲取session的實(shí)例代碼,具有一定的參考價(jià)值,有興趣的可以了解一下。2017-02-02SpringBoot條件注解@Conditional詳細(xì)解析
這篇文章主要介紹了SpringBoot條件注解@Conditional詳細(xì)解析,@Conditional是Spring4.0提供的一個(gè)用于條件裝配的注解,其定義了一個(gè)Condition的數(shù)組,只有當(dāng)數(shù)組所有的條件都滿足的時(shí)候,組件才會(huì)被導(dǎo)入容器,需要的朋友可以參考下2023-11-11springboot實(shí)現(xiàn)小程序支付的項(xiàng)目實(shí)踐
本文主要介紹了springboot實(shí)現(xiàn)小程序支付的項(xiàng)目實(shí)踐,?可以通過調(diào)用微信支付?API?實(shí)現(xiàn)支付功能,具有一定的參考價(jià)值,感興趣的可以了解一下2023-09-09Spring中的底層架構(gòu)核心概念類型轉(zhuǎn)換器詳解
這篇文章主要介紹了Spring中的底層架構(gòu)核心概念類型轉(zhuǎn)換器詳解,本文結(jié)合示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-12-12Java導(dǎo)出oracle表結(jié)構(gòu)實(shí)例詳解
這篇文章主要介紹了 Java導(dǎo)出oracle表結(jié)構(gòu)實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下2017-03-03Java使用線程池批量處理數(shù)據(jù)操作具體流程
這篇文章主要給大家介紹了關(guān)于Java使用線程池批量處理數(shù)據(jù)操作的相關(guān)資料,Java多線程編程中線程池是一個(gè)非常重要的概念,線程池可以提高線程的復(fù)用率和任務(wù)調(diào)度的效率,尤其是當(dāng)需要查詢大批量數(shù)據(jù)時(shí),需要的朋友可以參考下2023-06-06