Mybatis Interceptor 拦截器的实现
Mybatis采用责任链模式,通过动态代理组织多个拦截器(插件),通过这些拦截器可以改变Mybatis的默认行为(诸如SQL重写之类的),由于插件会深入到Mybatis的核心,因此在编写自己的插件前最好了解下它的原理,以便写出安全高效的插件。
拦截器(Interceptor)在Mybatis中被当做插件(plugin)对待,官方文档提供了Executor,ParameterHandler,ResultSetHandler,StatementHandler共4种,并且提示“这些类中方法的细节可以通过查看每个方法的签名来发现,或者直接查看MyBatis发行包中的源代码”。
拦截器的使用场景主要是更新数据库的通用字段,分库分表,加解密等的处理。
1.Interceptor
拦截器均需要实现该org.apache.ibatis.plugin.Interceptor接口。
2.Intercepts拦截器
@Intercepts({ @Signature(type=Executor.class,method="update",args={MappedStatement.class,Object.class}) })
拦截器的使用需要查看每一个type所提供的方法参数。
Signature对应Invocation构造器,type为Invocation.Object,method为Invocation.Method,args为Invocation.Object[]。
method对应的update包括了最常用的insert/update/delete三种操作,因此update本身无法直接判断sql为何种执行过程。
args包含了其余所有的操作信息,按数组进行存储,不同的拦截方式有不同的参数顺序,具体看type接口的方法签名,然后根据签名解析。
3.Object对象类型
args参数列表中,Object.class是特殊的对象类型。如果有数据库统一的实体Entity类,即包含表公共字段,比如创建、更新操作对象和时间的基类等,在编写代码时尽量依据该对象来操作,会简单很多。该对象的判断使用
Objectparameter=invocation.getArgs()[1]; if(parameterinstanceofBaseEntity){ BaseEntityentity=(BaseEntity)parameter; }
即可,根据语句执行类型选择对应字段的赋值。
如果参数不是实体,而且具体的参数,那么Mybatis也做了一些处理,比如@Param("name")Stringname类型的参数,会被包装成Map接口的实现来处理,即使是原始的Map也是如此。使用
Objectparameter=invocation.getArgs()[1]; if(parameterinstanceofMap){ Mapmap=(Map)parameter; }
即可,对具体统一的参数进行赋值。
4.SqlCommandType命令类型
Executor提供的方法中,update包含了新增,修改和删除类型,无法直接区分,需要借助MappedStatement类的属性SqlCommandType来进行判断,该类包含了所有的操作类型
publicenumSqlCommandType{ UNKNOWN,INSERT,UPDATE,DELETE,SELECT,FLUSH; }
毕竟新增和修改的场景,有些参数是有区别的,比如创建时间和更新时间,update时是无需兼顾创建时间字段的。
MappedStatementms=(MappedStatement)invocation.getArgs()[0]; SqlCommandTypecommandType=ms.getSqlCommandType();
5.实例
自己编写的小项目中,需要统一给数据库字段属性赋值:
publicclassBaseEntity{ privateintid; privateintcreator; privateintupdater; privateLongcreateTime; privateLongupdateTime; }
dao操作使用了实体和参数的方式,个人建议还是统一使用实体比较简单,易读。
使用实体:
intadd(BookEntityentity);
使用参数:
intupdate(@Param("id")intid,@Param("url")Stringurl,@Param("description")Stringdescription,@Param("playCount")intplayCount,@Param("creator")intcreator,@Param("updateTime")longupdateTime);
完整的例子:
packagecom.github.zhgxun.talk.common.plugin; importcom.github.zhgxun.talk.common.util.DateUtil; importcom.github.zhgxun.talk.common.util.UserUtil; importcom.github.zhgxun.talk.entity.BaseEntity; importcom.github.zhgxun.talk.entity.UserEntity; importlombok.extern.slf4j.Slf4j; importorg.apache.ibatis.executor.Executor; importorg.apache.ibatis.mapping.MappedStatement; importorg.apache.ibatis.mapping.SqlCommandType; 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.springframework.stereotype.Component; importjava.util.Map; importjava.util.Properties; /** *全局拦截数据库创建和更新 **Signature对应Invocation构造器,type为Invocation.Object,method为Invocation.Method,args为Invocation.Object[] *method对应的update包括了最常用的insert/update/delete三种操作,因此update本身无法直接判断sql为何种执行过程 *args包含了其余多有的操作信息,按数组进行存储,不同的拦截方式有不同的参数顺序,具体看type接口的方法签名,然后根据签名解析,参见官网 * *@linkhttp://www.mybatis.org/mybatis-3/zh/configuration.html#plugins插件 *
*MappedStatement包括了SQL具体操作类型,需要通过该类型判断当前sql执行过程 */ @Component @Intercepts({ @Signature(type=Executor.class,method="update",args={MappedStatement.class,Object.class}) }) @Slf4j publicclassNormalPluginimplementsInterceptor{ @Override @SuppressWarnings("unchecked") publicObjectintercept(Invocationinvocation)throwsThrowable{ //根据签名指定的args顺序获取具体的实现类 //1.获取MappedStatement实例,并获取当前SQL命令类型 MappedStatementms=(MappedStatement)invocation.getArgs()[0]; SqlCommandTypecommandType=ms.getSqlCommandType(); //2.获取当前正在被操作的类,有可能是JavaBean,也可能是普通的操作对象,比如普通的参数传递 //普通参数,即是@Param包装或者原始Map对象,普通参数会被Mybatis包装成Map对象 //即是org.apache.ibatis.binding.MapperMethod$ParamMap Objectparameter=invocation.getArgs()[1]; //获取拦截器指定的方法类型,通常需要拦截update StringmethodName=invocation.getMethod().getName(); log.info("NormalPlugin,methodName;{},commandType:{}",methodName,commandType); //3.获取当前用户信息 UserEntityuserEntity=UserUtil.getCurrentUser(); //默认测试参数值 intcreator=2,updater=3; if(parameterinstanceofBaseEntity){ //4.实体类 BaseEntityentity=(BaseEntity)parameter; if(userEntity!=null){ creator=entity.getCreator(); updater=entity.getUpdater(); } if(methodName.equals("update")){ if(commandType.equals(SqlCommandType.INSERT)){ entity.setCreator(creator); entity.setUpdater(updater); entity.setCreateTime(DateUtil.getTimeStamp()); entity.setUpdateTime(DateUtil.getTimeStamp()); }elseif(commandType.equals(SqlCommandType.UPDATE)){ entity.setUpdater(updater); entity.setUpdateTime(DateUtil.getTimeStamp()); } } }elseif(parameterinstanceofMap){ //5.@Param等包装类 //更新时指定某些字段的最新数据值 if(commandType.equals(SqlCommandType.UPDATE)){ //遍历参数类型,检查目标参数值是否存在对象中,该方式需要应用编写有一些统一的规范 //否则均统一为实体对象,就免去该重复操作 Mapmap=(Map)parameter; if(map.containsKey("creator")){ map.put("creator",creator); } if(map.containsKey("updateTime")){ map.put("updateTime",DateUtil.getTimeStamp()); } } } //6.均不是需要被拦截的类型,不做操作 returninvocation.proceed(); } @Override publicObjectplugin(Objecttarget){ returnPlugin.wrap(target,this); } @Override publicvoidsetProperties(Propertiesproperties){ } }
6.感受
其它几种类型,后面在看,尤其是分页。
在编写代码的过程中,有时候还是需要先知道对象的类型,比如Object.class跟Interface一样,很多时候仅仅代表一种数据类型,需要明确知道后再进行操作。
@Param标识的参数其实会被Mybatis封装成org.apache.ibatis.binding.MapperMethod$ParamMap类型,一开始我就是使用
for(Fieldfield:parameter.getClass().getDeclaredFields()){ }
的方式获取,以为这些都是对象的属性,通过反射获取并修改即可,实际上发现对象不存在这些属性,但是打印出的信息中,明确有这些字段的,网上参考一些信息后,才知道这是一个Map类型,问题才迎刃而解。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。