从0到1使用MyBatis

MyBatis作为最流行的数据中间层，成为企业Java软件开发中非常重要的软件。

一、基本配置

1、首先需要导入Maven

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.2.8</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>1.2.3</version>
</dependency>

2、配置Mapper扫描配置器

然后在Spring容器加载bean时指定的配置文件中定义MapperScannerConfigurer，指定sqlSessionFactoryBeanName和basePackage

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    <property name="basePackage" value="com.test.mapper" />
</bean>

其中sqlSessionFactoryBeanName的值sqlSessionFactory指定一个Session工厂实现Bean

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="datasource" />
    <property name="typeAliasesPackage" value="com.test.entities" />
    <property name="mapperLocations" value="classpath*:mapper/*Mapper.xml" />
</bean>

SqlSessionFactoryBean的第一个属性是dataSource，他的类型是javax.sql.DataSource，可以配置任意一个实现了该接口的类。比如连接池com.mchange.v2.c3p0.ComboPooledDataSource。

比如使用c3p0的datasource案例如下：

<bean id="datasource" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
    <property name="driverClass" value="${jdbc.driver}" />
    <property name="jdbcUrl" value="${jdbc.url}" />
    <property name="user" value="${jdbc.uid}" />
    <property name="password" value="${jdbc.pwd}" />
    <property name="acquireIncrement" value="5" />
    <property name="initialPoolSize" value="10" />
    <property name="minPoolSize" value="5" />
    <property name="maxPoolSize" value="20" />
</bean>

其中的配置信息，可以在引用的db.properties中指定

<context:property-placeholder location="classpath*:db.properties" />

db.properites定义如下

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.9.51:3306/testdb
jdbc.uid=root
jdbc.pwd=123456

3、新建接口

接着在basePackage定义的目录com.test.mapper下添加接口

/**
 * 根据图书编号获得图书对象
 */
public Book getBookById(@Param("id") int id);

4、新建实现xml

最后在mapperLocations定义的classpath:mapper/Mapper.xml中实现sql语句，需要注意的是方法名和id要一致

<mapper namespace="com.test.mapper.BookMapper">
    <select id="getBookById" resultType="com.newqur.entities.Book">
        select id, title, price, publishDate from books where id = #{id}
    </select>
</mapper>

二、在SpringBoot中的使用方式

2.1、使用如下pom

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>

如果使用了pagehelper的starter，则可以只导入如下的Maven库即可

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
</dependency>

2.2、在配置类中定义接口扫描范围

@Configuration
@EnableTransactionManagement
@MapperScan({"com.test.mapper","com.test.portal.dao"})
public class MyBatisConfig {
}

@Configuration用于指定该类为配置入口类

可以在MappderScan中定义多个接口包名

@EnableTransactionManagement是用于开启事务的

2.3、在yml中配置Scanner扫描器

mybatis:
  mapper-locations:
    - classpath:dao/*.xml
    - classpath*:com/**/mapper/*.xml

可以配置多个扫描路径

2.4、配置jdbc数据源

可以是c3p0、dbcp或者druid、HikariCP等任意数据源

spring:
  datasource:
    url: jdbc:mysql://192.168.9.51:3306/testdb
    username: root
    password: 123456
    druid:
      initial-size: 5 #连接池初始化大小
      min-idle: 10 #最小空闲连接数
      max-active: 20 #最大连接数