深入理解 MyBatis：从创建到使用与核心知识点

A_cot2024-11-06 18:47

一、引言

MyBatis 是一款优秀的持久层框架，它在 Java 开发中扮演着至关重要的角色。它简化了数据库操作，让开发者能够更高效地与数据库进行交互。在这篇博客中，我们将详细介绍 MyBatis 的创建和使用方法，以及其中涉及的关键知识点。

二、MyBatis 的创建步骤

1. 环境准备

首先，确保你的项目是一个 Java 项目，并且已经配置好了合适的开发环境（如 JDK）。你需要在项目的依赖管理文件（如果是 Maven 项目则是 pom.xml）中添加 MyBatis 的依赖。

复制代码 
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>x.x.x</version>
</dependency>

这里的 x.x.x 是 MyBatis 的具体版本号，建议使用稳定版本。

2. 配置 MyBatis

  • 创建配置文件 ：在项目的资源目录（通常是 src/main/resources）下创建 mybatis-config.xml 文件。这个文件是 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>
    <!-- 配置环境，这里可以有多个环境，如开发、测试、生产 -->
    <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/mydb?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
    <!-- 配置映射器 -->
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

在上述配置中：

  • 环境配置：定义了数据库连接的相关参数，包括驱动、URL、用户名和密码。这里使用了 JDBC 事务管理和连接池。
  • 映射器配置 ：指定了 MyBatis 映射文件的位置。这里假设 UserMapper.xml 是用于操作用户表的映射文件，位于 com/example/mapper 包下。

3. 创建实体类

根据数据库中的表结构创建对应的 Java 实体类。例如，如果有一个 users 表，包含 id、username 和 password 字段，那么可以创建如下的 User 实体类：

复制代码 
public class User {
    private int id;
    private String username;
    private String password;

    // 生成 getter 和 setter 方法
    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

4. 创建映射器接口和映射文件

  • 映射器接口 ：创建一个接口，用于定义对数据库的操作方法。例如，对于用户表的操作，可以创建 UserMapper 接口：

    public interface UserMapper {
    User getUserById(int id);
    List<User> getUsers();
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(int id);
    }

  • 映射文件 ：在 src/main/resources 目录下的相应位置（如 com/example/mapper）创建 UserMapper.xml 文件。这个文件将 SQL 语句与映射器接口中的方法进行绑定。

    <?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.example.mapper.UserMapper"> <select id="getUserById" resultMap="userResultMap"> select * from users where id = #{id} </select> <select id="getUsers" resultMap="userResultMap"> select * from users </select> <insert id="insertUser"> insert into users (username, password) values (#{username}, #{password}) </insert> <update id="updateUser"> update users set username = #{username}, password = #{password} where id = #{id} </update> <delete id="deleteUser"> delete from users where id = #{id} </delete>
    复制代码 
      <resultMap id="userResultMap" type="com.example.entity.User">
      <id property="id" column="id"/>
      <result property="username" column="username"/>
      <result property="password" column="password"/>
  </resultMap>
    </mapper>

在映射文件中：

  • namespace：指定了对应的映射器接口的全限定名。
  • select、insert、update、delete 标签 ：分别对应查询、插入、更新和删除操作的 SQL 语句。#{} 是 MyBatis 的参数占位符。
  • resultMap：用于将查询结果映射到实体类对象上。

三、MyBatis 的使用

1. 获取 SqlSessionFactory

在 Java 代码中，首先要获取 SqlSessionFactory。可以通过读取 mybatis-config.xml 文件来创建。

复制代码 
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

2. 使用 SqlSession 执行操作

  • 获取 SqlSession ：使用 SqlSessionFactory 来创建 SqlSession。

    SqlSession sqlSession = sqlSessionFactory.openSession();

  • 执行映射器方法 ：通过 SqlSession 获取映射器接口的实现，并调用其中的方法。

    // 获取 UserMapper 接口的实现
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

    // 查询用户
    User user = userMapper.getUserById(1);
    System.out.println(user.getUsername());

    // 插入用户
    User newUser = new User();
    newUser.setUsername("newuser");
    newUser.setPassword("newpassword");
    userMapper.insertUser(newUser);

    // 更新用户
    User updateUser = new User();
    updateUser.setId(2);
    updateUser.setUsername("updateduser");
    updateUser.setPassword("updatedpassword");
    userMapper.updateUser(updateUser);

    // 删除用户
    userMapper.deleteUser(3);

    // 提交事务（对于增删改操作）
    sqlSession.commit();

