【Spring】使用Spring整合Mybatis 和聲明式事務

整合Mybatis 和事務：聲明式事務

本文介紹了如何整合Mybatis與Spring框架實現聲明式事務管理。主要內容包括：
1）導入必要的依賴包，包括Mybatis、Spring、AspectJ等；
2）配置Spring數據源替代Mybatis配置；
3）通過SqlSessionFactoryBean和SqlSessionTemplate實現整合；
4）編寫Mapper接口及其實現類。
使用Spring的JDBC數據源配置，并通過XML方式注入SqlSessionFactory和SqlSessionTemplate。

整合Mybatis

使用Spring思想整合Mybatis模塊

步驟：

導入相關jar包
1. junit

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.12</version>
</dependency>

2. mybatis

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.5.2</version>
</dependency>

3. mysql-connector-java

<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.47</version>
</dependency>

4. spring相關

注意自身的jdk版本：jdk 1.8能夠使用的最高的release版本為 5.3.30

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-webmvc</artifactId>
  <version>5.1.10.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-jdbc</artifactId>
  <version>5.1.10.RELEASE</version>
</dependency>

5. aspectJ AOP 織入器

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

6. mybatis-spring整合包 【重點】

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

7. 配置Maven靜態資源過濾問題！

選擇要掃描加載的路徑

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

編寫配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd">
    
    <!--
    DataSource：
    使用 Spring的數據源替換Mybatis的配置 c3p0、dbcp、druid
    jdbc：org.springframework.jdbc.datasource.DriverManagerDataSource
    c3p0：com.mchange.v2.c3p0.ComboPooledDataSource
    dbcp：org.apache.commons.dbcp2.BasicDataSource
    druid：com.alibaba.druid.pool.DruidDataSource
    此處使用Spring提供的JDBC：org.springframework.jdbc.datasource
      -->
    <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/training_mysql?useUnicode=true&amp;characterEncoding=utf8"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
    </bean>
    
    
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!--    SqlSessionFactoryBean.setDataSource 注入   -->
        <property name="dataSource" ref="dataSource"/>
        
        <!--    綁定mybatis的配置文件    -->
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <property name="mapperLocations" value="classpath:com/demo/mapper/*.xml"/>
    </bean>
    
    <!--  SqlSessionTemplate 我們使用的 sqlSession  -->
    <bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
        <!--    只能使用構造器注入，SqlSessionTemplate因為沒有sqlSessionFactory的setter方法    -->
        <constructor-arg index="0" ref="sqlSessionFactory"/>
    </bean>
    
    <bean id="userService" class="com.demo.service.UserServiceImpl">
        <property name="sqlSessionTemplate" ref="sqlSession"/>
    </bean>
    
    <!--    注入 SqlSessionTemplate  -->
    <bean id="userMapper" class="com.demo.mapper.UserMapperImpl">
        <property name="sqlSession" ref="sqlSession"/>
    </bean>
    
    <bean id="userMapperR" class="com.demo.mapper.UserMapperRImpl">
        <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
    </bean>

</beans>

<?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>
    
    <typeAliases>
        <package name="com.demo.pojo.User"/>
    </typeAliases>

</configuration>

代碼實現

src/main/java/com/demo/mapper/UserMapper.java 接口

src/main/java/com/demo/mapper/UserMapper.xml Mybatis實現

src/main/java/com/demo/mapper/UserMapperImpl.java 實現類

1. 回憶MyBatis

編寫pojo實體類

package com.kuang.pojo;

public class User {
    private int id;  //id
    private String name;   //姓名
    private String pwd;   //密碼
}

實現mybatis的配置文件

<?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>

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

  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
      </dataSource>
    </environment>
  </environments>

  <mappers>
    <package name="com.demo.dao"/>
  </mappers>
</configuration>

UserDao接口編寫

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

接口對應的Mapper映射文件

<?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="com.kuang.dao.UserMapper">

  <select id="selectUser" resultType="User">
    select * from user
  </select>

</mapper>

測試類

@Test
public void selectUser() throws IOException {

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();

UserMapper mapper = sqlSession.getMapper(UserMapper.class);

List<User> userList = mapper.selectUser();
for (User user: userList){
    System.out.println(user);
}

sqlSession.close();
}

2. MyBatis-Spring學習

引入Spring之前需要了解mybatis-spring包中的一些重要類；

舊地址： http://www.mybatis.org/spring/zh/index.html

新地址：https://mybatis.org/spring/zh_CN/index.html

