淺談Mybatis持久化框架在Spring、SSM、SpringBoot整合的演進及簡化過程

TIOXY發表於2020-08-02
MyBatis持久化框架SSMSpring Boot

前言

最近開始了SpringBoot相關知識的學習，作為為目前比較流行、用的比較廣的Spring框架，是每一個Java學習者及從業者都會接觸到一個知識點。作為Spring框架專案，肯定少不了與資料庫持久層的整合。我們在學習Java初始就被灌輸SSM框架(Spring、SpringMVC、Mybatis)，我們大概也只是知道Mybatis是與資料庫打交道的，但這也只是名詞上的理解。

Mybatis具體是什麼？

MyBatis 是一款優秀的持久層框架，它支援自定義 SQL、儲存過程以及高階對映。MyBatis 免除了幾乎所有的 JDBC 程式碼以及設定引數和獲取結果集的工作。MyBatis 可以通過簡單的 XML 或註解來配置和對映原始型別、介面和 Java POJO（Plain Old Java Objects，普通老式 Java 物件）為資料庫中的記錄。

。。。。。。

這裡我就不廢話介紹了，詳細的看官方文件地址：https://mybatis.org/mybatis-3/zh/index.html

到後來開始完整的學習Mybatis、到Spring、SpringMVC、再到SpringBoot都有它的身影，它的使用及配置越來越簡單方便，可能出現這種情況，學到SpringBoot整合Mybatis發現，為什麼要這麼操作？為什麼要寫這個註解？為什麼要新增掃描包配置？那麼這篇文章就是將開始學習Mybatis到現在SpringBoot整合Mybatis的知識串起來，加深印象增加理解。

下面是我往期關於Mybatis知識點的部落格，有興趣的可以看一下。

  1. Mybatis開啟二級快取(全域性快取)的方法
  2. Spring學習之Spring與Mybatis的兩種整合方式
  3. SpringBoot學習之整合Mybatis

首先我也是作為Java的一名初學者，下面文章也是按照從JDBC、Mybatis、Spring、SpringMVC、再到SpringBoot的思路編寫，也是我自己的學習路線中Mybatis由繁到簡的過程。大致分為五個階段，可能後面幾個階段內容可以合併為一個階段，我為了體現Mybatis使用的方便簡化，從而作為一個階段。也可以幫助那些直接學習SpringBoot的同學理解整合Mybatis的遞進過程。如果其中有錯誤之處，也煩請各位大佬給予指正！感謝！

階段一：JDBC

我們在學習Mybatis之前，我們使用JDBC即資料庫連線驅動進行資料庫連線操作。

其大致操作步驟：

  1. 載入驅動 com.mysql.cj.jdbc.Driver
  2. 設定資料庫使用者名稱、密碼及URL
  3. 使用 DriverManager.getConnection(url, userName, passWord) 建立資料庫物件
  4. 建立執行Sql物件 connection.createStatement()
  5. 通過statement物件執行具體的Sql statement.executeQuery(sql)
  6. 最後關閉釋放連線
public static void main(String[] args) throws ClassNotFoundException, SQLException {
    // 1.載入驅動(固定寫法)
    Class.forName("com.mysql.cj.jdbc.Driver");// 注意載入新的驅動，舊的棄用了
    // 2.使用者資訊和url
    String url = "jdbc:mysql://localhost:3306/school?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSl=true";// 注意新增時區引數
    String userName = "root";
    String passWord = "970628";
    // 3.連線成功，資料庫物件
    Connection connection = DriverManager.getConnection(url, userName, passWord);
    // 4.執行sql的物件
    Statement statement = connection.createStatement();
    // 5.執行sql
    String sql= "SELECT * FROM student";
    ResultSet resultSet = statement.executeQuery(sql);
    while (resultSet.next()){
        System.out.println("name="+resultSet.getObject("name"));
    }
    // 6.釋放連結
    resultSet.close();
    statement.close();
    connection.close();
}

JDBC的一些問題：

  • 資料庫連結建立、釋放頻繁造成系統資源浪費從而影響系統效能
  • Sql語句變動比較大，每次變動都需要改動Java程式碼
  • 每個一業務需要編寫大量重複的JDBC程式碼，不宜維護

階段二：Mybatis入門

Mybatis對jdbc的運算元據庫的過程進行封裝，使開發者只需要關注 SQL 本身，而不需要花費精力去處理例如註冊驅動、建立connection、建立statement、手動設定引數、結果集檢索等jdbc繁雜的過程程式碼。

其大致步驟：

  1. 首先匯入MyBatis jar包
  2. 建立 mybatis-config.xml 的核心配置檔案
<?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>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" 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"/>
            </dataSource>
        </environment>
    </environments>
