MyBatis 中使用 Mapper 簡(jiǎn)化代碼的方法

更新時(shí)間：2021年01月21日 10:05:45 作者：暮夏有五

這篇文章主要介紹了MyBatis 中使用 Mapper 簡(jiǎn)化代碼的方法,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

前面文章所寫(xiě)的增刪改查是存在問(wèn)題的。每執(zhí)行一次 SQL，都要開(kāi)啟一次會(huì)話，并且需要提交并關(guān)閉，主要問(wèn)題就是冗余代碼過(guò)多，模板化代碼過(guò)多。

例如，我想開(kāi)發(fā)一個(gè) UserDao，可能是下面這樣：

簡(jiǎn)化前的 UserDao

public class UserDao {
  
  private SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getInstance();

  public User getUserById(Integer id) {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    User user = (User) sqlSession.selectOne("com.antonio.hello.mybatis.mapper.UserDao.getUserById", id);
    sqlSession.close();
    return user;
  }

  public Integer addUser(User user) {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    int insert = sqlSession.insert("com.antonio.hello.mybatis.mapper.UserDao.addUser", user);
    sqlSession.commit();
    sqlSession.close();
    return insert;
  }

  public Integer addUser2(User user) {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    int insert = sqlSession.insert("com.antonio.hello.mybatis.mapper.UserDao.addUser2", user);
    sqlSession.commit();
    sqlSession.close();
    return insert;
  }

  public Integer deleteUserById(Integer id) {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    int delete = sqlSession.delete("com.antonio.hello.mybatis.mapper.UserDao.deleteUserById", id);
    sqlSession.commit();
    sqlSession.close();
    return delete;
  }

  public Integer updateUser(User user) {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    int delete = sqlSession.delete("com.antonio.hello.mybatis.mapper.UserDao.updateUser", user);
    sqlSession.commit();
    sqlSession.close();
    return delete;
  }

  public List<User> getAllUser() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    List<User> users = sqlSession.selectList("com.antonio.hello.mybatis.mapper.UserDao.getAllUser");
    sqlSession.close();
    return users;
  }
}

對(duì)應(yīng)的 UserMapper.xml

然后，和這個(gè) UserDao 對(duì)應(yīng)的，還有一個(gè) UserMapper.xml：

<?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.antonio.hello.mybatis.mapper.UserDao">

  <select id="getUserById" resultType="com.antonio.hello.mybatis.entity.User">
    select * from user where id=#{id};
  </select>
  
  <insert id="addUser" parameterType="com.antonio.hello.mybatis.entity.User">
    insert into user (username,address) values (#{username},#{address});
  </insert>
  
  <insert id="addUser2" parameterType="com.antonio.hello.mybatis.entity.User">
    <selectKey resultType="java.lang.String" keyProperty="id" order="BEFORE">
      select uuid();
    </selectKey>
    insert into user (id,username,address) values (#{id},#{username},#{address});
  </insert>

  <delete id="deleteUserById" parameterType="java.lang.Integer">
    delete from user where id=#{id}
  </delete>

  <update id="updateUser" parameterType="com.antonio.hello.mybatis.entity.User">
    update user set username = #{username} where id=#{id};
  </update>

  <select id="getAllUser" resultType="com.antonio.hello.mybatis.entity.User">
    select * from user;
  </select>
</mapper>

此時(shí)，我們分析這個(gè) UserDao，發(fā)現(xiàn)它有很多可以優(yōu)化的地方。每個(gè)方法中都要獲取 SqlSession，涉及到增刪改的方法，還需要 commit，SqlSession 用完之后，還需要關(guān)閉，sqlSession 執(zhí)行時(shí)需要的參數(shù)就是方法的參數(shù)，sqlSession 要執(zhí)行的 SQL ，和 XML 中的定義是一一對(duì)應(yīng)的。這是一個(gè)模板化程度很高的代碼。

簡(jiǎn)化后的 UserDao

既然模板化程度很高，我們就要去解決它，原理很簡(jiǎn)單，就是前面 Spring 中所說(shuō)的動(dòng)態(tài)代理。我們可以將 UserDao 簡(jiǎn)化成一個(gè)接口：

package com.antonio.hello.mybatis.mapper;

public interface UserDao {
  
  User getUserById(Integer id);

  Integer addUser(User user);

  Integer addUser2(User user);

  Integer deleteUserById(Integer id);

  Integer updateUser(User user);

  List<User> getAllUser();
}

使用這個(gè)接口，完全可以代替上面的 UserDao，為什么呢？因?yàn)檫@個(gè)接口提供了 UserDao 所需要的最核心的東西，根據(jù)這個(gè)接口，就可以自動(dòng)生成 UserDao：

首先，UserDao 中定義了 SqlSessionFactory，這是一套固定的代碼
UserMapper 所在的包 + UserMapper 類名 + UserMapper 中定義好的方法名，就可以定位到要調(diào)用的 SQL
要調(diào)用 SqlSession 中的哪個(gè)方法，根據(jù)定位到的 SQL 節(jié)點(diǎn)就能確定

配置并使用

因此，我們?cè)?MyBatis 開(kāi)發(fā)中，實(shí)際上不需要自己提供 UserDao 的實(shí)現(xiàn)，我們只需要提供一個(gè) UserMapper 即可。然后，我們?cè)?MyBatis 的全局配置中，配置一下 UserMapper：

<?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:///test01?serverTimezone=Asia/Shanghai"/>
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
      </dataSource>
    </environment>
  </environments>
  
  <mappers>
    <package name="com.antonio.hello.mybatis.mapper"/>
  </mappers>
</configuration>

然后，加載配置文件，獲取 UserMapper，并調(diào)用它里邊的方法：

public class Main2 {
  public static void main(String[] args) {
    SqlSessionFactory instance = SqlSessionFactoryUtils.getInstance();
    SqlSession sqlSession = instance.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<User> allUser = mapper.getAllUser();
    System.out.println(allUser);
  }
}

注意，在 Maven 中，默認(rèn)情況下，Maven 要求我們將 XML 配置、properties 配置等，都放在 resources 目錄下，如果我們強(qiáng)行放在 java 目錄下，默認(rèn)情況下，打包的時(shí)候這個(gè)配置文件會(huì)被自動(dòng)忽略掉。對(duì)于這兩個(gè)問(wèn)題，我們有兩種解決辦法：

不忽略 XML 配置：

我們可以在 pom.xml 中，添加如下配置，讓 Maven 不要忽略我在 java 目錄下的 XML 配置：

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

按照 Maven 的要求來(lái)

按照 Maven 的要求來(lái)，將 xml 文件放到 resources 目錄下，但是，MyBatis 中默認(rèn)情況下要求，UserMapper.xml 和 UserMapper 接口，必須放在一起，所以，我們需要手動(dòng)在 resources 目錄下，創(chuàng)建一個(gè)和 UserMapper 接口相同的目錄存放 UserMapper.xml。這樣，我們就不需要在 pom.xml 文件中添加配置了，因?yàn)檫@種寫(xiě)法同時(shí)滿足了 Maven 和 MyBatis 的要求。

到此這篇關(guān)于MyBatis 中使用 Mapper 簡(jiǎn)化代碼的方法的文章就介紹到這了,更多相關(guān)MyBatis 使用 Mapper 簡(jiǎn)化代碼內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: