Spring Boot 集成MyBatis
Spring Boot 集成MyBatis有两种方式,一种简单的方式就是使用MyBatis官方提供的:
mybatis-spring-boot-starter
另外一种方式就是仍然用类似mybatis-spring
的配置方式,这种方式需要自己写一些代码,但是可以很方便的控制MyBatis的各项配置。
在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
依赖树如下:
![依赖树](https://img-blog.csdn.net/20151219223636711)
其中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});
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);
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
上面代码创建了一个SqlSessionFactory
和一个SqlSessionTemplate
,为了支持注解事务,增加了@EnableTransactionManagement
注解,并且反回了一个PlatformTransactionManager
Bean。
另外应该注意到这个配置中没有MapperScannerConfigurer
,如果我们想要扫描MyBatis的Mapper接口,我们就需要配置这个类,这个配置我们需要单独放到一个类中。
/**
* MyBatis扫描接口
*
* @author liuzh
* @since 2015-12-19 14:46
*/
@Configuration
@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;
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
这个配置一定要注意@AutoConfigureAfter(MyBatisConfig.class)
,必须有这个配置,否则会有异常。原因就是这个类执行的比较早,由于sqlSessionFactory
还不存在,后续执行出错。
做好上面配置以后就可以使用MyBatis了。
关于分页插件和通用Mapper集成
分页插件作为插件的例子在上面代码中有。
通用Mapper配置实际就是配置MapperScannerConfigurer
的时候使用tk.mybatis.spring.mapper.MapperScannerConfigurer
即可,配置属性使用Properties
。
Spring Boot集成MyBatis的基础项目
我上传到github一个采用第二种方式的集成项目,并且集成了分页插件和通用Mapper,项目包含了简单的配置和操作,仅作为参考。
项目地址:https://github.com/abel533/MyBatis-Spring-Boot
分页插件和通用Mapper的相关信息可以通过上面地址找到。