深入理解 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 的过程中少走弯路。

相关推荐
后端AI实验室6 分钟前
我用Cursor开发了3个月，整理出这套提效4倍的工作流
java·ai
Java水解34 分钟前
Spring Boot 视图层与模板引擎
spring boot·后端
Java水解42 分钟前
一文搞懂 Spring Boot 默认数据库连接池 HikariCP
spring boot·后端
随风飘的云4 小时前
mysql的innodb引擎对可重复读做了那些优化，可以避免幻读
mysql
码路飞4 小时前
GPT-5.3 Instant 终于学会好好说话了，顺手对比了下同天发布的 Gemini 3.1 Flash-Lite
java·javascript
洋洋技术笔记4 小时前
Spring Boot Web MVC配置详解
spring boot·后端
SimonKing5 小时前
OpenCode AI编程助手如何添加Skills，优化项目！
java·后端·程序员
Seven976 小时前
剑指offer-80、⼆叉树中和为某⼀值的路径(二)
java
怒放吧德德18 小时前
Netty 4.2 入门指南：从概念到第一个程序
java·后端·netty
雨中飘荡的记忆19 小时前
大流量下库存扣减的数据库瓶颈：Redis分片缓存解决方案
java·redis·后端
热门推荐
01GitHub 镜像站点02OpenClaw 使用和管理 MCP 完全指南03OpenClaw + 飞书（Feishu）环境搭建指南04OpenClaw优化飞书API 额度已耗尽问题05Claude Code + GLM4.7 避坑指南：解决 Unable to connect to Anthropic services06Window 10部署openclaw报错node.exe : npm error code 12807Clawdbot部署教程：解决‘gateway token missing’授权问题的完整步骤08小黑课堂计算机二级WPSoffice题库软件下载安装教程（2026年3月最新版）09OpenClaw大龙虾机器人完整安装教程10网站改了域名，如何查找？