</configuration>
  1. 通過mybatis環境等配置資訊構造SqlSessionFactory即會話工廠，階段一中建立資料庫連線等操作都交給sqlSessionFactory來操作
  2. 由會話工廠建立sqlSession即會話，運算元據庫需要通過sqlSession進行，類似於我們階段一中statement物件
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            // 獲取sqlSessionFactory物件
            String resource="mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 既然有了 SqlSessionFactory，顧名思義，我們可以從中獲得 SqlSession 的例項。
    // SqlSession 提供了在資料庫執行 SQL 命令所需的所有方法。你可以通過 SqlSession 例項來直接執行已對映的 SQL 語句
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}
  1. 建立POJO對應的Mapper介面及對應的Mapper.xml檔案。我們在階段一需要寫Mapper的實現類，需要大量的JDBC操作程式碼，這裡我們通過Mapper.xml檔案實現，滿足SqlSession的呼叫。
public interface StudentMapper {
    // 查詢全部學生
    List<Student> getStudentList();

    // 根據id查詢學生
    Student getStudentById(int id);

    // 插入一個學生
    int addUser(Student student);

}

<?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">
<!--這裡的namespace要與dao下的Mapper名稱一一對應-->
<mapper namespace="com.tioxy.dao.StudentMapper">
    <!--id對應的是Mapper介面中對應的方法-->
    <!--resultType是SQL語句的返回值-->
    <!--parameterType引數型別-->
    <select id="getStudentList" resultType="com.tioxy.pojo.Student">
        select * from school.student
    </select>

    <select id="getStudentById" resultType="com.tioxy.pojo.Student" parameterType="int">
        select * from school.student where id = #{id}
    </select>
    
    <insert id="addUser" parameterType="com.tioxy.pojo.Student" >
        insert into school.student (id,name,password,sex,birthd,address,email) values (#{id},#{name},#{password},#{sex},#{birthd},#{address},#{email});
    </insert>
</mapper>
  1. 在核心配置檔案中註冊Mapper,目的需要告訴 MyBatis 到哪裡去找到這些執行Sql語句

<!--每一個Mapper.xml檔案都需要在mybatis核心配置檔案中註冊-->
<mappers>
    <mapper resource="com/tioxy/dao/StudentMapper.xml"/>
</mappers>
  1. 通過 sqlSession.getMapper()獲取介面對應的執行方法及結果
  2. 關閉連線
public void test(){

    // 第一步，獲取sqlSession物件
    SqlSession sqlSession= MybatisUtils.getSqlSession();
    try {
        // 方式一，getMapper
        StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
        List<Student> studentList = mapper.getStudentList();
        for (Student student : studentList) {
            System.out.println(student);
        }
    }catch (Exception e){
        e.printStackTrace();
    }finally {
        // 關閉sqlSession
        sqlSession.close();
    }
}

階段三：Spring中整合MyBatis

MyBatis-Spring 會幫助你將 MyBatis 程式碼無縫地整合到 Spring 中。它將允許 MyBatis 參與到 Spring 的事務管理之中，建立對映器 mapper 和 SqlSession 並注入到 bean 中，以及將 Mybatis 的異常轉換為 Spring 的 DataAccessException。最終，可以做到應用程式碼不依賴於 MyBatis，Spring 或 MyBatis-Spring。

大致步驟如下:

  1. 匯入 mybatis-spring 依賴包
  2. 在Spring xml檔案中通過Spring的資料來源 DriverManagerDataSource 替換階段二中Mybatis的資料來源
<!--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>
  1. 構建 SqlSessionFactoryBean ,在第二階段Mybatis入門的學習中，需要構建 SqlSessionFactory 通過 SqlSessionFactory 構建 SqlSession 進行資料庫的操作CURD。我們這裡使用SqlSessionFactoryBean來建立 SqlSessionFactory，在Spring 的 XML 配置如下
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource" />
</bean>
  1. 同階段二編寫POJO類及Mapper介面及Mapper.xml檔案並在配置檔案中註冊Mapper
  2. 與基礎的 MyBatis 不同的是，需要建立Mapper介面的實現類，並繼承 SqlSessionDaoSupport，目的是不需要管理SqlSession，而且對事務的支援更加友好
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();
    }
}
  1. 註冊實現類的bean，並關聯 sqlSessionFactory
<bean id="userMapper2" class="com.tioxy.mapper.UserMapperImpl2">
    <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
  1. 通過 ApplicationContext 的 getBean()方法獲取介面並執行方法並返回結果。
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);
    }
}

其中第5步，原理是內建使用了 SqlSessionTemplate ,SqlSessionTemplate 是 MyBatis-Spring 的核心。作為 SqlSession 的一個實現，這意味著可以使用它無縫代替你程式碼中已經在使用的 SqlSession。SqlSessionTemplate 是執行緒安全的，可以被多個 DAO 或對映器所共享使用。構建 SqlSessionTemplate 是 Spring學習之Spring與Mybatis的兩種整合方式 中的第一種整合方式，本文章使用第二種方式。

