MyBatis允许在映射语句执行的某些点拦截方法调用。默认情况下,MyBatis允许插件拦截以下方法调用:
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
这些类方法的详细信息可以通过查看每个方法的完整签名以及每个MyBatis版本附带的源代码来了解。在重写方法时,你应该理解所覆盖方法的行为,假设你不仅仅是在监视调用。如果你试图修改或覆盖给定方法的行为,很可能会破坏MyBatis的核心功能。这些是低级别的类和方法,因此在使用插件时需要谨慎。
使用插件非常简单,因为它们提供了很大的功能。只需实现Interceptor接口,确保指定要拦截的方法签名即可。
// ExamplePlugin.java
@Intercepts({@Signature(
type= Executor.class,
method = "update",
args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
private Properties properties = new Properties();
@Override
public Object intercept(Invocation invocation) throws Throwable {
// implement pre-processing if needed
Object returnObject = invocation.proceed();
// implement post-processing if needed
return returnObject;
}
@Override
public void setProperties(Properties properties) {
this.properties = properties;
}
}
<!-- mybatis-config.xml -->
<plugins>
<plugin interceptor="org.mybatis.example.ExamplePlugin">
<property name="someProperty" value="100"/>
</plugin>
</plugins>
以上插件将拦截Executor实例上所有对"update"方法的调用,Executor是负责执行映射语句的内部对象。
请注意覆盖Configuration类
除了使用插件修改核心的MyBatis行为之外,您还可以完全覆盖Configuration类。只需继承它并重写其中的任何方法,并将其传递给调用SqlSessionFactoryBuilder.build(myConfig)方法的参数中。但同样需要注意,这可能严重影响MyBatis的行为,所以请谨慎使用。