MyBatis 与 Spring 整合

0x00：前言介绍

在 MyBatis 中，最重要的类想必就是 SqlSessionFactory 类了，它的作用就是通过加载全局的配置文件和 Mapper 映射文件，然后初始化连接参数，去创建会话的实例类 SqlSession。

而 SqlSession 类的作用就是与数据库连接，执行 Mapper 映射文件中的 sql 语句。那在 Spring 与 MyBatis 整合的环境当中，Spring 的作用主要有以下几点：

1，通过单例方式管理 SqlSessionFactory，节省了连接和内存资源，且不需要再去自己写加载 Factory 的代码，从而统一了会话对象的产生源头。
2，Spring 会对持久层的 Mapper 进行统一管理。
3，Spring 会对数据库连接池、事务进行统一的管理。

0x01：示例项目

示例项目结构如下图：

需要导入项目的 jar 包有 mybatis 的 jar 包，spring 的 jar 包，以及 mybatis 和 spring 整合的 jar 包。有时候不同的开发环境会导致 jar 包不兼容，可以看下是否少了相应的依赖 jar 包或者是依赖包版本不兼容等。此文章只作为整合示例，项目开发中请用 maven 来管理（后期会有相应内容的更新）。

0x02：Spring 配置文件

Spring 配置文件中会去加载数据库的连接文件 db.properties，建立数据源配置 SqlSessionFactory 会话工厂对象，示例代码如下：

<?xml version="1.0" encoding="UTF-8"?>  
<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc"  
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"  
    xsi:schemaLocation="http://www.springframework.org/schema/beans   
        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd   
        http://www.springframework.org/schema/mvc   
        http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd   
        http://www.springframework.org/schema/context   
        http://www.springframework.org/schema/context/spring-context-3.2.xsd   
        http://www.springframework.org/schema/aop   
        http://www.springframework.org/schema/aop/spring-aop-3.2.xsd   
        http://www.springframework.org/schema/tx   
        http://www.springframework.org/schema/tx/spring-tx-3.2.xsd ">  

        <!-- 加载数据库配置文件 -->
        <context:property-placeholder location="classpath:db.properties" />  

        <!-- 配置数据源信息，使用dbcp的方式来配置 -->
        <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">  
            <property name="driverClassName" value="${jdbc.driver}" />  
            <property name="url" value="${jdbc.url}" />  
            <property name="username" value="${jdbc.username}" />  
            <property name="password" value="${jdbc.password}" />  
            <property name="maxActive" value="10" />  
            <property name="maxIdle" value="5" />  
        </bean>  

        <!-- 加载mybatis的全局配置文件 -->
        <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  
            <property name="configLocation" value="mybatis/SqlMapConfig.xml" />  
            <property name="dataSource" ref="dataSource" />  
        </bean>  

        <!-- 配置dao接口，注入sqlSessionFactory对象 -->
        <bean id="userDao" class="com.fageweiketang.dao.UserDaoImpl">  
            <property name="sqlSessionFactory" ref="sqlSessionFactory"></property>  
        </bean>

        <!-- 配置需要扫描的包 -->
        <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">  
               <property name="basePackage" value="com.fageweiketang.mapper"/>  
               <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>  
        </bean>
</beans>  

0x03：MyBatis 配置文件

MyBatis 配置文件中配置了一些缓存的 setting 参数，以及一些 typeAliases 别名定义和 Mapper 映射文件的加载路径，示例代码如下：

<?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="lazyLoadingEnabled" value="true"/>
        <!-- 将积极加载改为消极加载 -->
        <setting name="aggressiveLazyLoading" value="false"/>
        <!-- 打开全局缓存开关 -->
        <setting name="cacheEnabled" value="true"/>
    </settings>
    <!-- 别名定义 -->
    <typeAliases>
        <package name="com.fageweiketang.po"/>
    </typeAliases>
    <!-- 加载映射文件 -->
    <mappers>
        <!-- 通过resource方法一次加载一个映射文件 -->
        <mapper resource="sqlmap/UserMapper.xml"/>
        <!-- 批量加载mapper -->
        <package name="com.fageweiketang.mapper"/>
    </mappers>
</configuration>

当有了 Spring 托管数据源时，我们就可以在 MyBatis 配置文件中只去关注性能配置。

