MyBatis 入门与高级用法

MyBatis 是一个优秀的持久层框架，它通过 XML 或注解将 SQL 语句与 Java 方法关联起来，提供了比 JDBC 更简洁的数据库操作方式。本文将介绍 MyBatis 的基本用法和一些高级特性。

1. MyBatis 基本用法

1.1 添加依赖

首先，需要在项目中添加 MyBatis 依赖。以 Maven 为例，在 pom.xml 文件中添加以下内容：

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.9</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    <!-- 其他依赖 -->
</dependencies>

1.2 配置文件

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/mydb"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="mybatis/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

1.3 映射文件

映射文件通常放置在 resources 目录下，例如 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="selectUser" parameterType="int" resultType="com.example.model.User">
        SELECT id, name, email
        FROM users
        WHERE id = #{id}
    </select>

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

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

    <delete id="deleteUser" parameterType="int">
        DELETE FROM users
        WHERE id = #{id}
    </delete>

</mapper>

1.4 Java 代码

创建对应的 Mapper 接口和 Model 类。

UserMapper.java

package com.example.mapper;

import com.example.model.User;
import org.apache.ibatis.annotations.*;

public interface UserMapper {
    
    @Select("SELECT * FROM users WHERE id = #{id}")
    User selectUser(int id);

    @Insert("INSERT INTO users(name, email) VALUES(#{name}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insertUser(User user);

    @Update("UPDATE users SET name=#{name}, email=#{email} WHERE id=#{id}")
    void updateUser(User user);

    @Delete("DELETE FROM users WHERE id=#{id}")
    void deleteUser(int id);
}

User.java

package com.example.model;

public class User {
    private int id;
    private String name;
    private String email;

    // Getters and Setters
}

使用 MyBatis

import com.example.mapper.UserMapper;
import com.example.model.User;
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.Reader;

public class MyBatisExample {
    public static void main(String[] args) throws IOException {
        String resource = "mybatis-config.xml";
        Reader reader = Resources.getResourceAsReader(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);

        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper userMapper = session.getMapper(UserMapper.class);
            
            // 插入用户
            User newUser = new User();
            newUser.setName("John Doe");
            newUser.setEmail("[email protected]");
            userMapper.insertUser(newUser);
            System.out.println("Inserted User ID: " + newUser.getId());

            // 查询用户
            User user = userMapper.selectUser(newUser.getId());
            System.out.println("User: " + user.getName() + ", " + user.getEmail());

            // 更新用户
            user.setName("Jane Doe");
            userMapper.updateUser(user);

            // 删除用户
            userMapper.deleteUser(user.getId());
        }
    }
}

2. MyBatis 高级用法

2.1 动态 SQL

MyBatis 提供了强大的动态 SQL 功能，通过 if、choose、when、foreach 等元素，可以动态生成 SQL 语句。

<select id="findUsers" resultType="com.example.model.User">
    SELECT * FROM users
    <where>
        <if test="id != null">
            id = #{id}
        </if>
        <if test="name != null">
            AND name = #{name}
        </if>
    </where>
</select>

2.2 分页查询

分页查询是一个常见需求，可以通过 MyBatis 和数据库的分页功能实现。

<select id="findUsersByPage" resultType="com.example.model.User">
    SELECT * FROM users
    LIMIT #{offset}, #{limit}
</select>

2.3 二级缓存

MyBatis 支持二级缓存，以提高查询性能。二级缓存是跨会话的缓存，需要在映射文件中配置。

<cache/>

在 Mapper 接口或 XML 文件中配置使用缓存：

@CacheNamespace
public interface UserMapper {
    // 方法定义
}

2.4 插件

MyBatis 允许通过插件机制扩展其功能，例如可以编写插件来实现自定义的日志记录、性能监控等。

@Intercepts({
    @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class ExamplePlugin implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 自定义拦截逻辑
        return invocation.proceed();
    }

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

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

在 MyBatis 配置文件中注册插件：

<plugins>
    <plugin interceptor="com.example.plugin.ExamplePlugin">
        <property name="someProperty" value="value"/>
    </plugin>
</plugins>

结论

MyBatis 作为一款灵活且功能强大的持久层框架，可以极大地简化数据库操作。本文介绍了 MyBatis 的基本用法和一些高级特性，包括动态 SQL、分页查询、二级缓存和插件机制。通过这些功能，可以有效地提高开发效率和应用性能。希望本文对你学习和使用 MyBatis 有所帮助。