MyIbatis：手搓MyBatis，实现企业级ORM框架功能

SRNCS

1168人浏览 · 2025-09-01 00:18:53

SRNCS · 2025-09-01 00:18:53 发布

MyIbatis：一个轻量级的MyBatis框架实现

项目简介

MyIbatis 是一个基于 Java 的轻量级 ORM（对象关系映射）框架，灵感来源于 MyBatis。该项目旨在通过简化的设计和清晰的架构，帮助开发者理解 MyBatis 的核心工作原理，包括 SQL 解析、参数处理、结果映射、事务管理以及连接池等关键功能。

本项目完全使用 Java 编写，不依赖任何第三方 ORM 框架，仅使用了 Apache Commons BeanUtils 来辅助属性拷贝。它支持常见的数据库操作（CRUD），并提供了注解驱动的开发方式，使得数据库操作更加简洁高效。

核心功能

1. 注解驱动的 SQL 映射

使用自定义注解 @Select, @Insert, @Update, @Delete 直接在接口方法上定义 SQL。
支持动态参数绑定（如 #{name}）。
支持多种参数类型：
- 单个简单类型（如 Integer id）
- 实体类（如 Goods goods）
- Map 类型（如 Map<String, Object> map）
- 多个参数（需配合 @Param注解）

@Select("SELECT * FROM tb_goods WHERE id = #{id}")
Goods selectById(Integer id);

@Update("UPDATE tb_goods SET name = #{name} WHERE id = #{id}")
int update(Goods goods);

2. SQL 解析与参数处理

SqlParser 负责解析 SQL 中的 #{} 占位符，并将其替换为 ?，同时提取参数列表。
支持从实体类、Map 或多个参数中提取字段值。
自动将驼峰命名转换为下划线命名（如 userName → user_name），适配数据库字段名。

3. 返回主键和批量删除

支持在@update注解中开启返回自增主键，给 Java 对象注入主键。
支持在@delete注解标识的方法中传入列表，通过SqlParser 将 SQL 语句中的IN(${ids})自动解析为IN(?, ?, ?...)从而实现简便的批量删除功能。

3. 结果集映射

ResultParser 将数据库返回的结果集映射到 Java 对象中。
支持多种返回类型：
- 单个实体对象（Bean）
- 列表（List<Bean>）
- Map（Map<String, Object>）
- 基本数据类型（如 Long, String）
支持自增主键的自动回填。

4. 事务管理

提供 beginTransaction(), commit(), rollback() 方法控制事务。
支持手动提交或自动提交模式。

5. 连接池

内置简易实现的连接池 MyDataSource，支持初始化连接数和动态扩容。
避免频繁创建和关闭数据库连接，提升性能。

6. 缓存机制

一级缓存：每个 SqlSession 内部维护一个 ConcurrentHashMap，缓存 SQL + 参数组合的结果。
二级缓存：全局共享的 SecondCaches，支持根据表名清除相关缓存，避免脏读。

项目架构

项目采用分层架构设计：

会话层：SqlSessionManager、DefaultSqlSession
解析层：SqlParser、ExecuteParser、ResultParser
模型层：Config、MyDataSource、SecondCaches
注解层：Select、Insert、Update、Delete、Param
工具层：ReflectUtils、dbUtils

以下是项目的整体架构流程图：

+-------------------+
|   Config          |
+--------+----------+
         |
         | 读取配置
         v
+--------v----------+
| SqlSessionFactory |
+--------+----------+
         |
         | 加载jdbc.properties
         v
+--------v----------+
|   MyDataSource    |
+--------+----------+
         |
         | 获取连接
         v
+--------v----------+
|   SqlSession      |
+--------+----------+
         |
         | openSession()
         v
+--------v----------+
|   SqlParser       |
+--------+----------+
         |
         | 解析SQL & 参数
         v
+--------v----------+
| ExecuteParser     |
+--------+----------+
         |
         | 执行SQL
         v
+--------v----------+
| ResultParser      |
+--------+----------+
         |
         | 映射结果
         v