0x04：Mapper 映射文件

Mapper 映射文件很简单，只配置了一条查询的 sql，示例如下：

<?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="test">     
    <select id="findUserById" parameterType="int" resultType="user">  
      SELECT * FROM user WHERE id=#{id}  
    </select>  
</mapper> 

在映射文件中 resultType 返回的类型是 user，这是因为在 MyBatis 全局配置文件中通过 typeAliases 配置了别名，也就是小写的首字母类名。

0x05：User 实体类

package com.fageweiketang.po;

import java.io.Serializable;

public class User implements Serializable{
    private int id;
    private String username;
    private String password;
    private String email;

    public User(){}

    public User(int id, String username, String password, String email) {
        super();
        this.id = id;
        this.username = username;
        this.password = password;
        this.email = email;
    }

    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }    
}

0x06：数据库配置文件

数据库配置文件通过 key=value 的形式配置，然后在 Spring 中通过 ${} 的形式进行引用，其配置如下：

jdbc.driver=org.gjt.mm.mysql.Driver
jdbc.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root

0x07：日志配置文件

日志配置文件很简单，配置一下日志格式即可，代码示例如下：

log4j.rootLogger = DEBUG,stdout
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =%5p [%t] - %m%n

0x08：DAO 层

创建 dao 层的 interface 接口，定义 findUserById 方法，示例代码如下：

package com.fageweiketang.dao;

import com.fageweiketang.po.User;

public interface UserDao {
    public User findUserById(int id) throws Exception;
}

然后是 UserDao 接口的实现类 UserDaoImpl，示例代码如下：

package com.fageweiketang.dao;

import org.apache.ibatis.session.SqlSession;
import org.mybatis.spring.support.SqlSessionDaoSupport;
import com.fageweiketang.po.User;

public class UserDaoImpl extends SqlSessionDaoSupport implements UserDao {

    public User findUserById(int id) throws Exception {
        SqlSession sqlSession = this.getSqlSession();
        User user = sqlSession.selectOne("test.findUserById",id);
        return user;
    }
}

0x09：测试类

编写测试类，验证 MyBatis 和 Spring 是否整合成功，示例代码如下：

package com.fageweiketang.test;

import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.fageweiketang.dao.UserDao;
import com.fageweiketang.po.User;

public class UserServiceTest {
    private ApplicationContext applicationContext;  

    //在执行本类所有测试方法之前先调用这个方法  
    @Before  
    public void setup() throws Exception{  
        applicationContext=new ClassPathXmlApplicationContext("classpath:spring/applicationContext.xml");  
    }  
  
    @Test  
    public void testFindUserById() throws Exception{  
        UserDao userDao=(UserDao)applicationContext.getBean("userDao");  
        User user=userDao.findUserById(1);   
        System.out.println(user.getId()+":"+user.getUsername()+":"+user.getEmail());  
    }  
}  

运行结果图如下：

0x10：总结

总结示例流程如下：在测试方法中，通过使用 ClassPathXmlApplicationContext 对象去加载了 Spring 的配置文件，也就是 applicationContext.xml 文件，在这个配置文件中引入了数据库配置文件 db.properties，然后加载了数据源 bean，并向其注入了数据库的连接数据。随后加载了 sqlSessionFactory 的 bean 配置，向其注入数据源的对象 dataSource 供其连接数据库，并注入 MyBatis 全局配置文件 SqlMapConfig.xml，供其加载 MyBatis 初始化数据，以及集成 Mapper 映射文件。最后加载配置的 userDao 的 bean 配置。

实现类 UserDaoImpl 继承了包含 sqlSessionFactory 对象的 SqlSessionDaoSupport 父类，并向其注入 sqlSessionFactory 对象，以供其产生 sqlSession 对象，然后通过 ClassPathXmlApplicationContext 对象的加载，获得了 applicationContext 对象，通过 getBean 方法，获取配置对象 userDao。当执行 userDao 的 findUserById 方法时，sqlSession 对象执行了 selectOne 方法，从 Mapper 文件中获取相应 id 的 sql 配置，开启 JDBC 事务，进行最终的数据库操作。

---

                                                                       公众号推荐：aFa攻防实验室

                         分享关于信息搜集、Web安全、内网安全、代码审计、红蓝对抗、Java、Python等方面的东西。