Spring Boot 集成MyBatis有兩種方式,一種簡單的方式就是使用MyBatis官方提供的:
另外一種方式就是仍然用類似mybatis-spring
的配置方式,這種方式需要自己寫一些代碼,但是可以很方便的控制MyBatis的各項配置。
一、mybatis-spring-boot-starter方式
在pom.xml
中添加依賴:
-
<dependency>
-
<groupId>org.mybatis.spring.boot</groupId>
-
<artifactId>mybatis-spring-boot-starter</artifactId>
-
<version>1.0.0</version>
-
</dependency>
mybatis-spring-boot-starter
依賴樹如下:
其中mybatis
使用的3.3.0版本,可以通過: <mybatis.version>3.3.0</mybatis.version>
屬性修改默認版本。 mybatis-spring
使用版本1.2.3,可以通過: <mybatis-spring.version>1.2.3</mybatis-spring.version>
修改默認版本。
在application.yml
中增加配置:
-
mybatis:
-
mapperLocations: classpath:mapper/*.xml
-
typeAliasesPackage: tk.mapper.model
除了上面常見的兩項配置,還有:
- mybatis.config:mybatis-config.xml配置文件的路徑
- mybatis.typeHandlersPackage:掃描typeHandlers的包
- mybatis.checkConfigLocation:檢查配置文件是否存在
- mybatis.executorType:設置執行模式(
SIMPLE, REUSE, BATCH
),默認爲SIMPLE
二、mybatis-spring方式
這種方式和平常的用法比較接近。需要添加mybatis
依賴和mybatis-spring
依賴。
然後創建一個MyBatisConfig
配置類:
-
/**
-
* MyBatis基礎配置
-
*
-
* @author liuzh
-
* @since 2015-12-19 10:11
-
*/
-
@Configuration
-
@EnableTransactionManagement
-
public class MyBatisConfig implements TransactionManagementConfigurer {
-
@Autowired
-
DataSource dataSource;
-
@Bean(name = "sqlSessionFactory")
-
public SqlSessionFactory sqlSessionFactoryBean() {
-
SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
-
bean.setDataSource(dataSource);
-
bean.setTypeAliasesPackage("tk.mybatis.springboot.model");
-
//分頁插件
-
PageHelper pageHelper = new PageHelper();
-
Properties properties = new Properties();
-
properties.setProperty("reasonable", "true");
-
properties.setProperty("supportMethodsArguments", "true");
-
properties.setProperty("returnPageInfo", "check");
-
properties.setProperty("params", "count=countSql");
-
pageHelper.setProperties(properties);
-
//添加插件
-
bean.setPlugins(new Interceptor[]{pageHelper});
-
//添加XML目錄
-
ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
-
try {
-
bean.setMapperLocations(resolver.getResources("classpath:mapper/*.xml"));
-
return bean.getObject();
-
} catch (Exception e) {
-
e.printStackTrace();
-
throw new RuntimeException(e);
-
}
-
}
-
@Bean
-
public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
-
return new SqlSessionTemplate(sqlSessionFactory);
-
}
-
@Bean
-
@Override
-
public PlatformTransactionManager annotationDrivenTransactionManager() {
-
return new DataSourceTransactionManager(dataSource);
-
}
-
}
上面代碼創建了一個SqlSessionFactory
和一個SqlSessionTemplate
,爲了支持註解事務,增加了@EnableTransactionManagement
註解,並且反回了一個PlatformTransactionManager
Bean。
另外應該注意到這個配置中沒有MapperScannerConfigurer
,如果我們想要掃描MyBatis的Mapper接口,我們就需要配置這個類,這個配置我們需要單獨放到一個類中。
-
/**
-
* MyBatis掃描接口
-
*
-
* @author liuzh
-
* @since 2015-12-19 14:46
-
*/
-
@Configuration
-
//TODO 注意,由於MapperScannerConfigurer執行的比較早,所以必須有下面的註解
-
@AutoConfigureAfter(MyBatisConfig.class)
-
public class MyBatisMapperScannerConfig {
-
@Bean
-
public MapperScannerConfigurer mapperScannerConfigurer() {
-
MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
-
mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
-
mapperScannerConfigurer.setBasePackage("tk.mybatis.springboot.mapper");
-
return mapperScannerConfigurer;
-
}
-
}
這個配置一定要注意@AutoConfigureAfter(MyBatisConfig.class)
,必須有這個配置,否則會有異常。原因就是這個類執行的比較早,由於sqlSessionFactory
還不存在,後續執行出錯。
做好上面配置以後就可以使用MyBatis了。
關於分頁插件和通用Mapper集成
分頁插件作爲插件的例子在上面代碼中有。
通用Mapper配置實際就是配置MapperScannerConfigurer
的時候使用tk.mybatis.spring.mapper.MapperScannerConfigurer
即可,配置屬性使用Properties
。