Spring Boot 集成MyBatis

 

Spring Boot 集成MyBatis有兩種方式,一種簡單的方式就是使用MyBatis官方提供的:

mybatis-spring-boot-starter

另外一種方式就是仍然用類似mybatis-spring的配置方式,這種方式需要自己寫一些代碼,但是可以很方便的控制MyBatis的各項配置。

一、mybatis-spring-boot-starter方式

pom.xml中添加依賴:


 
  1. <dependency>

  2. <groupId>org.mybatis.spring.boot</groupId>

  3. <artifactId>mybatis-spring-boot-starter</artifactId>

  4. <version>1.0.0</version>

  5. </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中增加配置:


 
  1. mybatis:

  2. mapperLocations: classpath:mapper/*.xml

  3. 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配置類:


 
  1. /**

  2. * MyBatis基礎配置

  3. *

  4. * @author liuzh

  5. * @since 2015-12-19 10:11

  6. */

  7. @Configuration

  8. @EnableTransactionManagement

  9. public class MyBatisConfig implements TransactionManagementConfigurer {

  10.  
  11. @Autowired

  12. DataSource dataSource;

  13.  
  14. @Bean(name = "sqlSessionFactory")

  15. public SqlSessionFactory sqlSessionFactoryBean() {

  16. SqlSessionFactoryBean bean = new SqlSessionFactoryBean();

  17. bean.setDataSource(dataSource);

  18. bean.setTypeAliasesPackage("tk.mybatis.springboot.model");

  19.  
  20. //分頁插件

  21. PageHelper pageHelper = new PageHelper();

  22. Properties properties = new Properties();

  23. properties.setProperty("reasonable", "true");

  24. properties.setProperty("supportMethodsArguments", "true");

  25. properties.setProperty("returnPageInfo", "check");

  26. properties.setProperty("params", "count=countSql");

  27. pageHelper.setProperties(properties);

  28.  
  29. //添加插件

  30. bean.setPlugins(new Interceptor[]{pageHelper});

  31.  
  32. //添加XML目錄

  33. ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();

  34. try {

  35. bean.setMapperLocations(resolver.getResources("classpath:mapper/*.xml"));

  36. return bean.getObject();

  37. } catch (Exception e) {

  38. e.printStackTrace();

  39. throw new RuntimeException(e);

  40. }

  41. }

  42.  
  43. @Bean

  44. public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {

  45. return new SqlSessionTemplate(sqlSessionFactory);

  46. }

  47.  
  48. @Bean

  49. @Override

  50. public PlatformTransactionManager annotationDrivenTransactionManager() {

  51. return new DataSourceTransactionManager(dataSource);

  52. }

  53. }

上面代碼創建了一個SqlSessionFactory和一個SqlSessionTemplate,爲了支持註解事務,增加了@EnableTransactionManagement註解,並且反回了一個PlatformTransactionManagerBean。

另外應該注意到這個配置中沒有MapperScannerConfigurer,如果我們想要掃描MyBatis的Mapper接口,我們就需要配置這個類,這個配置我們需要單獨放到一個類中。


 
  1. /**

  2. * MyBatis掃描接口

  3. *

  4. * @author liuzh

  5. * @since 2015-12-19 14:46

  6. */

  7. @Configuration

  8. //TODO 注意,由於MapperScannerConfigurer執行的比較早,所以必須有下面的註解

  9. @AutoConfigureAfter(MyBatisConfig.class)

  10. public class MyBatisMapperScannerConfig {

  11.  
  12. @Bean

  13. public MapperScannerConfigurer mapperScannerConfigurer() {

  14. MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();

  15. mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");

  16. mapperScannerConfigurer.setBasePackage("tk.mybatis.springboot.mapper");

  17. return mapperScannerConfigurer;

  18. }

  19.  
  20. }

這個配置一定要注意@AutoConfigureAfter(MyBatisConfig.class),必須有這個配置,否則會有異常。原因就是這個類執行的比較早,由於sqlSessionFactory還不存在,後續執行出錯。

做好上面配置以後就可以使用MyBatis了。

關於分頁插件和通用Mapper集成

分頁插件作爲插件的例子在上面代碼中有。

通用Mapper配置實際就是配置MapperScannerConfigurer的時候使用tk.mybatis.spring.mapper.MapperScannerConfigurer即可,配置屬性使用Properties

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章