Mybatis的sql語句執(zhí)行異常后打印到日志問題
Mybatis的sql語句執(zhí)行異常后打印到日志
最近做的一個運維提的需求。希望插入和更新的sql語句時,如果執(zhí)行失敗,能打印到一個專門的日志文件里。他可以用來恢復(fù)數(shù)據(jù)庫里的數(shù)據(jù)。
在網(wǎng)上調(diào)研了下可以實現(xiàn)這個功能的方案:
1、可以通過Mybatis攔截器可以獲取到執(zhí)行的sql語句
2、由于我們的數(shù)據(jù)庫都是異步寫的,所以會存在多線程的問題,如果用一個變量存,可能會出現(xiàn)這條sql還沒讀出來就被別的線程的sql語句覆蓋的問題,線程不安全。所以考慮用ThreadLocal存Mybatis攔截器的sql語句。
3、在異常的catch代碼段里,將ThreadLocal存的sql語句取出,打印到單獨的日志文件里。
具體實現(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,則添加單引號, 如果是日期,則轉(zhuǎn)換為時間格式器并加單引號; 對參數(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語句中多個空格都用一個空格代替
String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
if (CollectionUtils.isNotEmpty(parameterMappings) && parameterObject != null) {
// 獲取類型處理器注冊器,類型處理器的功能是進(jìn)行java類型和數(shù)據(jù)庫類型的轉(zhuǎn)換
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
// 如果根據(jù)parameterObject.getClass()可以找到對應(yīng)的類型,則替換
if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
sql = sql.replaceFirst("\\?",
Matcher.quoteReplacement(getParameterValue(parameterObject)));
} else {
// MetaObject主要是封裝了originalObject對象,提供了get和set的方法用于獲取和設(shè)置originalObject的屬性值,主要支持對JavaBean、Collection、Map三種類型對象的操作
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)) {
// 該分支是動態(tài)sql
Object obj = boundSql.getAdditionalParameter(propertyName);
sql = sql.replaceFirst("\\?",
Matcher.quoteReplacement(getParameterValue(obj)));
} else {
// 打印出缺失,提醒該參數(shù)缺失并防止錯位
sql = sql.replaceFirst("\\?", "缺失");
}
}
}
}
return sql;
}
@Override
public Object intercept(Invocation invocation) throws Throwable {
try {
// 獲取xml中的一個select/update/insert/delete節(jié)點,是一條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é)點的id,即sql語句的id
System.out.println("sqlId = " + sqlId);
BoundSql boundSql = mappedStatement.getBoundSql(parameter); // BoundSql就是封裝myBatis最終產(chǎn)生的sql類
Configuration configuration = mappedStatement.getConfiguration(); // 獲取節(jié)點的配置
String sql = showSql(configuration, boundSql); // 獲取到最終的sql語句
TheadLocalUtil.instance().sql(sql);
System.out.println("sql = " + sql);
} catch (Exception e) {
e.printStackTrace();
}
// 執(zhí)行完上面的任務(wù)后,不改變原有的sql執(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:
/**
* 由于運維需求,數(shù)據(jù)庫異常后輸出sql語句,引入TheadLocal
* 用于異步多線程寫數(shù)據(jù)庫時,存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;
}
}
日志配置(將異常日志打印到單獨的日志文件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();
}這種實現(xiàn)方法也經(jīng)過了測試的壓測,沒有出現(xiàn)多線程下的sql語句覆蓋的問題,也沒有出現(xiàn)內(nèi)存泄漏和性能問題,滿足了需求的使用。
總結(jié)
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Mybatis映射文件之常用標(biāo)簽及特殊字符的處理方法
這篇文章主要介紹了Mybatis映射文件常用標(biāo)簽及特殊字符的處理,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-05-05
Springboot JPA 枚舉Enum類型存入到數(shù)據(jù)庫的操作
這篇文章主要介紹了Springboot JPA 枚舉Enum類型存入到數(shù)據(jù)庫的操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2021-01-01
JAVA 文件監(jiān)控 WatchService的示例方法
本篇文章主要介紹了JAVA 文件監(jiān)控 WatchService的示例方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-10-10
Spring Cloud微服務(wù)之間調(diào)用Dubbo的詳細(xì)過程
SpringCloudAlibabaDubbo是阿里巴巴開源的Dubbo與SpringCloud的深度集成方案,本文介紹Spring Cloud微服務(wù)之間調(diào)用Dubbo的詳細(xì)過程,感興趣的朋友跟隨小編一起看看吧2026-02-02
Spring Boot + Mybatis多數(shù)據(jù)源和動態(tài)數(shù)據(jù)源配置方法
最近做項目遇到這樣的應(yīng)用場景,項目需要同時連接兩個不同的數(shù)據(jù)庫A, B,并且它們都為主從架構(gòu),一臺寫庫,多臺讀庫。下面小編給大家?guī)砹薙pring Boot + Mybatis多數(shù)據(jù)源和動態(tài)數(shù)據(jù)源配置方法,需要的朋友參考下吧2018-01-01
一文總結(jié)Java實現(xiàn)TXT轉(zhuǎn)PDF的三種高效方案
將 TXT 文本轉(zhuǎn)換為 PDF 并不繁瑣,本篇指南將介紹根據(jù)三種實用的轉(zhuǎn)換技巧,包括手動操作、在線工具和程序化自動處理,助你輕松搞定文檔遷移,希望對大家有所幫助2026-02-02
SpringCloud如何使用Eureka實現(xiàn)服務(wù)之間的傳遞數(shù)據(jù)
這篇文章主要介紹了SpringCloud使用Eureka實現(xiàn)服務(wù)之間的傳遞數(shù)據(jù)操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06
使用String類型小數(shù)值轉(zhuǎn)換為Long類型
這篇文章主要介紹了使用String類型小數(shù)值轉(zhuǎn)換為Long類型操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09