    // 关闭 SqlSession
    sqlSession.close();

四、MyBatis 的知识点

1. 动态 SQL

MyBatis 支持动态 SQL，可以根据不同的条件生成不同的 SQL 语句。例如，使用 <if>、<where>、<foreach> 等标签。

复制代码 
<select id="getUsersByCondition" resultMap="userResultMap">
    select * from users
    <where>
        <if test="username!= null">
            and username like '%${username}%'
        </if>
        <if test="minAge!= null">
            and age >= #{minAge}
        </if>
    </where>
</select>

在上述代码中，如果传入了 username 参数，就会在 SQL 语句中添加相应的条件。<where> 标签会自动处理 SQL 中的 and 或 or 关键字，避免多余的条件。

2. 缓存机制

MyBatis 有一级缓存和二级缓存。

  • 一级缓存 ：基于 SqlSession，在同一个 SqlSession 中，多次查询相同的 SQL 语句（参数相同），会直接从缓存中获取结果。
  • 二级缓存 ：基于 Mapper，可以在多个 SqlSession 之间共享缓存。需要在 mybatis-config.xml 和映射器文件中进行配置。

3. 关联查询与结果映射

当涉及到多表关联查询时，MyBatis 提供了多种结果映射方式。例如，一对一、一对多、多对多的关联关系可以通过 <association> 和 <collection> 标签来处理。

假设我们有用户和订单两张表，一个用户可以有多个订单。在 UserMapper.xml 中可以这样配置：

复制代码 
<resultMap id="userWithOrdersResultMap" type="com.example.entity.User">
    <id property="id" column="id"/>
    <result property="username" column="username"/>
    <collection property="orders" ofType="com.example.entity.Order">
        <id property="orderId" column="order_id"/>
        <result property="orderName" column="order_name"/>
        <result property="userId" column="user_id"/>
    </collection>
</resultMap>

<select id="getUserWithOrdersById" resultMap="userWithOrdersResultMap">
    select u.*, o.* from users u left join orders o on u.id = o.user_id where u.id = #{id}
</select>

4. 插件机制

MyBatis 允许开发者编写插件来扩展其功能。例如，可以编写插件来拦截 SQL 执行过程、修改参数等。

复制代码 
@Intercepts({@Signature(type = Executor.class, method = "update", args = {MappedStatement, Object})})
public class MyPlugin implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 在这里可以对 SQL 执行进行拦截和处理
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        // 设置插件的属性
    }
}

五、总结

MyBatis 是一个功能强大且灵活的持久层框架。通过合理的配置和使用，它能够大大简化数据库操作，提高开发效率。同时，深入理解其核心知识点，如动态 SQL、缓存机制、结果映射和插件机制等，能够让我们更好地利用 MyBatis 来满足复杂的业务需求。希望这篇博客能够帮助你在学习和使用 MyBatis 的过程中少走弯路。

相关推荐
JavaGuide37 分钟前
公司来的新人用字符串存储日期，被组长怒怼了...
后端·mysql
咖啡教室2 小时前
java日常开发笔记和开发问题记录
java
咖啡教室2 小时前
java练习项目记录笔记
java
鱼樱前端3 小时前
maven的基础安装和使用--mac/window版本
java·后端
RainbowSea3 小时前
6. RabbitMQ 死信队列的详细操作编写
java·消息队列·rabbitmq
RainbowSea3 小时前
5. RabbitMQ 消息队列中 Exchanges(交换机) 的详细说明
java·消息队列·rabbitmq
怒放吧德德3 小时前
MySQL篇：MySQL主从集群同步延迟问题
后端·mysql·面试
Eip不易也不e5 小时前
教程之同时安装两个版本的 mysql
mysql
李少兄5 小时前
Unirest：优雅的Java HTTP客户端库
java·开发语言·http
此木|西贝5 小时前
【设计模式】原型模式
java·设计模式·原型模式
热门推荐
01我决定放弃搞 Java 了02DeepSeek各版本说明与优缺点分析03如何在WPS和Word/Excel中直接使用DeepSeek功能04RAG 实践- Ollama+RagFlow 部署本地知识库05本地化部署AI知识库：基于Ollama+DeepSeek+AnythingLLM保姆级教程06从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑07如何本地部署AI智能体平台，带你手搓一个AI Agent08苍穹外卖面试总结09DeepSeek RAGFlow构建本地知识库系统10【芯片封测学习专栏 -- D2D 和 C2C 之间的区别】