MyBatis 入门详解

一、简介

1. 什么是 MyBatis

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO（Plain Old Java Objects，普通的 Java 对象）为数据库中的记录。

2. MyBatis 的特点

• 轻量级框架：与 Hibernate 等全功能 ORM 框架相比，MyBatis 更轻量、更灵活。
• SQL 显式控制：通过 XML 文件或注解的方式编写 SQL，便于优化和调试。
• 低学习成本：MyBatis 的配置和使用都比较简单，适合快速上手。
• 支持动态 SQL：通过 XML 或注解的方式可以方便地编写动态 SQL 语句。

二、MyBatis 环境搭建

1. 项目依赖

在使用 MyBatis 之前，需要在项目中添加相应的依赖。以下是 Maven 项目的依赖配置：

<dependencies>
    <!-- MyBatis 依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
    <!-- MyBatis 与 Spring 整合 -->
    <dependency>
        <groupId>org.mybatis.spring</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>2.0.6</version>
    </dependency>
    <!-- Spring 依赖 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.2.9.RELEASE</version>
    </dependency>
</dependencies>

2. 配置文件

MyBatis 的核心配置文件通常命名为 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/mybatis_db"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 映射配置文件 -->
    <mappers>
        <mapper resource="mappers/UserMapper.xml"/>
    </mappers>
</configuration>

3. 实体类和映射文件

实体类

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

映射文件

映射文件通常放置在 resources/mapper 目录下，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">

    <!-- 查询所有用户 -->
    <select id="findAll" resultType="com.example.model.User">
        SELECT * FROM users;
    </select>

    <!-- 根据 ID 查询用户 -->
    <select id="findById" parameterType="int" resultType="com.example.model.User">
        SELECT * FROM users WHERE id = #{id};
    </select>

    <!-- 插入用户 -->
    <insert id="insert" parameterType="com.example.model.User">
        INSERT INTO users (name, age) VALUES (#{name}, #{age});
    </insert>

    <!-- 更新用户 -->
    <update id="update" parameterType="com.example.model.User">
        UPDATE users SET name = #{name}, age = #{age} WHERE id = #{id};
    </update>

    <!-- 删除用户 -->
    <delete id="delete" parameterType="int">
        DELETE FROM users WHERE id = #{id};
    </delete>

</mapper>

4. DAO 层接口

public interface UserMapper {
    List<User> findAll();
    User findById(int id);
    void insert(User user);
    void update(User user);
    void delete(int id);
}

5. MyBatis 工具类

为了方便使用 MyBatis，我们可以编写一个工具类来获取 SqlSession：

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.IOException;
import java.io.InputStream;

public class MyBatisUtil {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        String resource = "mybatis-config.xml";
        try (InputStream inputStream = Resources.getResourceAsStream(resource)) {
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

6. 测试 MyBatis

编写一个测试类来测试 MyBatis 的功能：

import com.example.mapper.UserMapper;
import com.example.model.User;
import org.apache.ibatis.session.SqlSession;

import java.util.List;

public class MyBatisTest {
    public static void main(String[] args) {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

            // 插入用户
            User newUser = new User();
            newUser.setName("John Doe");
            newUser.setAge(25);
            userMapper.insert(newUser);
            sqlSession.commit();

            // 查询所有用户
            List<User> users = userMapper.findAll();
            users.forEach(user -> System.out.println(user.getName()));

            // 根据 ID 查询用户
            User user = userMapper.findById(1);
            System.out.println(user.getName());

            // 更新用户
            user.setName("Jane Doe");
            userMapper.update(user);
            sqlSession.commit();

            // 删除用户
            userMapper.delete(1);
            sqlSession.commit();
        }
    }
}

三、总结

以上是 MyBatis 的基本使用方法。从配置环境、编写实体类和映射文件，到实现基本的 CRUD 操作，涵盖了 MyBatis 的主要功能。希望这篇文章能帮助你快速上手 MyBatis，并在项目中灵活运用。

如果你对 MyBatis 有更多的需求，比如分页查询、复杂 SQL 等，可以查阅 MyBatis 的官方文档或相关教程来进一步学习。