前言

在很多项目中，Mybatis都是和Spring配合起来一起发挥作用的，利用Spring的注入、基于接口编程等优势，将Mybatis的一些琐事交给Spring管理，而Mybatis可以更加注重在自身业务SQL语句上。Mybatis和Spring的整合思路如下：

Mybatis将SqlSessionFactory交给Spring创建和管理 SqlSessionFactoryBean代替了SqlSessionFactoryBuilder来创建SqlSessionFactory,SqlSessionFactoryBean实现了Spring的FactoryBean接口，Spring在应用启动的时候为你创建SqlSessionFactory对象，然后将它以SqlSessionFactory为命名来存储。
Mybatis将数据映射器Mapper交给Spring管理 MapperFactoryBean封装了原有的session.getMapper()功能的实现，它可以把我们对应的Mapper接口注入到由Spring管理的Bean对象中(如Service Bean对象)，这样当我们需要使用到相应的Mapper对象时候，MapperFactoryBean会从它的getObject方法中获取到对应的Mapper.xml文件，即通过Mapper接口(xx.java)获取我们想要的Mapper对象。

项目目录

添加依赖包

pom.xml

"1.0" encoding="UTF-8"?>
"http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    4.0.0

    ddnd
    ddnd
    1.0-SNAPSHOT

    
        
        4.2.5.RELEASE
    

    

        
            org.mybatis
            mybatis
            3.4.6
        

        
        
            org.mybatis
            mybatis-spring
            1.3.2
        

        
        
            mysql
            mysql-connector-java
            8.0.13
        

        
        
            org.springframework
            spring-core
            ${spring.version}
        
        
            org.springframework
            spring-web
            ${spring.version}
        
        
            org.springframework
            spring-oxm
            ${spring.version}
        
        
            org.springframework
            spring-tx
            ${spring.version}
        
        
            org.springframework
            spring-jdbc
            ${spring.version}
        
        
            org.springframework
            spring-webmvc
            ${spring.version}
        
        
            org.springframework
            spring-context
            ${spring.version}
        
        
            org.springframework
            spring-context-support
            ${spring.version}
        
        
            org.springframework
            spring-aop
            ${spring.version}
        

        
            org.springframework
            spring-test
            ${spring.version}
        
    


复制代码

创建数据库和数据表

本文中使用Mysql，为了演示方便，仅创建个简单的数据库spring，还有数据表user。数据表创建SQL代码。

