【Mybatis】深入浅出Mybatis（十一）——Mybatis和Spring整合

约定不等于承诺〃 2022-09-28 13:19 201阅读 0赞

# 一、前言 #

前一篇博客中向大家介绍了[Mybatis的逆向工程][Mybatis]，根据数据库生成我们所需要的映射文件和实体文件以及操作接口。这个过程是很刺激的，从此以后只要我们拥有了数据库就可以直接生成自己的持久层了。

我们都知道Mybatis是不是自己使用的，一般都托管于Spring。所以这篇博客，小编向大家介绍mybatis与Spring的整合。

# 二、整合过程 #

## 2.1整合思路 ##

1. 创建新的java Project

2. 导入整合所需要的jar包（包括mybatis、spring、整合jar、数据库连接等），[下载点击这里][Link 1]。

3. 建立配置文件，包括spring和mybatis的核心配置文件，log4j日志文件。

4. 把逆向工程生成的类和映射文件拷贝进来。为了方便测试，小编就只拷贝了User的相关文件。

5.测试

## 2.2 建立新的java Project ##

这一步很简单，New——>Java Project，输入项目名称，小编命名为SM。建立完成后，添加一个名字为lib的文件夹，用于存放相应的jar包。

![这里写图片描述][SouthEast]

## 2.3 导入整合所需要的jar包 ##

把所有的jar包拷贝到lib文件夹中。

![这里写图片描述][SouthEast 1]

然后我们把这些jar包，add to build path， 关于关于jar包add to build path与放入lib下的区别，[请跳转][Link 2]

## 2.4 建立配置文件 ##

我们要建立的文件包括：

*  spring核心配置文件：applicationContext.xml
 *  mybatis核心配置文件：SqlMapConfig.xml
 *  数据库连接池配置文件：db.properties
 *  log4j日志配置文件：log4j.properties

其中比较固定的有，log4j文件：

# Global logging configuration
    log4j.rootLogger=DEBUG, stdout
    # Console output...
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

db.properties文件，您只需修改自己数据库对应的字段：

jdbc.driver = com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
    jdbc.username = root
    jdbc.password=123456

spring配置文件中可以加载数据库配置文件，所以将数据库连接池托付给spring管理。通过context:property-placeholder标签。

spring通过单例的方式管理SqlSessionFactory。spring和Mybatis整合生成代理对象，使用SqlSessionFactory创建SqlSession。当创建sqlsession的时候需要传入mybatis的配置文件，所以要在其中加载mybatis的全局配置文件。

![这里写图片描述][SouthEast 2]

applicationContext文件（未添加mapper映射）：

由于咱们添加了spring，mybatis的配置文件也有改变这个里面的内容也得根据在spring中的映射方式来修改mybatis的配置文件。mybatis的配置文件具体的操作看下文测试。

下面给出一个SqlMapConfig.xml的原始框架，这里要注意的是前面的xml文件的头文件：

## 3.5 加入逆向工程生成的类和映射文件 ##

![这里写图片描述][SouthEast 3]

# 三、整合测试 #

这里使用的是mapper代理方法的测试。

## 3.1 建立测试类和方法 ##

建立新的包，小编命名为“cn.itcast.ssm.test”，在这个包内建立一个测试类“TestUser.java”，写下面的代码：

## 3.2 Spring配置文件和mybatis配置文件 ##

下面是比较重要的地方了，要在Spring配置文件和mybatis中配置。这里要分情况了:

方法一 通过MapperScannerConfigurer进行mapper扫描（建议使用）

只需要配置spring就可以了，不用配置mybatis的SqlMapConfig.xml文件。mapper批量扫描，从mapper包中扫描出mapper接口，自动创建代理对象并且在spring容器中注册。

> 规范：将mapper.java和mapper.xml映射文件名称保持一致，且在一个目录中，自动扫描出来的mapper的bean的id为mapper类名（**手写字母小写**）。

比如在测试方法中写的(UserMapper)applicationContext.getBean(“userMapper”);这里用到的就是userMapper，如果我们要查询items表的，就写成(UserMapper)applicationContext.getBean(“itemsMapper”);

在spring的applicationContext.xml配置文件中添加下面的代码：

方法二 8.5.2 通过MapperFactoryBean创建代理对象

此方法问题：

需要在spring中的每一个mapper进行配置，麻烦。而且要在mybatis的SqlMapConfig.xml配置文件中配置。

举例：如果我现在有两个需求：

1. 根据用户的id查询用户信息

2.根据items的id查询items信息

这样的话，就需要在Spring中配置两次，因为涉及到了两张表：

applicationContext.xml文件中添加：

SqlMapConfig.xml文件更新为：

<?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>
    
    <mappers>
        
        
        <package name="cn.itcast.ssm.mapper"/>  
    </mappers>
    
    </configuration>

测试方法：

package cn.itcast.ssm.test;
    
    import org.junit.Before;
    import org.junit.Test;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    import cn.itcast.ssm.mapper.ItemsMapper;
    import cn.itcast.ssm.mapper.UserMapper;
    import cn.itcast.ssm.po.Items;
    import cn.itcast.ssm.po.User;
    /** * 测试类 * @author Ares * 2017年3月12日11:30:34 */
    public class TestUser { 
        ApplicationContext applicationContext;
        /** * 类加载的时候首先加载这个方法，用于创建一个ApplicationContext */
        @Before
        public void setUp(){
            applicationContext = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
    
        }
    
        /** * 测试User的查询主键方法 * @throws Exception */
        @Test
        public void testUserselectByPrimaryKey() throws Exception{
            UserMapper userMapper = (UserMapper)applicationContext.getBean("userMapper");
    
            //调用userDao方法
            User user = userMapper.selectByPrimaryKey(1);
            System.out.println(user.getUsername());
        }
    
        /** * 测试Item的查询主键方法 * @throws Exception */
        @Test
        public void testItemsselectByPrimaryKey() throws Exception{
            ItemsMapper itemsMapper = (ItemsMapper)applicationContext.getBean("itemsMapper");
    
            //调用userDao方法
            Items items = itemsMapper.selectByPrimaryKey(1); 
            System.out.println(items.getName());
        }
    }

testUserselectByPrimaryKey测试结果：

![这里写图片描述][SouthEast 4]

testItemsselectByPrimaryKey测试结果：

![这里写图片描述][SouthEast 5]

# 四、遇到的问题 #

## 4.1 问题：Document root element “mapper”, must match DOCTYPE root “configuration”. ##

![这里写图片描述][SouthEast 6]

原因是自己写的mapper.xml的开头的约定不一样，复制的时候没有留意，直接就使用了。

举例：  
      错误的UserMapper.xml：

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">                         
    
    <mapper namespace="cn.itcast.ssm.mapper.UserMapper">
    
        <select id="findUserByIdMapper" parameterType="int" resultType="cn.itcast.ssm.po.User">
            SELECT * from user where id =#{value}
        </select>
    
    </mapper>

正确的UserMapper.xml

<?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="cn.itcast.ssm.mapper.UserMapper">
    
        <select id="findUserByIdMapper" parameterType="int" resultType="cn.itcast.ssm.po.User">
            SELECT * from user where id =#{value}
        </select>
    
    </mapper>

## 4.2 控制台报 Invoking destroy method ‘close’ on bean with name ‘dataSource’ ##

这个显然是路径的错误，在xml文件中引用其他的文件的时候，路径出了错误。这里小编总结几个知识点：[From 官网][From]

![这里写图片描述][SouthEast 7]

# 五、小结 #

通过这次的学习，终于把mybatis和spring进行了结合，这个真的是没有问题的了，而且开发也是非常的迅速，系统非常的灵活，越来越的感受到这个东西的好处了。

到这里为止小编的Mybatis是基本就接近尾声了，以后会向大家推荐更好的文章。另外也希望大家多多支持。

[Mybatis]: http://blog.csdn.net/kisscatforever/article/details/61430064
[Link 1]: http://url.cn/45u58xZ
[SouthEast]: /images/20220708/b61c803200be4887b1e6c55342c8471c.png
[SouthEast 1]: /images/20220708/ef402d45588445c6a7d476b0a986beaa.png
[Link 2]: http://blog.csdn.net/dazengq/article/details/51487703
[SouthEast 2]: /images/20220708/20023b757e334ce2be72455c93ce8da8.png
[SouthEast 3]: /images/20220708/73a32124a33d4fed81f8fbef43cd71e0.png
[SouthEast 4]: /images/20220708/639f16377a8849b2896f344eae47becb.png
[SouthEast 5]: /images/20220708/138cffedb29847d0b835dd3820022768.png
[SouthEast 6]: /images/20220708/f6bbfa60a89548378ffb1dd95e99cefb.png
[From]: http://docs.spring.io/autorepo/docs/spring/3.2.x/spring-framework-reference/html/resources.html
[SouthEast 7]: /images/20220708/464225dc61de4863ad46f556fb2fcff0.png