Spring学习之Spring与Mybatis的两种整合方式

Posted 2020-12-12 TIOXY

本机使用IDEA 2020.1、mysql 8.0.19,通过Maven进行构建

环境准备

导入maven依赖包

<dependencies>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.19</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.4</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.2.7.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.2.7.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.2</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>2.0.5</version>
</dependency>
</dependencies>

并在pom文件中设置导出过滤文件，保证配置文件的输出

<!--过滤文件，保证输出配置文件-->
<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
        </resource>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
        </resource>
    </resources>
</build>

新建pojo类 User

package com.tioxy.pojo;

public class User {
    private int id;
    private String name;
    private String pwd;

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name=‘" + name + ‘‘‘ +
                ", pwd=‘" + pwd + ‘‘‘ +
                ‘}‘;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }

    public User() {
    }
}

创建实现类接口 UserMapper

import com.tioxy.pojo.User;

import java.util.List;

public interface UserMapper {
    List<User> selectUser();
}

创建 UserMapper.xml 文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.tioxy.mapper.UserMapper">
    <select id="selectUser" resultType="user">
        select * from user ;
    </select>
</mapper>

MyBatis-Spring介绍

MyBatis-Spring 会帮助你将 MyBatis 代码无缝地整合到 Spring 中。它将允许 MyBatis 参与到 Spring 的事务管理之中，创建映射器 mapper 和 SqlSession 并注入到 bean 中，以及将 Mybatis 的异常转换为 Spring 的 DataAccessException。最终，可以做到应用代码不依赖于 MyBatis，Spring 或 MyBatis-Spring。

只需在pom文件中导入依赖

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.5</version>
</dependency>

我们知道，在原来的Mybatis的学习中，需要构建 SqlSessionFactory 通过 SqlSessionFactory 构建 SqlSession 进行数据库的操作CURD。要和 Spring 一起使用 MyBatis，需要在 Spring 应用上下文中定义至少两样东西：一个 SqlSessionFactory 和至少一个数据映射器类。

在 MyBatis-Spring 中，可使用SqlSessionFactoryBean来创建 SqlSessionFactory。只需要把下面代码放在 Spring 的 XML 配置文件中：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource" />
</bean>

其中dataSource是连接数据库的数据源，这可以是任意的 DataSource，只需要和配置其它 Spring 数据库连接一样配置它就可以了。

在基础的 MyBatis 用法中，是通过 SqlSessionFactoryBuilder 来创建 SqlSessionFactory 的。而在 MyBatis-Spring 中，则使用 SqlSessionFactoryBean 来创建。

那么 MyBatis 原来的 SqlSession 由 MyBatis-Spring 的核心 SqlSessionTemplate 代替。作为 SqlSession 的一个实现，这意味着可以使用它无缝代替你代码中已经在使用的 SqlSession。只需在Spring 的 XML 配置文件中设置

<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
    <constructor-arg index="0" ref="sqlSessionFactory" />
</bean>

其中引用 sqlSessionFactory 即上面配置的 SqlSessionFactoryBean。

两种实现方式

1.第一种方式

首先引入Spring配置文件，这里起名 spring-dao.xml。

引入数据源

<!--DataSources:使用Spring的数据源替换Mybatis的配置
    这里使用Spring提供的JDBC
    -->
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    <property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/school?serverTimezone=UTC&amp;useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=True"/>
    <property name="username" value="root"/>
    <property name="password" value="970628"/>
</bean>

注意 driverClassName 属性值，即数据库连接驱动，mysql8.0以上的而是用 com.mysql.cj.jdbc.Driver 这个数据源，并且导入的数据库连接驱动包要与本地环境匹配。

创建 sqlSessionFactory 并关联 DataSource

<!--sqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource" />
    <!--绑定mybatis配置文件-->
    <property name="configLocation" value="classpath:mybatis-config.xml"/>
    <property name="mapperLocations" value="classpath:com/tioxy/mapper/*.xml"/>
</bean>

注意：我们一般配置 sqlSessionFactory，还需要配置两个属性，一个是 configLocation ，作用是绑定mybatis配置文件，它在需要修改 MyBatis 的基础配置非常有用，一些特殊的 mybatis 配置需要单独引用，比如 < typeAliases> 起别名等配置。
还有一个是 mapperLocations，注册我们的 mapper。

注册sqlSessionTemplate，关联sqlSessionFactory

<!--SqlSessionTemplate：就是我们使用的sqlSession-->
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
    <!--只能用构造器注入sqlSessionFactory，因为没有set方法-->
    <constructor-arg index="0" ref="sqlSessionFactory"/>
</bean>

与基础的 MyBatis 不同的是，需要创建Mapper接口的实现类，并私有化 SqlSessionTemplate，通过set方法设置。

public class UserMapperImpl implements UserMapper{
    // 原来的所有操作都使用的是sqlSession来执行，现在使用SqlSessionTemplate来实现
    private SqlSessionTemplate sqlSession;

    public void setSqlSession(SqlSessionTemplate sqlSession) {
        this.sqlSession = sqlSession;
    }

    @Override
    public List<User> selectUser() {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        return mapper.selectUser();
    }
}

注册 Mapper 接口的实现类 bean,并关联 sqlSession

<!--第一种-->
<bean id="userMapper" class="com.tioxy.mapper.UserMapperImpl">
    <property name="sqlSession" ref="sqlSession"/>
</bean>

测试

public class MyTest {
    @Test
    public void selectUserTest() throws IOException {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserMapper userMapper = context.getBean("userMapper2", UserMapper.class);
        for (User user : userMapper.selectUser()) {
            System.out.println(user);
        }
    }
}

我这里创建了一个整合的Spring配置文件 applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="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">

    <!--操作数据库配置文件-->
    <import resource="spring-dao.xml"/>

    <!--第一种-->
    <bean id="userMapper" class="com.tioxy.mapper.UserMapperImpl">
        <property name="sqlSession" ref="sqlSession"/>
    </bean>
</beans>

2.第二种方式

Mapper继承Support类 , 直接利用 getSqlSession() 获得 , 然后直接注入SqlSessionFactory . 比起方式1 , 不需要管理SqlSessionTemplate , 而且对事务的支持更加友好 . 可在官方文档中查看

基础设置不变，我们新建一个UserMapper实现类 UserMapperImpl2

import com.tioxy.pojo.User;
import org.mybatis.spring.support.SqlSessionDaoSupport;

import java.util.List;

public class UserMapperImpl2 extends SqlSessionDaoSupport implements UserMapper{
    @Override
    public List<User> selectUser() {
        return getSqlSession().getMapper(UserMapper.class).selectUser();
    }
}

注册bean，这里直接关联 sqlSessionFactory ，那么在原来的注册 SqlSessionTemplate 配置就不需要了

<!--第二种-->
<bean id="userMapper2" class="com.tioxy.mapper.UserMapperImpl2">
    <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>

最后测试，同方式一

总结

以上就是我们两种 Spring 与 Mybatis 的整合方式，以后可以完全不要mybatis的配置文件，方便简单，配置更加灵活。其后还可以直接使用注解来实现整合，等学习到 SpringBoot 后再来研究。

引用地址：
狂神说Java Sring整合MyBatis：https://www.bilibili.com/video/BV1WE411d7Dv?p=24