什么是 MyBatis-Spring？

MyBatis-Spring 會幫助你將 MyBatis 代碼無縫地整合到 Spring 中。

知識基礎

在開始使用 MyBatis-Spring 之前，你需要先熟悉 Spring 和 MyBatis 這兩個框架和有關它們的術語。這很重要

MyBatis-Spring 需要以下版本：

MyBatis-Spring	MyBatis	Spring 框架	Spring Batch	Java
3.0	3.5+	6.0+	5.0+	Java 17+
2.0	3.5+	5.0+	4.0+	Java 8+
1.3	3.4+	3.2.2+	2.1+	Java 6+

如果使用 Maven 作為構建工具，僅需要在 pom.xml 中加入以下代碼即可：

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

要和 Spring 一起使用 MyBatis，需要在 Spring 應用上下文中定義至少兩樣東西：一個 SqlSessionFactory 和至少一個數據映射器類。

在 MyBatis-Spring 中，可使用 SqlSessionFactoryBean來創建 SqlSessionFactory。要配置這個工廠 bean，只需要把下面代碼放在 Spring 的 XML 配置文件中：

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

注意：SqlSessionFactory 需要一個 DataSource（數據源）。這可以是任意的 DataSource，只需要和配置其它 Spring 數據庫連接一樣配置它就可以了。

在基礎的 MyBatis 用法中，是通過 SqlSessionFactoryBuilder 來創建 SqlSessionFactory 的。而在 MyBatis-Spring 中，則使用 SqlSessionFactoryBean 來創建。

在 MyBatis 中，你可以使用 SqlSessionFactory 來創建 SqlSession。一旦你獲得一個 session 之后，你可以使用它來執行映射了的語句，提交或回滾連接，最后，當不再需要它的時候，你可以關閉 session。

SqlSessionFactory 有一個唯一的必要屬性：用于 JDBC 的 DataSource。這可以是任意的 DataSource 對象，它的配置方法和其它 Spring 數據庫連接是一樣的。

一個常用的屬性是 configLocation，它用來指定 MyBatis 的 XML 配置文件路徑。它在需要修改 MyBatis 的基礎配置非常有用。通常，基礎配置指的是 <settings> 或 <typeAliases> 元素。

需要注意的是，這個配置文件并不需要是一個完整的 MyBatis 配置。確切地說，任何環境配置（<environments>），數據源（<DataSource>）和 MyBatis 的事務管理器（<transactionManager>）都會被忽略。SqlSessionFactoryBean 會創建它自有的 MyBatis 環境配置（Environment），并按要求設置自定義環境的值。

SqlSessionTemplate 是 MyBatis-Spring 的核心。作為 SqlSession 的一個實現，這意味著可以使用它無縫代替你代碼中已經在使用的 SqlSession。

模板可以參與到 Spring 的事務管理中，并且由于其是線程安全的，可以供多個映射器類使用，你應該總是用 SqlSessionTemplate 來替換 MyBatis 默認的 DefaultSqlSession 實現。在同一應用程序中的不同類之間混雜使用可能會引起數據一致性的問題。

可以使用 SqlSessionFactory 作為構造方法的參數來創建 SqlSessionTemplate 對象。

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

現在，這個 bean 就可以直接注入到你的 DAO bean 中了。你需要在你的 bean 中添加一個 SqlSession 屬性，就像下面這樣：

public class UserDaoImpl implements UserDao {

    private SqlSession sqlSession;

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

    public User getUser(String userId) {
        return sqlSession.getMapper...;
    }
}

按下面這樣，注入 SqlSessionTemplate：

<bean id="userDao" class="org.mybatis.spring.sample.dao.UserDaoImpl">
  <property name="sqlSession" ref="sqlSession" />
</bean>

3. 整合實現一 : `SqlSessionTemplate`

引入Spring配置文件beans.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">

配置數據源替換mybaits的數據源

<!--配置數據源：數據源有非常多，可以使用第三方的，也可使使用Spring的-->
<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/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
  <property name="username" value="root"/>
  <property name="password" value="123456"/>
</bean>

配置SqlSessionFactory，關聯MyBatis


