通过示例讲解MyBatis和Spring整合的流程。

前言

这个MyBatis和Spring整合示例，是我今年3月份刚转岗时需要熟悉MyBatis时写的，主要是想知道项目是如何从0到1，在Spring中用到MyBatis。这个示例是参考“C语言中文网”，但是里面的示例不能直接运行，可能是因为版本等原因，当时为了集成MyBatis和Spring，倒腾了好几天，现在回过来看，如果你完全不了解MyBatis的基础知识，直接照葫芦画瓢，虽然也能解决问题，但是排查问题的过程其实是非常痛苦的，下面我将给一个两者集成的完整示例，让大家少走弯路。

项目准备

DB使用的是Mysql，pom.xml需要添加的依赖包：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.6</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>6.0.6</version>
</dependency>

DB结构：

CREATE TABLE `user_test` (
  `uid` tinyint(2) NOT NULL,
  `uname` varchar(20) DEFAULT NULL,
  `usex` varchar(10) DEFAULT NULL,
  PRIMARY KEY (`uid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

DB初始数据：

集成示例

第1步：创建持久化类

@Data
public class MyUser {
    private Integer uid; // 主键
    private String uname;
    private String usex;
}

第2步：创建映射文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.mybatis.dao.UserDao">
    <!-- 根据uid查询一个用户信息 -->
    <select id="selectUserById" parameterType="Integer" resultType="com.mybatis.entity.MyUser">
        select * from user_test where uid = #{uid}
    </select>
    <!-- 查询所有用户信息 -->
    <select id="selectAllUser" resultType="com.mybatis.entity.MyUser">
        select * from user_test
    </select>
    <!-- 添加一个用户，#{uname}为 com.mybatis.po.MyUser 的属性值 -->
    <insert id="addUser" parameterType="com.mybatis.entity.MyUser">
        insert into user_test (uid,uname,usex)
        values(#{uid},#{uname},#{usex})
    </insert>
    <!--修改一个用户 -->
    <update id="updateUser" parameterType="com.mybatis.entity.MyUser">
        update user_test set uname =#{uname},usex = #{usex} where uid = #{uid}
    </update>
    <!-- 删除一个用户 -->
    <delete id="deleteUser" parameterType="Integer">
        delete from user_test where uid= #{uid}
    </delete>
</mapper>

第3步：创建映射文件对应的接口

@Repository("userDao")
@Mapper
/*
 * 使用Spring自动扫描MyBatis的接口并装配 （Spring将指定包中所有被@Mapper注解标注的接口自动装配为MyBatis的映射接口
 */
public interface UserDao {
    /**
     * 接口方法对应的SQL映射文件中的id
     */
    public MyUser selectUserById(Integer uid);
    public List<MyUser> selectAllUser();
    public int addUser(MyUser user);
    public int updateUser(MyUser user);
    public int deleteUser(Integer uid);
}

之前直接使用MyBatis时，是没有这个接口文件的，添加这个文件，是为了能让Spring和Mybatis的操作通过该文件关联起来，即通过上述提供的接口实现对DB的操作。

第4步：新建mybatis配置

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="logImpl" value="LOG4J" />
        <setting name="cacheEnabled" value="false"/>
        <setting name="defaultExecutorType" value="REUSE"/>
        <setting name="useGeneratedKeys" value="true"/>
    </settings>
</configuration>

由于后面会将两者整合，所以关于MyBatis中environments和mappers的配置，将会全部移到applicationContext.xml中，这个是直接用MyBatis中一个很大的区别。

第5步：新增DB配置文件

新增DB配置文件jdbc.properties，用于保存DB配置信息：

jdbc.shop.url=jdbc:mysql://xxx:3104/xm_jointly?characterEncoding=utf8
jdbc.shop.username=jointly_xx
jdbc.shop.password=G-uTlU-xxx

第6步：增加配置信息

需要在applicationContext.xml中新增配置信息，这里就是整个集成的关键所在：

<!-- 用于加载配置文件 -->
    <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location">
            <value>classpath:com/mybatis/config/datasources/jdbc.properties</value>
        </property>
    </bean>

    <!-- 定义数据源 -->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="url" value="${jdbc.shop.url}"></property>
        <property name="username" value="${jdbc.shop.username}"></property>
        <property name="password" value="${jdbc.shop.password}"></property>
    </bean>

    <!-- 添加事务支持 -->
    <bean id="txManager"
          class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>
    <!-- 注册事务管理驱动 -->
    <tx:annotation-driven transaction-manager="txManager" />

    <!-- 配置SqlSessionFactoryBean -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 引用数据源组件 -->
        <property name="dataSource" ref="dataSource" />
        <!-- 引用DB XML配置文件 -->
        <property name="mapperLocations" value="classpath*:com/mybatis/mapper/UserMapper.xml" />
        <!-- 引用MyBatis配置文件中的配置 -->
        <property name="configLocation" value="classpath:com/mybatis/config/datasources/mybatis-config.xml" />
    </bean>

    <!-- Mapper代理开发，使用Spring自动扫描MyBatis的接口并装配 （Spring将指定包中的所有被@Mapper注解标注的接口自动装配为MyBatis的映射接口） -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- mybatis-spring组件的扫描器，com.dao只需要接口（接口方法与SQL映射文件中的相同） -->
        <property name="basePackage" value="com.mybatis.dao" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    </bean>

这个配置需要解读一下：

• 用于加载配置文件：用于存放DB的配置信息，就是上文中提到的jdbc.properties配置文件，这样的好处就是不需要将DB配置信息在XML中写死。
• 定义数据源：这个就是DB的账户和密码了，jdbc.shop.url和jdbc.shop.username等就是DB的配置信息，保存在jdbc.properties配置文件中。
• 添加事务支持：之前这个事务支持的配置是在MyBatis中的environments中，现在给挪到了这里，还是采用JDBC的方式。注意一下，添加事务一定需要注册事务管理驱动。
• 配置SqlSessionFactoryBean：这个其实还是MyBatis中之前的配置，dataSource是数据源、mapperLocations是XML映射文件、configLocation是MyBatis的原始配置，相当于把之前未集成的MyBatis配置拆分了一下，把里面的environments和mappers给挪到这里来了。这个其实就是用来构建sqlSessionFactory会话工厂，我们可以再回顾一下MyBatis的调用流程：

这个建议大家看看文章《【MyBatis系列1】基础知识（下）》，应该就能很明显看出他们的区别，所以为什么需要大家掌握MyBatis未集成的实现方式，这样可以知道它的原貌，包括后面继承Spring Boost，原理都一样，只是换了一种展示方式。

• Spring自动扫描MyBatis的接口并装配：这里就是两者结合的核心，怎么结合呢？通过com.mybatis.dao.UserDao接口，就是我们“第3步：创建映射文件对应的接口”，所以这个才是两者集成的核心，里面的basePackage指定接口路径，sqlSessionFactoryBeanName是用到的sqlSessionFactory会话工厂。

到这里，是不是就很清晰了呢，我可是结合MyBatis未集成的方式进行对比讲解，这样就知道Spring对于两者的集成都做了哪些事情。

第7步：测试示例

我们先常见一个测试类：

@Controller("userController")
public class UserController {
    @Autowired
    private UserDao userDao;
    public void test() {
        // 查询一个用户
        MyUser auser = userDao.selectUserById(1);
        System.out.println(auser);
        System.out.println("============================");
        // 查询所有用户
        List<MyUser> list = userDao.selectAllUser();
        for (MyUser myUser : list) {
            System.out.println(myUser);
        }
    }
}

测试示例：

// 用于测试MyBatis和Spring的集成
public class SpringMyBatisTest {
    public static void main(String[] args) {
        String xmlPath = "applicationContext.xml";
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext(xmlPath);
        UserController uc = (UserController) applicationContext.getBean("userController");
        uc.test();
    }
}

输出结果：

MyUser(uid=1, uname=张三, usex=女)
MyUser(uid=2, uname=陈恒, usex=男)
MyUser(uid=3, uname=楼仔, usex=男)

项目框架

如果只根据上面的示例想让项目跑起来，对于小白来说还是有点困难的，因为你不知道哪个文件放哪里，这里我直接给出项目视图，是不是感觉楼哥超级暖呢。

后记

学习某个工具，感觉还是需要从演变的源头学起，比如学习MyBatis，首先就去学习MyBatis和Spring Boost的集成，虽然知道怎么使用，但是出了问题就不知道怎么定位，所以还是需要掌握基本的流程和原理。也比如学习注解，最开始是从XML演变过来的，如果对XML不了解，直接去学习注解，那么理解的也不深刻。

MyBatis这个系列中，我会把MyBatis与Spring Boost的整合也写一下，等程序写完后，再出这篇文章哈！

欢迎大家多多点赞，更多文章，请关注微信公众号“楼仔进阶之路”，点关注，不迷路~~