微客导航 » 文章资讯 » 详解MyBatis自定义Plugin插件

详解MyBatis自定义Plugin插件

2023-09-12 01:38:04 156

作用

官方说明：

MyBatis允许你在已映射语句执行过程中的某一点进行拦截调用。

什么意思呢？就是你可以对执行某些方法之前进行拦截，做自己的一些操作，如：

1.记录所有执行的SQL（通过对MyBatisorg.apache.ibatis.executor.statement.StatementHandler中的prepare方法进行拦截）

2.修改SQL（org.apache.ibatis.executor.Executor中query方法进行拦截）等。

但拦截的方法调用有限制，MyBatis允许使用插件来拦截的方法调用包括：

Executor(update,query,flushStatements,commit,rollback,getTransaction,close,isClosed)
ParameterHandler(getParameterObject,setParameters)
ResultSetHandler(handleResultSets,handleOutputParameters)
StatementHandler(prepare,parameterize,batch,update,query)

实现

使用插件是非常简单的，只需实现Interceptor接口，并指定想要拦截的方法签名即可。

//ExamplePlugin.java
@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})})//对应的参数Class,也可从源码中查看
publicclassExamplePluginimplementsInterceptor{
publicObjectintercept(Invocationinvocation)throwsThrowable{
Object[]queryArgs=invocation.getArgs();
MappedStatementmappedStatement=(MappedStatement)queryArgs[0];
Objectparameter=queryArgs[1];
BoundSqlboundSql=mappedStatement.getBoundSql(parameter);
Stringsql=boundSql.getSql();//获取到SQL，可以进行调整
Stringname=invocation.getMethod().getName();
queryArgs[1]=2;//可以修改参数内容
System.err.println("拦截的方法名是："+name);
returninvocation.proceed();
}
publicObjectplugin(Objecttarget){
returnPlugin.wrap(target,this);
}
publicvoidsetProperties(Propertiesproperties){
}
}

在配置文件中注册插件

当我们调用query方法时，匹配拦截器的方法，所以会执行拦截器下intercept方法，做自己的处理。

参考资料，官网

http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins

总结

以上所述是小编给大家介绍的MyBatis自定义Plugin插件，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持！

返回顶部
3162201930
czq8825@qq.com

详解MyBatis自定义Plugin插件

热门推荐

随机推荐