mybatis 通过拦截器打印完整的sql语句以及执行结果操作
开发过程中，如果使用mybatis做为ORM框架，经常需要打印出完整的sql语句以及执行的结果做为参考。
虽然mybatis结合日志框架可以做到，但打印出来的通常都是sql和参数分开的。
有时我们需要调试这条sql的时候，就需要把参数填进去，这样未免有些浪费时间。
此时我们可以通过实现mybatis拦截器来做到打印带参数的完整的sql，以及结果通过json输出到控制台。
直接看代码和使用方法吧：
MyBatis拦截器打印不带问号的完整sql语句拦截器
importjava.text.DateFormat;
importjava.util.Date;
importjava.util.List;
importjava.util.Locale;
importjava.util.Properties;
importjava.util.regex.Matcher;
importorg.apache.commons.collections.CollectionUtils;
importorg.apache.ibatis.executor.Executor;
importorg.apache.ibatis.mapping.BoundSql;
importorg.apache.ibatis.mapping.MappedStatement;
importorg.apache.ibatis.mapping.ParameterMapping;
importorg.apache.ibatis.plugin.*;
importorg.apache.ibatis.reflection.MetaObject;
importorg.apache.ibatis.session.Configuration;
importorg.apache.ibatis.session.ResultHandler;
importorg.apache.ibatis.session.RowBounds;
importorg.apache.ibatis.type.TypeHandlerRegistry;
/**
*MyBatis拦截器打印不带问号的完整sql语句
*
*@authorgogym
*@version2018年8月13日
*@seeMybatisInterceptor
*@since
*/
@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})})
@SuppressWarnings({"unchecked","rawtypes"})
publicclassMybatisInterceptorimplementsInterceptor
{
@Override
publicObjectintercept(Invocationinvocation)
throwsThrowable
{
try
{
//获取xml中的一个select/update/insert/delete节点，是一条SQL语句
MappedStatementmappedStatement=(MappedStatement)invocation.getArgs()[0];
Objectparameter=null;
//获取参数，if语句成立，表示sql语句有参数，参数格式是map形式
if(invocation.getArgs().length>1)
{
parameter=invocation.getArgs()[1];
System.out.println("parameter="+parameter);
}
StringsqlId=mappedStatement.getId();//获取到节点的id,即sql语句的id
System.out.println("sqlId="+sqlId);
BoundSqlboundSql=mappedStatement.getBoundSql(parameter);//BoundSql就是封装myBatis最终产生的sql类
Configurationconfiguration=mappedStatement.getConfiguration();//获取节点的配置
Stringsql=getSql(configuration,boundSql,sqlId);//获取到最终的sql语句
System.out.println("sql="+sql);
}
catch(Exceptione)
{
e.printStackTrace();
}
//执行完上面的任务后，不改变原有的sql执行过程
returninvocation.proceed();
}
//封装了一下sql语句，使得结果返回完整xml路径下的sql语句节点id+sql语句
publicstaticStringgetSql(Configurationconfiguration,BoundSqlboundSql,StringsqlId)
{
Stringsql=showSql(configuration,boundSql);
StringBuilderstr=newStringBuilder(100);
str.append(sqlId);
str.append(":");
str.append(sql);
returnstr.toString();
}
//如果参数是String，则添加单引号，如果是日期，则转换为时间格式器并加单引号；对参数是null和不是null的情况作了处理
privatestaticStringgetParameterValue(Objectobj)
{
Stringvalue=null;
if(objinstanceofString)
{
value="'"+obj.toString()+"'";
}
elseif(objinstanceofDate)
{
DateFormatformatter=DateFormat.getDateTimeInstance(DateFormat.DEFAULT,
DateFormat.DEFAULT,Locale.CHINA);
value="'"+formatter.format(newDate())+"'";
}
else
{
if(obj!=null)
{
value=obj.toString();
}
else
{
value="";
}
}
returnvalue;
}
//进行？的替换
publicstaticStringshowSql(Configurationconfiguration,BoundSqlboundSql)
{
//获取参数
ObjectparameterObject=boundSql.getParameterObject();
ListparameterMappings=boundSql.getParameterMappings();
//sql语句中多个空格都用一个空格代替
Stringsql=boundSql.getSql().replaceAll("[\\s]+","");
if(CollectionUtils.isNotEmpty(parameterMappings)&¶meterObject!=null)
{
//获取类型处理器注册器，类型处理器的功能是进行java类型和数据库类型的转换
TypeHandlerRegistrytypeHandlerRegistry=configuration.getTypeHandlerRegistry();
//如果根据parameterObject.getClass(）可以找到对应的类型，则替换
if(typeHandlerRegistry.hasTypeHandler(parameterObject.getClass()))
{
sql=sql.replaceFirst("\\?",
Matcher.quoteReplacement(getParameterValue(parameterObject)));
}
else
{
//MetaObject主要是封装了originalObject对象，提供了get和set的方法用于获取和设置originalObject的属性值,主要支持对JavaBean、Collection、Map三种类型对象的操作
MetaObjectmetaObject=configuration.newMetaObject(parameterObject);
for(ParameterMappingparameterMapping:parameterMappings)
{
StringpropertyName=parameterMapping.getProperty();
if(metaObject.hasGetter(propertyName))
{
Objectobj=metaObject.getValue(propertyName);
sql=sql.replaceFirst("\\?",
Matcher.quoteReplacement(getParameterValue(obj)));
}
elseif(boundSql.hasAdditionalParameter(propertyName))
{
//该分支是动态sql
Objectobj=boundSql.getAdditionalParameter(propertyName);
sql=sql.replaceFirst("\\?",
Matcher.quoteReplacement(getParameterValue(obj)));
}
else
{
//打印出缺失，提醒该参数缺失并防止错位
sql=sql.replaceFirst("\\?","缺失");
}
}
}
}
returnsql;
}
@Override
publicObjectplugin(Objecttarget)
{
returnPlugin.wrap(target,this);
}
@Override
publicvoidsetProperties(Propertiesproperties)
{
}
}
打印结果拦截器：
importjava.util.Properties;
importorg.apache.ibatis.executor.Executor;
importorg.apache.ibatis.mapping.MappedStatement;
importorg.apache.ibatis.plugin.Interceptor;
importorg.apache.ibatis.plugin.Intercepts;
importorg.apache.ibatis.plugin.Invocation;
importorg.apache.ibatis.plugin.Plugin;
importorg.apache.ibatis.plugin.Signature;
importorg.apache.ibatis.session.ResultHandler;
importorg.apache.ibatis.session.RowBounds;
importcom.poly.rbl.utils.FastJsonUtils;
/**
*打印结果拦截器〈功能详细描述〉
*
*@authorgogym
*@version2019年4月2日
*@seeInterceptorForQry
*@since
*/
@Intercepts({@Signature(type=Executor.class,method="query",args={MappedStatement.class,
Object.class,RowBounds.class,ResultHandler.class})})
publicclassInterceptorForQryimplementsInterceptor
{
@SuppressWarnings({"rawtypes","unchecked"})
publicObjectintercept(Invocationinvocation)
throwsThrowable
{
Objectresult=invocation.proceed();//执行请求方法，并将所得结果保存到result中
Stringstr=FastJsonUtils.toJSONString(result);
System.out.println(str);
returnresult;
}
publicObjectplugin(Objecttarget)
{
returnPlugin.wrap(target,this);
}
publicvoidsetProperties(Propertiesarg0)
{}
}
用法直接配置在mybatis配置文件里面即可：
热门推荐