正文

Java开源框架MyBatis深度解析：快速上手，高效应用技巧

/0 浏览量
0729

MyBatis 是一个优秀的持久层框架，它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射，将接口和 Java 的 POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。

MyBatis 简介

MyBatis 的核心是 SQL 映射文件，XML 文件中定义了 SQL 语句和映射规则。MyBatis 也支持注解方式，将映射规则直接写在 Java 接口中。MyBatis 可以与任何 JDBC 兼容的数据源一起使用，并且支持自定义类型处理器和插件。

快速上手

1. 环境搭建

首先，需要在项目中添加 MyBatis 依赖。以下是 Maven 依赖配置：

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis.caches</groupId>
        <artifactId>mybatis-redis</artifactId>
        <version>1.0.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.26</version>
    </dependency>
</dependencies>

2. 配置文件

创建 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?useSSL=false&serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

3. 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="selectById" resultType="com.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

4. 接口

创建 UserMapper 接口，定义对应的 SQL 语句：

package com.example.mapper;

public interface UserMapper {
    User selectById(Integer id);
}

5. 使用 MyBatis

在项目中创建 SqlSessionFactory 和 SqlSession，然后使用 SqlSession 执行 SQL 语句：

package com.example.mapper;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

public class MyBatisDemo {
    public static void main(String[] args) {
        try (SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory();
             SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper userMapper = session.getMapper(UserMapper.class);
            User user = userMapper.selectById(1);
            System.out.println(user);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

高效应用技巧

1. 使用注解

使用注解可以减少 XML 配置，使代码更加简洁。例如，将 XML 映射文件中的 <select> 标签改为注解形式：

package com.example.mapper;

import org.apache.ibatis.annotations.Select;
import com.example.entity.User;

public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User selectById(Integer id);
}

2. 使用动态 SQL

MyBatis 支持动态 SQL，可以根据条件动态拼接 SQL 语句。例如，使用 <if> 标签实现条件查询：

<select id="selectByCondition" resultType="com.example.entity.User">
    SELECT * FROM user
    <where>
        <if test="username != null">
            AND username = #{username}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </where>
</select>

3. 使用缓存

MyBatis 支持一级缓存和二级缓存。一级缓存默认开启，用于同一个 SqlSession 中对相同 SQL 语句的重复查询。二级缓存可以跨 SqlSession，但需要手动开启和配置。

<cache eviction="FIFO" flushInterval="60000" size="512" readOnly="true"/>

4. 使用插件

MyBatis 支持自定义插件，可以扩展 MyBatis 的功能。例如，自定义一个分页插件：

package com.example.plugin;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;

import java.sql.Connection;

@Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})})
public class PaginationInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 获取 StatementHandler
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        // 获取原始 SQL 语句
        String originalSql = statementHandler.getBoundSql().getSql();
        // 拼接分页 SQL 语句
        String pageSql = "SELECT * FROM (" + originalSql + ") page_table LIMIT #{offset}, #{limit}";
        // 替换原始 SQL 语句
        statementHandler.getBoundSql().setSql(pageSql);
        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Map<String, Object> properties) {
    }
}

在 mybatis-config.xml 中配置插件：

<plugins>
    <plugin interceptor="com.example.plugin.PaginationInterceptor"/>
</plugins>

总结

MyBatis 是一个功能强大、灵活易用的持久层框架。通过本文的介绍，相信你已经对 MyBatis 有了一定的了解。在实际项目中，合理运用 MyBatis 的特性，可以提高开发效率，简化数据库操作。

-- 展开阅读全文 --