+--------v----------+
| 返回结果          |
+-------------------+

关键组件说明

组件	功能
`SqlSessionManager`	工厂类，负责初始化配置、连接池和创建 `SqlSession` 实例。
`DefaultSqlSession`	核心会话类，提供 CRUD 操作、事务控制和代理对象生成。
`SqlParser`	解析 SQL 和参数，生成可执行的预编译语句。
`ExecuteParser`	设置参数并执行 SQL，返回结果集。
`ResultParser`	将结果集映射为 Java 对象。
`MyDataSource`	简易连接池，管理数据库连接。
`SecondCaches`	全局二级缓存，支持按表名清理缓存。

使用示例

1. 配置数据库连接

在 jdbc.properties 文件中配置数据库连接信息：

# 数据库连接信息
jdbc.url=jdbc:mysql://localhost:3306/your_database?characterEncoding=UTF-8
jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.username=root
jdbc.password=your_password

# 连接池信息
jdbc.initPoolSize=5
jdbc.dynamicAddSize=5

# 是否开启自动提交（默认开启）
jdbc.autoCommit=true

# 是否开启驼峰转换（默认关闭）
ibatis.mapUnderscoreToCamelCase=true

# 是否开启二级缓存（默认关闭）
ibatis.cacheEnabled=true

2. 创建Mapper接口

使用注解定义SQL操作：

public interface GoodsMapper {
    // 插入操作
    @Insert("INSERT INTO tb_goods(name, price, stock, description) VALUES(#{name}, #{price}, #{stock}, #{description})")
    int insert(Goods goods);
    
    // 插入并返回自增主键
    @Insert(value = "INSERT INTO tb_goods(name, price, stock, description) VALUES(#{name}, #{price}, #{stock}, #{description})", 
            returnInsertKey = true)
    int insertReturnId(Goods goods);
    
    // 删除操作
    @Delete("DELETE FROM tb_goods WHERE id = #{id}")
    int delete(Integer id);
    
    // 更新操作
    @Update("UPDATE tb_goods SET name = #{name}, price = #{price}, stock = #{stock}, description = #{description} WHERE id = #{id}")
    int update(Goods goods);
    
    // 查询操作
    @Select("SELECT * FROM tb_goods WHERE id = #{id}")
    Goods selectById(Integer id);
    
    @Select("SELECT * FROM tb_goods")
    List<Goods> selectAll();
    
    // 使用多个参数
    @Delete("DELETE FROM tb_goods WHERE id = #{id} AND stock = #{stock}")
    int deleteByParamsAnnoWithIdAndStock(@Param("id") Integer id, @Param("stock") Integer stock);
}

3. 使用SqlSession执行操作

public class GoodsTest {
    public static void main(String[] args) {
        // 创建SqlSessionManager
        SqlSessionManager factory = new SqlSessionManager("jdbc.properties");
        
        // 打开会话
        DefaultSqlSession sqlSession = factory.openSession();
        
        // 获取Mapper接口代理对象
        GoodsMapper mapper = sqlSession.getMapper(GoodsMapper.class);
        
        // 执行插入操作
        Goods goods = new Goods(null, "手机", 1999.0, 100, "新款手机");
        int result = mapper.insert(goods);
        System.out.println("插入结果：" + result);
        
        // 执行查询操作
        List<Goods> goodsList = mapper.selectAll();
        for (Goods g : goodsList) {
            System.out.println(g);
        }
        
        // 关闭会话
        sqlSession.close();
    }
}

4. 事务管理

// 默认自动提交
DefaultSqlSession sqlSession = factory.openSession();

// 手动控制事务
DefaultSqlSession sqlSession = factory.openSession(false);
try {
    GoodsMapper mapper = sqlSession.getMapper(GoodsMapper.class);
    mapper.insert(goods1);
    mapper.insert(goods2);
    sqlSession.commit(); // 提交事务
} catch (Exception e) {
    sqlSession.rollback(); // 回滚事务
    e.printStackTrace();
} finally {
    sqlSession.close(); // 关闭会话
}