SpringBoot整合Mybatis自定義攔截器不起作用的處理方案
SpringBoot整合Mybatis自定義攔截器不起作用
Mybatis插件生效的方式:
1. 原始的讀取mybatis-config.xml文件
該方式和Spring無關,是通過反射的形式創建插件對象,此時會執行org.apache.ibatis.plugin.Interceptor#setProperties方法,以讀取配置參數。
mybatis: mapper-locations: classpath*:/mapping/*.xml type-aliases-package: com.tellme.pojo #讀取全局配置的地址 config-location: classpath:mybatis-config.xml
在resource目錄下配置mybatis的全局配置:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <setting name="cacheEnabled" value="true"/> <setting name="lazyLoadingEnabled" value="true"/> <setting name="multipleResultSetsEnabled" value="true"/> <setting name="useColumnLabel" value="true"/> <setting name="mapUnderscoreToCamelCase" value="true"/> <setting name="useGeneratedKeys" value="true"/> <setting name="defaultExecutorType" value="SIMPLE"/> <setting name="defaultStatementTimeout" value="25000"/> </settings> <typeAliases> <typeAlias alias="Integer" type="java.lang.Integer"/> <typeAlias alias="Long" type="java.lang.Long"/> <typeAlias alias="HashMap" type="java.util.HashMap"/> <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap"/> <typeAlias alias="ArrayList" type="java.util.ArrayList"/> <typeAlias alias="LinkedList" type="java.util.LinkedList"/> </typeAliases> <!--配置的插件名--> <plugins> <plugin interceptor="com.xxx.yyy.plugins.PrintSqlInfoInterceptor"/> </plugins> </configuration>
2. 與SpringBoot容器整合
網上很多方案說:mybatis自定義攔截器上加上@Component註解便可以生效。但是我將自定義攔截器放入到Spring容器中,自定義攔截器卻失效瞭。
然後找到瞭springboot配置多數據源後mybatis攔截器失效文章,說是自定義配置瞭數據源導致瞭攔截器失效。
2.1 mybatis的自動裝載
源碼位置:org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
@Configuration @ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class }) @ConditionalOnBean(DataSource.class) @EnableConfigurationProperties(MybatisProperties.class) @AutoConfigureAfter(DataSourceAutoConfiguration.class) public class MybatisAutoConfiguration { private static Log log = LogFactory.getLog(MybatisAutoConfiguration.class); @Autowired private MybatisProperties properties; //會依賴註入Spring容器中所有的mybatis的Interceptor攔截器 @Autowired(required = false) private Interceptor[] interceptors; ... @Bean @ConditionalOnMissingBean public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception { SqlSessionFactoryBean factory = new SqlSessionFactoryBean(); factory.setDataSource(dataSource); factory.setVfs(SpringBootVFS.class); if (StringUtils.hasText(this.properties.getConfigLocation())) { factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation())); } factory.setConfiguration(properties.getConfiguration()); //手動放入到瞭setPlugins方法中。 if (!ObjectUtils.isEmpty(this.interceptors)) { factory.setPlugins(this.interceptors); } if (this.databaseIdProvider != null) { factory.setDatabaseIdProvider(this.databaseIdProvider); } if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) { factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage()); } if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) { factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage()); } if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) { factory.setMapperLocations(this.properties.resolveMapperLocations()); } return factory.getObject(); } ... }
上面源碼中:自動註入瞭Interceptor[]數組(我們隻需將mybatis的自定義攔截器對象放入到Spring容器中)。後續放入瞭sqlSessionFactory中。
但是項目中雖然自定義配置瞭sqlSessionFactory類,但卻未設置factory.setPlugins(this.interceptors);。導致即使將自定義攔截器放入到Spring容器,但卻不生效。
解決方法,需要手動修改自定義的sqlSessionFactory類。
3. 在mybatis-config.xml配置又放入Spring容器
這種情況下,mybatis自定義攔截器會被執行兩次。即在mybatis-config.xml配置的攔截器會通過反射的方式創建攔截器,放入Spring容器的攔截器也會被初始化。
源碼位置:org.mybatis.spring.SqlSessionFactoryBean#buildSqlSessionFactory
protected SqlSessionFactory buildSqlSessionFactory() throws IOException { Configuration configuration; ...讀取屬性中的plugins,即org.mybatis.spring.SqlSessionFactoryBean#setPlugins設置的。 if (!isEmpty(this.plugins)) { for (Interceptor plugin: this.plugins) { configuration.addInterceptor(plugin); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Registered plugin: '" + plugin + "'"); } } } ...解析xml配置(通過反射創建攔截器對象) if (xmlConfigBuilder != null) { try { xmlConfigBuilder.parse(); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Parsed configuration file: '" + this.configLocation + "'"); } } catch(Exception ex) { throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex); } finally { ErrorContext.instance().reset(); } } return this.sqlSessionFactoryBuilder.build(configuration); }
最終會執行到:
private void pluginElement(XNode parent) throws Exception { if (parent != null) { for (XNode child: parent.getChildren()) { String interceptor = child.getStringAttribute("interceptor"); Properties properties = child.getChildrenAsProperties(); //反射創建mybatis的插件。 Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance(); interceptorInstance.setProperties(properties); configuration.addInterceptor(interceptorInstance); } } }
SpringBoot 自定義Mybatis攔截器
開發過程中經常回需要對要執行的sql加以自定義處理,比如分頁,計數等。通過 MyBatis 提供的強大機制,使用插件是非常簡單的,隻需實現 Interceptor 接口,並指定想要攔截的方法簽名即可。
@Intercepts({@Signature(type = Executor.class,method = "query",args = {MappedStatement.class,Object.class, RowBounds.class,ResultHandler.class})}) public class MyPageInterceptor implements Interceptor { private static final Logger logger= LoggerFactory.getLogger(MyPageInterceptor.class); @Override public Object intercept(Invocation invocation) throws Throwable { logger.warn(invocation.toString()); return invocation.proceed(); } @Override public Object plugin(Object o) { return Plugin.wrap(o,this); } @Override public void setProperties(Properties properties) { logger.warn(properties.toString()); } }
我的配置
mybatis: type-aliases-package: me.zingon.pagehelper.model mapper-locations: classpath:mapper/*.xml configuration: map-underscore-to-camel-case: true default-fetch-size: 100 default-statement-timeout: 30
在springboot中要給mybatis加上這個攔截器,有三種方法,前兩種方法在啟動項目時不會自動調用自定義攔截器的setProperties方法。
第一種
直接給自定義攔截器添加一個@Component註解,當調用sql時結果如下,可以看到攔截器生效瞭,但是啟動時候並沒有自動調用setProperties方法。
第二種
在配置類裡添加攔截器,這種方法結果同上,也不會自動調用setProperties方法。
@Configuration public class MybatisConfig { @Bean ConfigurationCustomizer mybatisConfigurationCustomizer() { return new ConfigurationCustomizer() { @Override public void customize(org.apache.ibatis.session.Configuration configuration) { configuration.addInterceptor(new MyPageInterceptor()); } }; } }
第三種
這種方法就是跟以前的配置方法類似,在yml配置文件中指定mybatis的xml配置文件,註意config-location屬性和configuration屬性不能同時指定
mybatis: config-location: classpath:mybatis.xml type-aliases-package: me.zingon.pagehelper.model mapper-locations: classpath:mapper/*.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <typeAliases> <package name="me.zingon.pacargle.model"/> </typeAliases> <plugins> <plugin interceptor="me.zingon.pagehelper.interceptor.MyPageInterceptor"> <property name="dialect" value="oracle"/> </plugin> </plugins> </configuration>
可以看到,在啟動項目的時候setProperties被自動調用瞭
前兩種方法可以在初始化自定義攔截器的時候通過 @Value 註解直接初始化需要的參數。
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。
推薦閱讀:
- Mybatis sqlMapConfig.xml中的mappers標簽使用
- 在springboot中如何給mybatis加攔截器
- Mybatis之typeAlias配置的3種方式小結
- Mybatis省略@Param註解原理分析
- Mybatis 如何在配置文件中給實體類起別名