概述
接上一篇MyBatis 学习笔记（二）MyBatis常用特性运用
在真实的项目我们几乎不会将MyBatis 单独运用到项目中，而是将其整合到Spring框架或者SpringBoot中，本文将通过两个demo演示MyBatis 与Spring和SpringBoot的整合。
在Spring中使用
在Spring中我们通过mybatis-spring 中间框架将MyBatis和Spring 两个完全不相关的框架整合起来
该框架一方面负责加载和解析MyBatis相关配置，另一方面，该框架还会通过Spring提供的扩展点，把各种Dao接口对应的对象放入IOC容器中。
本demo是一个maven项目，首先整合需要添加的依赖，如下
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.42</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.6</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.3.2</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>${spring.version}</version> </dependency>
添加好依赖之后，我们需要在新建一个Spring的配置文件SpringContext.xml，该配置文件主要配置数据源，配置sqlSessionFactory用于生成SqlSession，配置MapperScannerConfigurer用于扫描接口，配置文件如下：
<context:property-placeholder location="jdbc.properties"/> <context:component-scan base-package="com.jay"/> <!--配置数据源--> <bean id="dataSource" class="org.apache.ibatis.datasource.pooled.PooledDataSource"> <!-- 配置与数据库交互的4个必要属性 --> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </bean> <!--配置sqlSessionFactory--> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <!-- 给 SqlSessionFactory 配置数据源，这里引用上面的数据源配置 --> <property name="dataSource" ref="dataSource"/> <!--配置MyBatis-cfg.xml的路径--> <property name="configLocation" value="MyBatis-cfg.xml"/> <!--配置映射文件--> <property name="mapperLocations" value="mybatis/*.xml"/> </bean> <!--配置MapperScannerConfigurer--> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <!--配合Dao接口所在的包--> <property name="basePackage" value="com.jay.mapper"/> </bean>
接着我们还需要配置一下MyBatis的配置文件MyBatis-cfg.xml，配置如下：
<configuration> <settings> <setting name="cacheEnabled" value="true"/> </settings> <typeAliases> <typeAlias type="com.jay.entity.ClassRoom" alias="ClassRoom"/> <typeAlias type="com.jay.entity.Student" alias="Student"/> </typeAliases> </configuration>
需要注意的是，MyBatis-cfg.xml 中的配置除了settings元素是必须配置在MyBatis 的配置文件中，其余元素都可以配置到Spring的配置文件中。
配置文件处理完成之后，接着我们来新建一个映射文件以及Dao 接口测试下
此处我新建了一个名为StudentMapper.xml的映射文件。
<mapper namespace="com.jay.mapper.StudentMapper"> <resultMap id="studentResult" type="Student"> <id property="id" column="id"/> <result property="name" column="name"/> <result property="age" column="age"/> <result property="sexEnum" column="sex" typeHandler="com.jay.Handler.GeneralEnumHandler"/> <association property="classRoom" javaType="ClassRoom"> <id property="id" column="id"/> <result property="name" column="name"/> </association> </resultMap> <resultMap id="classRoomResult" type="ClassRoom"> <id property="id" column="id"/> <result property="name" column="name"/> </resultMap> <select id="selectStudentById" resultMap="studentResult"> SELECT s.id,s.`name`,s.age,s.sex,c.id,c.`name` FROM student s, class c WHERE s.class_id=c.id AND s.id=#{id} </select> </mapper>
对应的Dao接口如下：
@Repository public interface StudentMapper { /** * 根据id查询学生 * @param id * @return */ Student selectStudentById(Integer id); }
最后我们新建一个测试类，测试下结果。
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration("classpath:SpringContext.xml") public class StudentMapperTest { @Autowired private StudentMapper studentMapper; @Test public void testSelectStudentById() { Student student = studentMapper.selectStudentById(1); System.out.println(student.toString()); } }
测试结果如下：
小结
至此我们MyBatis与Spring的整合就完成了，当然这是一个很小的示范demo，但是其包括了Spring与MyBatis整合的要点。其流程无非就是先引入相关的依赖，Spring的依赖和MyBatis的依赖等，接着就是对数据源，SqlSessionFactory等信息进行配置，最后就是编写映射文件和Dao接口。
源代码
https://github.com/XWxiaowei/MyBatisLearn/tree/master/mybatis-spring-demo
在SpringBoot中使用
接下来我们学习下在SpringBoot 中整合MyBatis
首先我们需要新建一个SpringBoot项目，新建项目的细节再此处不详细说明。新建完项目之后之后我们首先需要添加依赖
<dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.0.1</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency>
然后在application.yml中添加相关的数据源，MyBatis的相关信息
#DataSource config 配置数据源信息 spring: datasource: driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatisdemo?useUnicode=true&characterEncoding=utf-8 username: root password: admin #配置MyBatis的配置文件地址和MyBatis的映射文件地址 mybatis: config-location: MyBatis-cfg.xml mapper-locations: mybatis/*.xml
接着我们还需要在启动类MybatisSpringbootDemoApplication中添加dao接口的扫描信息
@SpringBootApplication @MapperScan(value = "com.jay.mapper") public class MybatisSpringbootDemoApplication { public static void main(String[] args) { SpringApplication.run(MybatisSpringbootDemoApplication.class, args); } }
映射文件和Dao接口等同于上面所述的StudentMapper.xml 和StudentMapper，在此不再赘述。
最后我们看看测试类
@RunWith(SpringJUnit4ClassRunner.class) @SpringBootTest public class StudentMapperTest { @Autowired private StudentMapper studentMapper; @Test public void selectStudentById() throws Exception { Student student = studentMapper.selectStudentById(1); System.out.println("---->查询结果为={}"+student); } }
测试结果如下：
小结
本机我们通过一个demo阐述了SpringBoot与MyBatis的整合。我们可以很明显的看出SpringBoot的配置相对较少，这与SpringBoot的理念相关，约定大于配置，注解多于配置。
总结
本文通过两个demo 阐述了MyBatis 与Spring和SpringBoot的整合过程。demo 比较简单，希望能对读者有所帮助。
源代码
https://github.com/XWxiaowei/MyBatisLearn/tree/master/mybatis-springboot-demo