總的來說，就是 Mybatis 的操作被Spring接管，通過一個個Spring Bean來實現持久層操作。

階段四：SSM中整合MyBatis

其實有的小夥伴在這一階段已經開始使用註解方式進行Mybatis操作，我這裡為了說明Mybatis的整個演進過程，使用配置方式說明

在這一階段與第三階段中使用Mybatis並沒有很大的差別,前四步與第三階段相同，其最大的改進是在Spring註冊bean MapperScannerConfigurer,其最大的作用是通過反射的方式自動的幫我們構造Mapper的實現類，省去我們手動編寫。

<!--配置dao介面掃描包，動態的實現Dao介面可以注入到Spring容器中-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--注入 sqlSessionFactory-->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
        <!--要掃描的包-->
        <property name="basePackage" value="com.tioxy.mapper"/>
    </bean>

接下來就是通過Service層呼叫來實現具體的業務。

所以這一階段與階段三並沒有太大的差別與提升。可能有的小夥伴說，這一階段使用階段三也是可以的，的確如此。其實對於我來說，可能這一階段使用了 MapperScannerConfigurer,算作上一階段的簡化，所以拿出作為階段四，同理，我將使用註解的方式作為第四階段的簡化，所以放作下一階段五。

階段五：SpringBoot整合MyBatis

在這一階段使用註解進行開發，大大簡化了各項配置，使得更加專注於業務及Sql的操作，避免了大量繁瑣的配置。

大致步驟：

  1. 匯入mybatis的啟動器 mybatis-spring-boot-starter
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.3</version>
</dependency>
  1. 在 application.yaml 檔案中配置資料來源,同前幾階段在xml中配置資料來源一樣
spring:
  datasource:
    username: root
    password: 970628
    url: jdbc:mysql://localhost:3306/school?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
  1. 編寫POJO類及Mapper介面及Mapper.xml檔案並在配置檔案中新增Mapper.xml的掃描配置
# 整合Mybatis
mybatis:
  # 別名
  type-aliases-package: com.tioxy.pojo
  # 原來dao與mapper.xml在同一路徑，現在不在同一路徑需要設定下面的引數，目的就是告訴*.xml檔案的路徑
  mapper-locations: classpath:mybatis/mapper/*.xml

在前階段的構建 SqlSessionFactoryBean 以及 SqlSession 全都由Spring幫我們實現，所以這裡我們省去了這幾項配置，只需在Mapper介面上新增@Mapper 註解，表示了這是一個 mybatis 的mapper 類，由Spring幫我們設定，而且也省去了階段四種使用 MapperScannerConfigurer 來建立Mapper對應的介面

這裡我使用Mapper.xml編寫SQL語句，也可以使用註解方式，兩種方式都可以，看個人喜好。我選擇xml檔案的原因是編寫SQL語句靈活、擴充套件性好

如果使用註解方式編寫Sql，則不需要Mapper.xml檔案，也不要設定Mapper.xml的掃描配置，直接在介面的方法中使用 @Select、@Insert等註解

@Mapper
@Repository
public interface UserMapper {
    /**
     * 查詢所有的使用者
     * @return
     */
    @Select("select * from User")
    List<User> queryUserList();
}

這裡面 @Repository，是告訴Spring，這是一個Spring元件，類似於 @Controller、@Service一樣

如果不想在每個方法中都加上 @Mapper 註解，可以直接在SpringBoot主啟動類上新增 @MapperScan註解

@SpringBootApplication
@MapperScan("com.tioxy.mapper")
public class SpringBootMybatisApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootMybatisApplication.class, args);
    }
}
  1. 最後就是通過 @Autowired 自動裝配，獲取介面的各個業務方法進行持久層操作

總結

通過一個個階段的演進，從一開始JDBC，手動建立資料庫連線，建立 statement 執行Sql，這種方式，頻繁開啟關閉資料庫，且Sql與Java程式碼耦合度高，修改Sql需要修改Java程式碼，很不方便，於是通過Mybatis進行封裝，在單獨的xml檔案種統一編寫Sql，大大簡化了操作。Mybatis在不同階段隨著Spring的演進，也在逐漸簡化了各種繁瑣的配置，以及到最後的SpringBoot中，不再需要手動建立 SqlSessionFactoryBean、SqlSession 以及Mapper的實現類，通過註解操作，使得更加專注於業務及Sql的編寫。當然在Java的體系中，持久化框架不只是Mybatis，還有Hibernate、TopLink、dbutils、Spring Data，其大致原理相似，這就需要根據實際開發及個人習慣進行選擇。

編寫不易，轉載請註明出處
如有不當之處，感謝指正！

相關文章