MyBatis 中使用 Mapper 简化代码的方法

更新时间：2021年01月21日 10:05:45 作者：暮夏有五

这篇文章主要介绍了MyBatis 中使用 Mapper 简化代码的方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

前面文章所写的增删改查是存在问题的。每执行一次 SQL，都要开启一次会话，并且需要提交并关闭，主要问题就是冗余代码过多，模板化代码过多。

例如，我想开发一个 UserDao，可能是下面这样：

简化前的 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;
  }
}

对应的 UserMapper.xml

然后，和这个 UserDao 对应的，还有一个 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>

此时，我们分析这个 UserDao，发现它有很多可以优化的地方。每个方法中都要获取 SqlSession，涉及到增删改的方法，还需要 commit，SqlSession 用完之后，还需要关闭，sqlSession 执行时需要的参数就是方法的参数，sqlSession 要执行的 SQL ，和 XML 中的定义是一一对应的。这是一个模板化程度很高的代码。

简化后的 UserDao

既然模板化程度很高，我们就要去解决它，原理很简单，就是前面 Spring 中所说的动态代理。我们可以将 UserDao 简化成一个接口：

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();
}

使用这个接口，完全可以代替上面的 UserDao，为什么呢？因为这个接口提供了 UserDao 所需要的最核心的东西，根据这个接口，就可以自动生成 UserDao：

首先，UserDao 中定义了 SqlSessionFactory，这是一套固定的代码
UserMapper 所在的包 + UserMapper 类名 + UserMapper 中定义好的方法名，就可以定位到要调用的 SQL
要调用 SqlSession 中的哪个方法，根据定位到的 SQL 节点就能确定

配置并使用

因此，我们在 MyBatis 开发中，实际上不需要自己提供 UserDao 的实现，我们只需要提供一个 UserMapper 即可。然后，我们在 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，并调用它里边的方法：

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 中，默认情况下，Maven 要求我们将 XML 配置、properties 配置等，都放在 resources 目录下，如果我们强行放在 java 目录下，默认情况下，打包的时候这个配置文件会被自动忽略掉。对于这两个问题，我们有两种解决办法：

不忽略 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 的要求来

按照 Maven 的要求来，将 xml 文件放到 resources 目录下，但是，MyBatis 中默认情况下要求，UserMapper.xml 和 UserMapper 接口，必须放在一起，所以，我们需要手动在 resources 目录下，创建一个和 UserMapper 接口相同的目录存放 UserMapper.xml。这样，我们就不需要在 pom.xml 文件中添加配置了，因为这种写法同时满足了 Maven 和 MyBatis 的要求。

到此这篇关于MyBatis 中使用 Mapper 简化代码的方法的文章就介绍到这了,更多相关MyBatis 使用 Mapper 简化代码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Spring boot集成Mybatis的方法教程
这篇文章主要给大家介绍了Spring boot集成Mybatis的方法教程，文中介绍的非常详细，对大家具有一定的参考价值，需要的朋友们下面来一起看看吧。
2017-04-04
基于JVM-jinfo的使用方式
这篇文章主要介绍了JVM-jinfo的使用方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10
Java必须学会的类的继承与多态
这篇文章主要介绍了Java类的继承与多态的相关资料，帮助大家更好的理解和学习Java，感兴趣的朋友可以了解下
2020-08-08
SpringBoot集成Redis实现验证码的简单案例
本文主要介绍了SpringBoot集成Redis实现验证码的简单案例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-08-08
Future与FutureTask接口实现示例详解
这篇文章主要为大家介绍了Future与FutureTask接口实现示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-10-10
springboot整合springsecurity与mybatis-plus的简单实现
Spring Security基于Spring开发，项目中如果使用Spring作为基础，配合Spring Security做权限更加方便，而Shiro需要和Spring进行整合开发。因此作为spring全家桶中的Spring Security在java领域很常用
2021-10-10
Java通过经纬度坐标获取两个点之间的直线距离的示例
这篇文章主要介绍了Java通过经纬度坐标获取两个点之间的直线距离的示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07
java中断机制实例讲解
这篇文章主要介绍了java中断机制实例讲解，用了风趣幽默的讲法，有对这方面不太懂的同学可以研究下
2021-01-01
Java的ConcurrentHashMap中不能存储null的原因解析
众所周知，在Java中Map可以存储null，而ConcurrentHashMap不能存储null值，那么为什么呢？今天通过源码分析给大家详细解读，感兴趣的朋友一起看看吧
2022-07-07
手把手教你用Java实现一套简单的鉴权服务
现今大部分系统都会有自己的鉴权服务，本文介绍了最常用的鉴权服务，就是日常用户的登录登出，需要的朋友们下面随着小编来一起学习学习吧
2021-05-05