CREATE TABLE `user` (
  `email` varchar(255) DEFAULT NULL,
  `name` varchar(255) DEFAULT NULL,
  `password` varchar(255) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

复制代码

新建数据表对应的实体类

为了实现与数据库中的user表进行关系映射，这里新建一个User类：User.java

package cn.ddnd.www.Entity;

public class User {
    String email;
    String name;
    String password;

    User(String email, String name, String password){
        this.email = email;
        this.name = name;
        this.password = password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getPassword() {
        return password;
    }

    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }

}
复制代码

新建Mapper.xml文件和Mapper接口

Mapper.xml文件和Mapper接口最好在同一个路径下，不同路径的话需要配置的话需要配置SqlSessionFactoryBean的configLocation属性来指定Mapper.xml文件的路径。

Mapper对象：IUser.xml

"1.0" encoding="UTF-8" ?>
"-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

"cn.ddnd.www.Dao.IUser">
    

复制代码

Mapper接口：IUser.java

package cn.ddnd.www.Dao;

import cn.ddnd.www.Entity.User;

public interface IUser {
    public User getUser(String email);
}

复制代码

Mybatis配置文件

Mybatis-config.xml：

"1.0" encoding="UTF-8" ?>
"-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">


    <typeAliases>
        <typeAlias type="cn.ddnd.www.Entity.User" alias="User">typeAlias>
    typeAliases>

复制代码

注意这里：如果Mybatis没有整合Spring的时候，数据源的配置信息需要在这个文件中配置好，现在配合Spring使用之后，数据源的配置也就交给了Spring来创建和管理。同时typeAliases别名也可以在Spring的SqlSessionFactoryBean中设置

Spring配置文件

applicationContext.xml：

配置数据源


"dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    "driverClassName" value="com.mysql.cj.jdbc.Driver">
    "url" value="jdbc:mysql://127.0.0.1:3306/spring?serverTimezone=GMT%2B8">
    "password" value="root">
    "username" value="root">

复制代码

配置Mybatis的SqlSessionFactory


"sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    
    "dataSource" ref="dataSource">
    
    
    "configLocation" value="Mybatis-config.xml">

复制代码

在配置SqlSessionFactoryBean的时候，有一个属性是必须的，就是dataSource,它表示用于连接数据库的数据源（可以是Tomcat DBCP、C3P0等连接池）。除了SqlSessionFactoryBean外，别的属性都不是必要的，如指定Mybatis配置文件的configLocation，指定Mapper.xml文件存放位置的属性mapperLocations，当我们的Mapper.xml文件跟Mapper接口处在同一个目录下时候，这个参数不用设置。typeAliasesPackage可以设置别名，一般对应我们的实体类所在的包，会自动扫描包下的类并且将类名设置为别名，如果有多个包的话，可以用逗号,或者分号:进行分隔。

配置Mybatis数据映射器Mapper

有两种方式将Mapper的接口注册成Bean，分别是单例注册、扫描注册

通过指定Mapper的接口注册相应的Bean


"userBean" class="org.mybatis.spring.mapper.MapperFactoryBean">
    
    "sqlSessionFactory" ref="sqlSessionFactory">
    
    "mapperInterface" value="cn.ddnd.www.Dao.IUser">




    "sqlSessionFactory" ref="sqlSessionFactory">
    
    "mapperInterface" value="cn.ddnd.www.Dao.IBook">
-->
复制代码

mapperInterface：指定接口的路径，MapperFactoryBean创建的代理类实现了IUser接口（Spring将接口注入到Spring管理的Bean中），并且注入到应用程序中。注意IUser.xml文件的路径需要和IUser.java接口的路径相同，否则需要在SqlSessionFactoryBean中设置configLocation属性，指定.xml文件路径。
sqlSessionFactory：指定SqlSessionFactory,用于提供SqlSession。

通过扫描指定包批量将Mapper的接口并注册相应的Bean

通过指定Mapper的接口进行注册Bean的话，我们的Mapper少的时候还可以应付，但是Mapper多了就显得很麻烦了，Mybatis-Spring为了我们提供了一个MapperScannerConfigurer的类，它可以自动扫描Mapper接口并注册为Bean。


"org.mybatis.spring.mapper.MapperScannerConfigurer">
    "basePackage" value="cn.ddnd.www.Dao" />

复制代码

basePackage：指定接口所在的包的路径，MapperScannerConfigurer会自动扫描包下的接口并创建为MapperFactoryBean。
可以不指定sqlSessionFactory，因为MapperScannerConfigurer会创建在创建MapperFactoryBean之后自动装配sqlSessionFactory。但是如果你使用了一个以上的DataSource，那么自动装配失效。

applicationContext.xml完整代码：

"1.0" encoding="UTF-8"?>
"http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    
    "dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        "driverClassName" value="com.mysql.cj.jdbc.Driver">
        "url" value="jdbc:mysql://127.0.0.1:3306/spring?serverTimezone=GMT%2B8">
        "password" value="root">
        "username" value="root">
    

    
    "sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        
        "dataSource" ref="dataSource">
        
        "configLocation" value="Mybatis-config.xml">
    

    
    "userBean" class="org.mybatis.spring.mapper.MapperFactoryBean">
        
        "sqlSessionFactory" ref="sqlSessionFactory">
        
        "mapperInterface" value="cn.ddnd.www.Dao.IUser">
    

    
    
        
    


复制代码

测试类

test.jav：

import cn.ddnd.www.Dao.IUser;
import cn.ddnd.www.Entity.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import org.apache.ibatis.io.Resources;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.io.Reader;
import java.io.IOException;


public class test {
    private static Reader reader;
    private static SqlSessionFactory sqlSessionFactory;
    private static ApplicationContext applicationContext;

    static{
//        只需要加载Spring的配置文件
        applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
    }
    @Test
    public void a() throws IOException {
//            获取Mapper对象
            IUser iUser = (IUser) applicationContext.getBean("userBean");
//            调用Mapper对象的方法
            User user = iUser.getUser("[email protected]");
            System.out.println("用户的邮箱是：" + user.getEmail() + "，用户的名称是：" + user.getName() + "，用户的密码是：" + user.getPassword());
    }
}
复制代码

从这里可以看到单独使用MybatisMybatis实现数据库操作和Mybatis-Spring整合使用的区别，Mybatis将SqlSessionFactory和数据映射器Mapper交给Spring管理之后，我们不再需要sqlSession的获取和close，不在需要手动指定映射器。运行结果：

转自：ddnd.cn/2018/12/01/…

【Java】Spring和Mybatis整合

前言