零基础手把手教你玩转MyBatis：轻松搞定持久层开发

2023-10-19 09:28:03

MyBatis 入门指南：从零到精通

在软件开发的世界中，持久层是一项至关重要的任务。它负责管理应用程序和数据库之间的交互，处理数据的存储、检索和更新。对于开发人员来说，这可能是一项耗时且容易出错的任务。

MyBatis 应运而生，它是一个强大的持久层框架，专为 Java 开发人员设计，可以极大地简化与数据库的交互。本文将从头到尾引导你了解 MyBatis，让你轻松掌握持久层开发的精髓。

1. 引入 MyBatis 依赖

首先，需要在你的项目中引入 MyBatis 所需的依赖项。以下是如何使用 Maven 添加它：

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

2. 创建核心配置文件

接下来，创建名为 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/my_database"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

3. 创建实体类

实体类是 Java 类，它们表示数据库中的表。每个实体类应具有与表中列相对应的字段，并使用 @Table 和 @Column 注解进行注解。

例如，对于一个名为 User 的表，你可以创建如下实体类：

@Table(name = "user")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Integer id;

    @Column(name = "name")
    private String name;

    @Column(name = "email")
    private String email;

    // 省略其他 getter/setter 方法...
}

4. 创建 Mapper 映射文件

Mapper 映射文件是 XML 文件，它们将实体类与数据库中的表进行映射。它们包含 SQL 语句，用于执行对表的各种操作，如查询、插入、更新和删除。

对于 User 实体类，你可以创建名为 UserMapper.xml 的 Mapper 映射文件：

<?xml version="1.0" encoding="UTF-8"?>
<mapper namespace="com.example.dao.UserMapper">

    <select id="selectAll" resultType="com.example.entity.User">
        SELECT * FROM user
    </select>

    <insert id="insert" parameterType="com.example.entity.User">
        INSERT INTO user (name, email) VALUES (#{name}, #{email})
    </insert>

    <update id="update" parameterType="com.example.entity.User">
        UPDATE user SET name = #{name}, email = #{email} WHERE id = #{id}
    </update>

    <delete id="delete" parameterType="java.lang.Integer">
        DELETE FROM user WHERE id = #{id}
    </delete>

</mapper>

5. 初始化 SessionFactory

在应用程序中，需要初始化 SessionFactory，它负责创建 Session 对象，用于与数据库进行交互。

SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(new InputStreamReader(getClass().getResourceAsStream("/mybatis-config.xml")));

6. 利用 Session 对象操作数据

使用 Session 对象，你可以执行数据库操作，如查询、插入、更新和删除数据。

SqlSession session = factory.openSession();

// 查询所有用户
List<User> users = session.selectList("com.example.dao.UserMapper.selectAll");

// 插入一个新用户
User newUser = new User();
newUser.setName("John Doe");
newUser.setEmail("john.doe@example.com");
session.insert("com.example.dao.UserMapper.insert", newUser);

// 更新一个现有用户
User user = session.selectOne("com.example.dao.UserMapper.selectById", 1);
user.setName("John Smith");
session.update("com.example.dao.UserMapper.update", user);

// 删除一个用户
session.delete("com.example.dao.UserMapper.delete", 1);

session.commit();

7. 单元测试

单元测试对于确保 MyBatis 代码的正确性至关重要。你可以使用像 JUnit 这样的框架来编写单元测试。

@Test
public void testSelectAll() {
    SqlSession session = factory.openSession();
    List<User> users = session.selectList("com.example.dao.UserMapper.selectAll");
    assertEquals(3, users.size());
}

@Test
public void testInsert() {
    SqlSession session = factory.openSession();
    User newUser = new User();
    newUser.setName("John Doe");
    newUser.setEmail("john.doe@example.com");
    session.insert("com.example.dao.UserMapper.insert", newUser);
    session.commit();
    assertEquals(1, session.selectOne("com.example.dao.UserMapper.selectById", newUser.getId()));
}