MyBatis入门教程指南

帮助文档
MyBatis入门教程指南
来源：www.jcwlyf.com浏览：25更新：2025-11-05

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java 对象)映射成数据库中的记录。本教程将带领你逐步入门 MyBatis，让你快速掌握其基本使用方法。

1. 环境准备

在开始使用 MyBatis 之前，我们需要搭建好开发环境。首先，你需要安装 Java 开发工具包（JDK），建议使用 JDK 8 及以上版本。其次，你需要一个集成开发环境（IDE），如 IntelliJ IDEA 或 Eclipse。最后，我们需要引入 MyBatis 的依赖。如果你使用 Maven 进行项目管理，可以在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.9</version>
</dependency>

如果你使用 Gradle，可以在 build.gradle 文件中添加以下依赖：

implementation 'org.mybatis:mybatis:3.5.9'

2. 数据库准备

为了演示 MyBatis 的使用，我们需要创建一个简单的数据库和表。假设我们使用 MySQL 数据库，创建一个名为 mybatis_demo 的数据库，并在其中创建一个名为 users 的表，表结构如下：

CREATE DATABASE mybatis_demo;

USE mybatis_demo;

CREATE TABLE users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(50) NOT NULL,
    age INT
);

3. 创建 Java 实体类

在 Java 项目中，我们需要创建一个与数据库表对应的实体类。在这个例子中，我们创建一个 User 类，代码如下：

public class User {
    private Integer id;
    private String name;
    private Integer age;

    // 构造方法、Getter 和 Setter 方法
    public User() {}

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

4. 创建 MyBatis 配置文件

MyBatis 需要一个配置文件来配置数据库连接、映射文件等信息。创建一个名为 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/mybatis_demo"/>
                <property name="username" value="root"/>
                <property name="password" value="your_password"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="UserMapper.xml"/>
    </mappers>
</configuration>

在上述配置文件中，我们配置了数据库连接信息和映射文件的位置。需要注意的是，你需要将 your_password 替换为你自己的数据库密码。

5. 创建映射文件

映射文件用于定义 SQL 语句和 Java 方法的映射关系。创建一个名为 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.example.mapper.UserMapper">
    <insert id="insertUser" parameterType="com.example.entity.User">
        INSERT INTO users (name, age) VALUES (#{name}, #{age})
    </insert>
    <select id="getUserById" parameterType="int" resultType="com.example.entity.User">
        SELECT * FROM users WHERE id = #{id}
    </select>
    <update id="updateUser" parameterType="com.example.entity.User">
        UPDATE users SET name = #{name}, age = #{age} WHERE id = #{id}
    </update>
    <delete id="deleteUser" parameterType="int">
        DELETE FROM users WHERE id = #{id}
    </delete>
</mapper>

在这个映射文件中，我们定义了四个 SQL 语句：添加、查询、更新和删除。每个 SQL 语句都有一个唯一的 id，用于在 Java 代码中调用。

6. 创建 Mapper 接口

为了方便调用映射文件中的 SQL 语句，我们可以创建一个 Mapper 接口。创建一个名为 UserMapper 的接口，代码如下：

package com.example.mapper;

import com.example.entity.User;

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

这个接口中的方法名和参数类型需要与映射文件中的 id 和 parameterType 保持一致。

7. 使用 MyBatis 进行数据库操作

最后，我们可以编写 Java 代码来使用 MyBatis 进行数据库操作。以下是一个简单的示例：

import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.InputStream;

public class MyBatisExample {
    public static void main(String[] args) throws Exception {
        // 加载 MyBatis 配置文件
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        // 打开会话
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper userMapper = session.getMapper(UserMapper.class);

            // 添加用户
            User user = new User("John", 25);
            userMapper.insertUser(user);
            session.commit();

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

            // 更新用户
            retrievedUser.setName("Jane");
            retrievedUser.setAge(26);
            userMapper.updateUser(retrievedUser);
            session.commit();

            // 删除用户
            userMapper.deleteUser(retrievedUser.getId());
            session.commit();
        }
    }
}

在这个示例中，我们首先加载 MyBatis 配置文件，创建 SqlSessionFactory 对象。然后打开一个会话，通过会话获取 Mapper 接口的实例。最后，我们可以调用 Mapper 接口中的方法进行数据库操作，并通过 session.commit() 方法提交事务。

总结

通过以上步骤，我们完成了 MyBatis 的入门教程。你学会了如何搭建 MyBatis 开发环境、创建实体类、配置文件、映射文件和 Mapper 接口，以及如何使用 MyBatis 进行数据库操作。MyBatis 提供了一种简单而强大的方式来处理数据库操作，希望本教程能帮助你快速上手 MyBatis。在实际开发中，你还可以进一步学习 MyBatis 的高级特性，如动态 SQL、注解方式等，以提高开发效率。