Spring Boot 整合MyBatis的java實例詳解-java教程-PHP中文網

Spring Boot 整合MyBatis的java實例詳解

Y2J

發布： 2017-04-25 15:48:48

原創

1667 人瀏覽過

Spring Boot是由Pivotal團隊提供的全新框架，其設計目的是用來簡化新Spring應用的初始建造以及開發過程。該框架使用了特定的方式來進行配置，使開發人員不再需要定義樣板化的配置。透過這種方式，Spring Boot致力於在蓬勃發展的快速應用開發領域（rapid application development）成為領導者。

在整合MyBatis前，我們先設定一個druid資料來源。

Spring Boot 系列

1.Spring Boot 入門

2.Spring Boot 屬性配置和使用

3.Spring Boot 整合MyBatis

4.Spring Boot 靜態資源處理

#5.Spring Boot - 設定排序依賴技巧

Spring Boot整合druid

druid有很多個設定選項，使用spring Boot 的設定檔可以方便的設定druid。

在application.yml設定檔寫上：

spring:

datasource:
  name: test
  url: jdbc:mysql://192.168.16.137:3306/test
  username: root
  password:
  # 使用druid数据源
  type: com.alibaba.druid.pool.DruidDataSource
  driver-class-name: com.mysql.jdbc.Driver
  filters: stat
  maxActive: 20
  initialSize: 1
  maxWait: 60000
  minIdle: 1
  timeBetweenEvictionRunsMillis: 60000
  minEvictableIdleTimeMillis: 300000
  validationQuery: select &#39;x&#39;
  testWhileIdle: true
  testOnBorrow: false
  testOnReturn: false
  poolPreparedStatements: true
  maxOpenPreparedStatements: 20

登入後複製

這裡透過type: com.alibaba.druid.pool.DruidDataSource設定即可！

Spring Boot 整合MyBatis

#Spring Boot 整合MyBatis有兩種方式，簡單的方式就是使用MyBatis官方提供的：

mybatis-spring-boot-starter

另一個方法就是仍然用類似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依賴樹如下：

Spring Boot 整合MyBatis的java實例詳解

其中mybatis所使用的3.3.0版本，可以透過：

3.3 .0屬性修改預設版本。

mybatis-spring使用版本1.2.3，可以透過：

1.2.3修改預設版本。

在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註解，並且反回了一個PlatformTransactionManagerBean。

另外應該注意到這個配置中沒有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。

Spring Boot整合MyBatis的基礎項目

我上傳到github一個採用第二種方式的整合項目，並且整合了分頁外掛程式和通用Mapper，專案包含了簡單的設定和操作，僅作為參考。

專案位址：https://github.com/abel533/MyBatis-Spring-Boot

分頁外掛程式和通用Mapper的相關資訊可以透過上面位址找到。

相關參考：

Spring Boot 快速入門指南