04.spring framework的集成mybatis

一、說明

在MyBatis的github官網（https://github.com/mybatis/spring）中有一個叫MyBatis Spring Adapter（MyBatis-Spring）的庫，暫且翻譯成：MyBatis Spring適配器，它的作用是：原話：“MyBatis-Spring adapter is an easy-to-use Spring3 bridge for MyBatis sql mapping framework.”，就是了爲更容易的將MyBatis與Spring整合，充分發揮二兩結合的優勢，它相當於一個橋。

什麼是：MyBatis-Spring?

springframework集成mybatis時，使用MyBatis-Spring，他可以幫助你將 MyBatis 代碼無縫地整合到 Spring 中。 使用這個類庫中的類, Spring 將會加載必要的MyBatis工廠類和 session 類。

• 這個類庫也提供一個簡單的方式來注入MyBatis數據映射器和SqlSession到業務層的bean中。
• 它也會處理事務,
• 翻譯MyBatis的異常到Spring的 DataAccessException異常(數據訪問異常)中。
• 它並不會依賴於MyBatis,Spring或MyBatis-Spring來構建應用程序代碼。

二、Spring4.X整合MyBatis3.X初級版

2.1、修改pom.xml添加依賴

爲了將Spring與MyBatis整合完成，需要依賴如下：

• MyBatis
• Spring核心，AOP，JDBC
• MyBatis-Spring

具體的依賴結果pom.xml文件如下所示：

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="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">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.mzj.springframework</groupId>
  <artifactId>springframework-mybatis</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>springframework-mybatis Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <spring.version>4.3.0.RELEASE</spring.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.38</version>
    </dependency>
    <!--log4j日誌包 -->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.6.1</version>
    </dependency>
    <!-- mybatis ORM框架 -->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.4.1</version>
    </dependency>
    <!-- JUnit單元測試工具 -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.10</version>
    </dependency>

    <!--mybatis-spring適配器 -->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>1.3.0</version>
    </dependency>
    <!--Spring框架核心庫 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <!-- aspectJ AOP 織入器 -->
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjweaver</artifactId>
      <version>1.8.9</version>
    </dependency>
    <!--Spring java數據庫訪問包，在本例中主要用於提供數據源 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>springframework-mybatis</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

2.2、創建Spring上下文初始化配置文件

該文件取名爲ApplicationContext.xml主要原因是“約束優於配置”的理由，使用Web監聽器加載Spring時會默認找該名稱的文件。在文件中我們可像以前學習Spring一樣配置IOC與AOP，只不過這裏整合了一些MyBatis內容。文件內容如下：

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

    <!--1定義一個jdbc數據源，創建一個驅動管理數據源的bean -->
    <bean id="jdbcDataSource"
          class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="com.mysql.jdbc.Driver" />
        <property name="url" value="jdbc:mysql://192.168.10.11:3306/mzj" />
        <property name="username" value="sunjinglei" />
        <property name="password" value="sunjinglei" />
    </bean>

    <!--2創建一個sql會話工廠bean，指定數據源-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="jdbcDataSource" /><!-- 指定數據源 -->
        <property name="configLocation" value="classpath:MyBatisCfg.xml"></property> <!-- 指定配置文件 -->
    </bean>

    <!--3創建一個booTypeDAO-->
    <bean id="bookTypeDao" class="org.mybatis.spring.mapper.MapperFactoryBean">
        <!--指定映射文件 -->
        <property name="mapperInterface" value="com.mzj.springframework.mybatis.mapping.BookTypeDAO"></property>
        <!-- 指定sql會話工廠-->
        <property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
    </bean>
    <!--下面的配置暫時未使用 -->
    <context:component-scan base-package="com.mzj">
    </context:component-scan>
    <aop:aspectj-autoproxy proxy-target-class="true"></aop:aspectj-autoproxy>
</beans>

從上面的代碼可以看到分別創建了一個驅動管理數據源的對象，會話工廠與實現數據訪問的對象通過Spring IOC完成，而不再是硬編碼。第2段配置與下面的代碼功能基本類似：

第3段配置與下面的java代碼基本類似：

本次集成mzj分析：

1、直接從spring容器中獲取業務DAO的實現（這裏是BookTypeDAO接口的實現）
2、不需要我們自己實現業務DAO，由mybatis-spring實現（org.mybatis.spring.mapper.MapperFactoryBean），定義這個對象需要兩個屬性：
    1）mapperInterface：依賴所實現DAO的接口類
    2）sqlSessionFactory：依賴sqlSessionFactory bean
3、在spring ioc聲明SqlSessionFactoryBean
    1）configLocation：依賴mytatis的mapper配置文件
    2）dataSource：依賴dataSource
4、在spring ioc聲明dataSource

 2.3、測試運行

package com.mzj.springframework.mybatis.dao; 

import com.mzj.springframework.mybatis.entities.BookType;
import com.mzj.springframework.mybatis.mapping.BookTypeDAO;
import org.junit.Test;

/** 
* BookTypeDAOImpl Tester. 
* 
* @author <Authors name> 
* @since <pre>六月 23, 2020</pre> 
* @version 1.0 
*/ 
import static org.junit.Assert.assertNotNull;

import java.util.List;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class TestMyBatisSpring01 {
    @Test
    public void test01() {
        //初始化容器
        ApplicationContext ctx=new ClassPathXmlApplicationContext("ApplicationContext.xml");
        //獲得bean
        BookTypeDAO bookTypeDao=ctx.getBean("bookTypeDao",BookTypeDAO.class);
        //訪問數據庫
        List<BookType> booktypes=bookTypeDao.getAllBookTypes();
        for (BookType bookType : booktypes) {
            System.out.println(bookType);
        }
        assertNotNull(booktypes);
    }
}

運行結果：

 三、Spring集成MyBatis升級版

4.1 去掉MyBatisCfg.xml配置文件

在沒有Spring的環境下我們單純使用MyBatis ORM框架時，我們是通過MyBatisCfg.xml完成sqlSessionFactory的構建工作，如果使用Spring則這部分配置的內容可以完全由Spring容器替代，具體實現如下：

XXX

4.2、映射接口類自動掃描配置

 

4.3、引入屬性配置文件db.properties

 

4.4、數據源與連接池

 

4.5、使用SqlSession