com.github.yizzuide.milkomeda.halo.HaloInterceptor Maven / Gradle / Ivy
/*
* Copyright (c) 2021 yizzuide All rights Reserved.
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.github.yizzuide.milkomeda.halo;
import com.github.yizzuide.milkomeda.universe.metadata.HandlerMetaData;
import com.github.yizzuide.milkomeda.util.MybatisUtil;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apache.ibatis.binding.MapperMethod;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.defaults.DefaultSqlSession;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.CollectionUtils;
import java.lang.reflect.Method;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.*;
import java.util.regex.Pattern;
/**
* HaloInterceptor
* 拦截器插件
*
* @author yizzuide
* @since 2.5.0
* @version 3.11.4
*
* Create at 2020/01/30 20:38
*/
@Slf4j
@Intercepts({
@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}),
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class})
})
public class HaloInterceptor implements Interceptor {
private static final Pattern WHITE_SPACE_BLOCK_PATTERN = Pattern.compile("([\\s]{2,}|[\\t\\r\\n])");
@Autowired
private HaloProperties props;
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object[] args = invocation.getArgs();
// 获取第一个参数，MappedStatement
MappedStatement mappedStatement = (MappedStatement) args[0];
// 获取第二个参数，该参数类型根据Mapper方法的参数决定，如果是一个参数，则为实体或简单数据类型；如果是多个参数，则为Map。
Object param = args.length > 1 ? args[1] : null;
BoundSql boundSql = mappedStatement.getSqlSource().getBoundSql(param);
String sql = WHITE_SPACE_BLOCK_PATTERN.matcher(boundSql.getSql()).replaceAll(" ");
if (!props.isShowSlowLog()) {
return warpIntercept(invocation, mappedStatement, sql, param);
}
long start = System.currentTimeMillis();
Object result = warpIntercept(invocation, mappedStatement, sql, param);
long end = System.currentTimeMillis();
long time = end - start;
if (time > props.getSlowThreshold().toMillis()) {
logSqlInfo(mappedStatement.getConfiguration(), boundSql, sql, mappedStatement.getId(), time);
}
return result;
}
// 打印Sql日志
private void logSqlInfo(Configuration configuration, BoundSql boundSql, String sql, String sqlId, long time) {
// 参数值对象
Object parameterObject = boundSql.getParameterObject();
// 参数名映射列表
List parameterMappings = boundSql.getParameterMappings();
List params = new ArrayList<>();
if (parameterMappings.size() > 0 && parameterObject != null) {
// 类型注册查看 {@link org.apache.ibatis.type.TypeHandlerRegistry.TypeHandlerRegistry(org.apache.ibatis.session.Configuration)}
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
// 当前为简单类型值
if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
params.add(getParameterValue(parameterObject));
} else {
// 当前为复合类型值
MetaObject metaObject = configuration.newMetaObject(parameterObject);
for (ParameterMapping parameterMapping : parameterMappings) {
String propertyName = parameterMapping.getProperty();
// 从对象获取属性值
if (metaObject.hasGetter(propertyName)) {
Object obj = metaObject.getValue(propertyName);
params.add(getParameterValue(obj));
// 内部的转化：configuration.newMetaObject(additionalParameters);
} else if (boundSql.hasAdditionalParameter(propertyName)) {
Object obj = boundSql.getAdditionalParameter(propertyName);
params.add(getParameterValue(obj));
}
}
}
}
log.warn("Halo found slow sql[{}]: {} params:({}), take time: {}ms", sqlId, sql, StringUtils.join(params, ','), time);
}
private String getParameterValue(Object obj) {
String value;
if (obj instanceof String) {
value = "'" + obj + "'";
} else if (obj instanceof Date) {
Instant instant = ((Date) obj).toInstant();
String format = LocalDateTime.ofInstant(instant, ZoneId.systemDefault()).format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
value = "'" + format + "'";
} else {
if (obj != null) {
value = obj.toString();
} else {
value = "";
}
}
return value;
}
@SuppressWarnings({"unchecked", "rawtypes"})
private Object warpIntercept(Invocation invocation, MappedStatement mappedStatement, String sql, Object param) throws Throwable {
// 如果处理器为空，直接返回
if (CollectionUtils.isEmpty(HaloContext.getTableNameMap())) {
return invocation.proceed();
}
String tableName = MybatisUtil.getFirstTableName(sql);
if (StringUtils.isEmpty(tableName)) {
return invocation.proceed();
}
// Mybatis map参数获取不存在时会抛异常，转为普通map
if (param instanceof DefaultSqlSession.StrictMap || param instanceof MapperMethod.ParamMap) {
param = new HashMap((Map) param);
}
// 匹配所有
invokeWithTable(tableName,"*", sql, mappedStatement, param, null, HaloType.PRE);
// 完全匹配
invokeWithTable(tableName, tableName, sql, mappedStatement, param, null, HaloType.PRE);
Object result = invocation.proceed();
// 匹配所有
invokeWithTable(tableName, "*", sql, mappedStatement, param, result, HaloType.POST);
// 完全匹配
invokeWithTable(tableName, tableName, sql, mappedStatement, param, result, HaloType.POST);
return result;
}
@Override
public Object plugin(Object target) {
if (target instanceof Executor) {
// 为当前target创建动态代理
return Plugin.wrap(target, this);
}
return target;
}
private void invokeWithTable(String tableName, String matchTableName, String sql, MappedStatement mappedStatement, Object param, Object result, HaloType type) {
if (!HaloContext.getTableNameMap().containsKey(matchTableName)) {
return;
}
Map> tableNameMap = (type == HaloType.PRE) ?
HaloContext.getPreTableNameMap() : HaloContext.getPostTableNameMap();
List metaDataList = tableNameMap.get(matchTableName);
if (CollectionUtils.isEmpty(metaDataList)) {
return;
}
metaDataList.forEach(handlerMetaData -> invokeHandler(tableName, handlerMetaData, sql, mappedStatement, param, result));
}
private void invokeHandler(String tableName, HandlerMetaData handlerMetaData, String sql, MappedStatement mappedStatement, Object param, Object result) {
try {
// INSERT/UPDATE/DELETE/SELECT
SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
Method method = handlerMetaData.getMethod();
Object target = handlerMetaData.getTarget();
// 获取参数类型
Class[] parameterTypes = method.getParameterTypes();
if (parameterTypes.length == 1 && parameterTypes[0] == HaloMeta.class) {
HaloMeta haloMeta = new HaloMeta(sqlCommandType, tableName, param, result);
method.invoke(target, haloMeta);
} else if (parameterTypes.length > 1) {
// 检测参数是否有SqlCommandType
if (parameterTypes[0] == SqlCommandType.class) {
if (result == null) {
method.invoke(target, sqlCommandType, param);
} else {
method.invoke(target, sqlCommandType, param, result);
}
} else {
if (result == null) {
method.invoke(target, param, sqlCommandType);
} else {
method.invoke(target, param, result, sqlCommandType);
}
}
} else {
method.invoke(target, param);
}
} catch (Exception e) {
log.error("Halo invoke handler [{}] error: {}, with stmt id: {} and sql: {}", handlerMetaData.getTarget(), e.getMessage(), mappedStatement.getId(), sql, e);
}
}
@Override
public void setProperties(Properties properties) {
// 插件注册的属性处理
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy