Spring整合Mybatis

最近在学Spring，整合MyBatis部分的配置文件有些复杂，为防止自己遗忘这里写一个帖子记录一下。

• 项目结构
  
• pom依赖

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.7.RELEASE</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/junit/junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.5</version>
        </dependency>


        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <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.6</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.3.4</version>
        </dependency>
    </dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

• MyBatis-Configuration.xml（这里的配置还可以写一些其他的setting等，最后可以通过Spring配置文件导入进去。）

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>

    <typeAliases>
        <package name="com.hit.pojo"/>
    </typeAliases>

</configuration>

• Spring-io.xml（主要是一些固定的sqlSession的配置，注册sqlSession。）

<?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:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--    DataSource:使用Spring的数据源替换MyBatis配置，实际上就是使用-->
    <!--    Spring写好的配置类，讲这个类装在成一个bean交给Spring管理-->
    <!--    使用Spring提供的JDBC-->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mybatistest?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
        <property name="username" value="root"/>
        <property name="password" value="password"/>
    </bean>
    <!--    配置sqlSessionFactory-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!--            数据源-->
        <property name="dataSource" ref="dataSource"/>
        <!--            绑定MyBatis配置文件-->
        <property name="configLocation" value="classpath:MyBatis-Configuration.xml"/>
        <property name="mapperLocations" value="classpath:com/hit/dao/*.xml"/>
    </bean>

<!--    这里的sqlSessionTemplete实际上就是我们需要得到sqlSession-->
<!--    由于此类没有set方法，只能通过构造方法注入-->
    <bean name="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
        <constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory"/>
    </bean>
</beans>

• UserMapper.class

package com.hit.dao;
import com.hit.pojo.User;
import java.util.List;
public interface UserMapper {
    public List<User> selectUserList();
}

• UserMapper.xml（与MyBatis配置一致，写SQL的地方）

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hit.dao.UserMapper">
    <select id="selectUserList" resultType="com.hit.pojo.User">
        select * from users;
    </select>
</mapper>

• UserMapperImpl.java（调取Mybatis的SqlSession的地方，实际上通过Spring的容器调取了sqlSession，获取查询结果，相当于堆MyBatis的封装）

package com.hit.dao;

import com.hit.pojo.User;
import org.apache.ibatis.session.SqlSession;
import org.mybatis.spring.SqlSessionTemplate;
import java.util.List;

public class UserMapperImpl implements  UserMapper {

    // 所有方法都是通过SqlSession执行，现在这个类被Spring的SqlSessionTemplate代替了
    private SqlSessionTemplate sqlSession;

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

    // 完成了之前mybatis中测试类需要完成的操作
    public List<User> selectUserList() {
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        return userMapper.selectUserList();
    }
}

• ApplicationContext.xml（配置Spring的地方，可以做一些Impl.java的bean的注册、AOP的配置等，不必考虑MyBatis的配置问题，因为在Impl.java做了封装）

<?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:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop" xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <import resource="Spring-io.xml"/>

    <bean name="userMapper" class="com.hit.dao.UserMapperImpl">
        <property name="sqlSession" ref="sqlSession"/>
    </bean>
</beans>

• UserTest.java

package com.hit.test;

import com.hit.dao.UserMapper;
import com.hit.pojo.User;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.util.List;

public class UserTest {
    @Test
    public void UserTest(){
        ApplicationContext context =
                new ClassPathXmlApplicationContext("ApplicationContext.xml");
        UserMapper userMapper = (UserMapper) context.getBean("userMapper");
        List<User> list = userMapper.selectUserList();
        for (User user : list) {
            System.out.println(user);
        }
    }
}

• User.java

package com.hit.pojo;

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

    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 getPassword() {
        return password;
    }

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

    public User() {
    }

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

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

• 测试结果