<!--配置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/kuang/dao/*.xml"/>
</bean>

注冊sqlSessionTemplate，關聯sqlSessionFactory；


<!--注冊sqlSessionTemplate , 關聯sqlSessionFactory-->
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
  <!--利用構造器注入-->
  <constructor-arg index="0" ref="sqlSessionFactory"/>
</bean>

增加Dao接口的實現類；私有化sqlSessionTemplate

public class UserDaoImpl implements UserMapper {

    //sqlSession不用我們自己創建了，Spring來管理
    private SqlSessionTemplate sqlSession;

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

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

}

注冊bean實現

<bean id="userDao" class="com.kuang.dao.UserDaoImpl">
<property name="sqlSession" ref="sqlSession"/>
</bean>

測試

@Test
public void test2(){
    ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
    UserMapper mapper = (UserMapper) context.getBean("userDao");
    List<User> user = mapper.selectUser();
    System.out.println(user);
}

結果成功輸出！現在我們的Mybatis配置文件的狀態！發現都可以被Spring整合！

<?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>
  <typeAliases>
    <package name="com.demo.pojo"/>
  </typeAliases>
</configuration>

4. 整合實現二 : `SqlSessionDaoSupport`

mybatis-spring1.2.3版以上的才有這個 .

官方文檔截圖 :

dao繼承Support類 , 直接利用 getSqlSession() 獲得 , 然后直接注入SqlSessionFactory . 比起方式1 , 不需要管理SqlSessionTemplate , 而且對事務的支持更加友好 . 可跟蹤源碼查看

原文如下：https://mybatis.org/spring/zh_CN/sqlsession.html#SqlSessionDaoSupport

測試：

將我們上面寫的UserDaoImpl修改一下

public class UserDaoImpl extends SqlSessionDaoSupport implements UserMapper {
    public List<User> selectUser() {
        UserMapper mapper = getSqlSession().getMapper(UserMapper.class);
        return mapper.selectUser();
    }
}

修改bean的配置

<bean id="userDao" class="com.demo.dao.UserDaoImpl">
  <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

測試

@Test
public void test2(){
    ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
    UserMapper mapper = (UserMapper) context.getBean("userDao");
    List<User> user = mapper.selectUser();
    System.out.println(user);
}

總結 : 整合到spring中以后可以完全不要mybatis的配置文件，除了這些方式可以實現整合之外，我們還可以使用注解來實現，SpringBoot的時候都是這樣。

Mybatis-Plus 更簡單！！

聲明式事務

1、回顧事務

事務在項目開發過程非常重要，涉及到數據的一致性的問題，不容馬虎！
事務管理是企業級應用程序開發中必備技術，用來確保數據的完整性和一致性。

:::warning
事務就是把一系列的動作當成一個獨立的工作單元，這些動作要么全部完成，要么全部不起作用。

:::

事務四個屬性ACID

原子性（atomicity）
- 事務是原子性操作，由一系列動作組成，事務的原子性確保動作要么全部完成，要么完全不起作用；
一致性（consistency）
- 一旦所有事務動作完成，事務就要被提交。數據和資源處于一種滿足業務規則的一致性狀態中；
隔離性（isolation）
- 可能多個事務會同時處理相同的數據資源，因此每個事務都應該與其他事務隔離開來，防止數據損壞****；
持久性（durability）
- 事務一旦完成，無論系統發生什么錯誤，結果都不會受到影響。通常情況下，事務的結果被寫到持久化存儲器中；

2、測試

將上面的代碼拷貝到一個新項目中

在之前的案例中，我們給userDao接口新增兩個方法，刪除和增加用戶；

//添加一個用戶
int addUser(User user);

//根據id刪除用戶
int deleteUser(int id);

mapper文件，我們故意把 deletes 寫錯，測試！

<insert id="addUser" parameterType="com.kuang.pojo.User">
  insert into user (id,name,pwd) values (#{id},#{name},#{pwd})
</insert>

<delete id="deleteUser" parameterType="int">
  deletes from user where id = #{id}
</delete>

編寫接口的實現類，在實現類中，我們去操作一波

public class UserDaoImpl extends SqlSessionDaoSupport implements UserMapper {

    //增加一些操作
    public List<User> selectUser() {
        User user = new User(4,"小明","123456");
        UserMapper mapper = getSqlSession().getMapper(UserMapper.class);
        mapper.addUser(user);
        mapper.deleteUser(4);
        return mapper.selectUser();
    }

    //新增
    public int addUser(User user) {
        UserMapper mapper = getSqlSession().getMapper(UserMapper.class);
        return mapper.addUser(user);
    }
    //刪除
    public int deleteUser(int id) {
        UserMapper mapper = getSqlSession().getMapper(UserMapper.class);
        return mapper.deleteUser(id);
    }

}

測試

@Test
public void test2(){
    ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
    UserMapper mapper = (UserMapper) context.getBean("userDao");
    List<User> user = mapper.selectUser();
    System.out.println(user);
}

報錯：sql異常，delete寫錯了

結果：插入成功！

沒有進行事務的管理；我們想讓他們都成功才成功，有一個失敗，就都失敗，我們就應該需要事務！

以前我們都需要自己手動管理事務，十分麻煩！

但是Spring給我們提供了事務管理，我們只需要配置即可；

3、Spring中的事務管理

Spring在不同的事務管理API之上定義了一個抽象層，使得開發人員不必了解底層的事務管理API就可以使用Spring的事務管理機制。Spring支持編程式事務管理和聲明式的事務管理。

https://mybatis.org/spring/zh_CN/transactions.html#container

編程式事務管理

將事務管理代碼嵌到業務方法中來控制事務的提交和回滾
缺點：必須在每個事務操作業務邏輯中包含額外的事務管理代碼

聲明式事務管理

一般情況下比編程式事務好用。
將事務管理代碼從業務方法中分離出來，以聲明的方式來實現事務管理。
將事務管理作為橫切關注點，通過aop方法模塊化。Spring中通過Spring AOP框架支持聲明式事務管理。

使用Spring管理事務，注意頭文件的約束導入 : tx

<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd">

事務管理器

無論使用Spring的哪種事務管理策略（編程式或者聲明式）事務管理器都是必須的。
就是 Spring的核心事務管理抽象，管理封裝了一組獨立于技術的方法。

JDBC事務

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>

配置好事務管理器后我們需要去配置事務的通知

<!--配置事務通知-->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
  <tx:attributes>
    <!--配置哪些方法使用什么樣的事務,配置事務的傳播特性-->
    <tx:method name="add" propagation="REQUIRED"/>
    <tx:method name="delete" propagation="REQUIRED"/>
    <tx:method name="update" propagation="REQUIRED"/>
    <tx:method name="search*" propagation="REQUIRED"/>
    <tx:method name="get" read-only="true"/>
    <tx:method name="*" propagation="REQUIRED"/>
  </tx:attributes>
</tx:advice>

spring事務傳播特性：

事務傳播行為就是多個事務方法相互調用時，事務如何在這些方法間傳播。spring支持7種事務傳播行為：

propagation_requierd：如果當前沒有事務，就新建一個事務，如果已存在一個事務中，加入到這個事務中，這是最常見的選擇。
propagation_supports：支持當前事務，如果沒有當前事務，就以非事務方法執行。
propagation_mandatory：使用當前事務，如果沒有當前事務，就拋出異常。
propagation_required_new：新建事務，如果當前存在事務，把當前事務掛起。
propagation_not_supported：以非事務方式執行操作，如果當前存在事務，就把當前事務掛起。
propagation_never：以非事務方式執行操作，如果當前事務存在則拋出異常。
propagation_nested：如果當前存在事務，則在嵌套事務內執行。如果當前沒有事務，則執行與propagation_required類似的操作

Spring 默認的事務傳播行為是 PROPAGATION_REQUIRED，它適合于絕大多數的情況。

假設 ServiceX#methodX() 都工作在事務環境下（即都被 Spring 事務增強了），假設程序中存在如下的調用鏈：Service1#method1()–>Service2#method2()–>Service3#method3()，那么這 3 個服務類的 3 個方法通過 Spring 的事務傳播機制都工作在同一個事務中。

就好比，我們剛才的幾個方法存在調用，所以會被放在一組事務當中！

配置AOP

導入aop的頭文件！

<!--配置aop織入事務-->
<aop:config>
  <aop:pointcut id="txPointcut" expression="execution(* com.kuang.dao.*.*(..))"/>
  <aop:advisor advice-ref="txAdvice" pointcut-ref="txPointcut"/>
</aop:config>

進行測試

刪掉剛才插入的數據，再次測試！

@Test
public void test2(){
    ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
    UserMapper mapper = (UserMapper) context.getBean("userDao");
    List<User> user = mapper.selectUser();
    System.out.println(user);
}

思考問題？

為什么需要配置事務？

如果不配置，就需要我們手動提交控制事務；
事務在項目開發過程非常重要，涉及到數據的一致性的問題，不容馬虎！

posted @ 2025-07-25 12:00 柯基大大閱讀(20) 評論(0) 收藏舉報來源

刷新頁面返回頂部

柯基大大

【Spring】使用Spring整合Mybatis 和 聲明式事務

整合Mybatis 和 事務 ：聲明式事務