How to 阅读 h2 数据库源码-京东云开发者社区

> 阅读 h2 数据库的源码是一项复杂的任务，需要对数据库原理、Java 语言和操作系统有深入的理解。可以从以下几方面入手来完成。

## 环境准备

首先，你需要在你的机器上安装和配置好开发环境，包括 JDK、Maven、IDE 调试器等工具。

然后，从 [h2 的官方网站](https://h2database.com/html/main.html) 或 [GitHub上下载源码](https://github.com/h2database/h2database)。

IDE 导入 h2 数据库源码，根据不同的调试场景，启用不同的模式。

### Client/Server 模式

```shell
# 约等于 java -cp h2-*.jar org.h2.tools.Console
java -cp h2-*.jar
```

### 本地 Shell 模式

```shell
java -cp h2-*.jar org.h2.tools.Shell
```

## 理解架构

在阅读源码之前，理解 h2 数据库的整体架构和主要组件是非常重要的。可以从官方文档或在线教程中获取这些信息。

官方架构讲解 [Architecture](https://h2database.com/html/architecture.html)

[h2database 架构总览与模块源码分析大纲](./2022-09-02-Insight-h2database-overview.md)

## 选择关注点

h2 数据库的源码非常多，功能非常丰富，可能无法一次性完全理解。因此，选择一个特定的模块或功能（如查询优化器、存储引擎、事务处理等）作为起点，然后逐步扩大你的阅读范围。

基于的 BTree PageStore 存储引擎更贴近日常工作、便于理解，可以先选取该存储引擎入手。

### PageStore 源码相关的分析

- [Insight h2database 更新、读写锁以及事务原理](http://xingyun.jd.com/shendeng/article/detail/23134?jdme_router=jdme://web/202206081297?url%3Dhttp%3A%2F%2Fsd.jd.com%2Farticle%2F23134)

- [Insight h2database 执行计划评估以及 Selectivity](http://xingyun.jd.com/shendeng/article/detail/20876?jdme_router=jdme://web/202206081297?url%3Dhttp%3A%2F%2Fsd.jd.com%2Farticle%2F20876)

- [h2database BTree 设计实现与查询优化思考](http://xingyun.jd.com/shendeng/article/detail/15199?jdme_router=jdme://web/202206081297?url%3Dhttp%3A%2F%2Fsd.jd.com%2Farticle%2F15199)

## 跟踪代码

使用调试器跟踪代码的执行过程，这可以帮助你理解代码的运行逻辑。你可以从一些简单的SQL查询开始，看看它们是如何在 h2 数据库中被处理的。

可以使用上述的本地 Shell 模式开启你的源码之旅。
![image.png](https://s3.cn-north-1.jdcloud-oss.com/shendengbucket1/2023-10-24-22-29xuiN6ozxPj24jOaH.png)

- [Insight h2database SQL like 查询](http://xingyun.jd.com/shendeng/article/detail/23132?jdme_router=jdme://web/202206081297?url%3Dhttp%3A%2F%2Fsd.jd.com%2Farticle%2F23132)

- [Insight H2 database 数据查询核心原理](http://xingyun.jd.com/shendeng/article/detail/20874?jdme_router=jdme://web/202206081297?url%3Dhttp%3A%2F%2Fsd.jd.com%2Farticle%2F20874)

## 阅读注释

h2 数据库的源码中有大量的注释，这些注释可以帮助你理解代码的功能和工作原理。

- 架构类的代码，可以从设计模式中寻找灵感。

- 算法类的代码，可以从最简化的模型来阅读。

- 对于无法理解的代码，尝试交给 chat-gpt 解读。

## 参考资料

h2 相关的资料比较少，数据库的底层原理是相通的。

- 借鉴 MySQL 的内部工作原理，相关的书籍来了解 h2 设计理念。

- 从已有的其他开源数据库中获取设计相关的文档。例如：[B+树实现 - MiniOB](https://oceanbase.github.io/miniob/design/miniob-bplus-tree.html)

![image.png](https://s3.cn-north-1.jdcloud-oss.com/shendengbucket1/2023-10-24-22-30yLyd30YbejuzwXO10.png)
## 实践

尝试修改一些代码，然后编译并运行，看看结果是否符合你的预期。这是理解源码的最好方式之一。

- 可以从 github issues 来了解运行中的问题和修复思路和方案。

- 针对同一个功能，从 git 不同版本的源码对比中，学习重构和优化的思路。

- 在设计理念和原理熟悉后，可以着手针对特定场景进行源码改写练习。

## 社区交流

如果你遇到无法理解的代码或问题，可以在 h2 数据库的开发者论坛或邮件列表中寻求帮助。
- 简单的 issue : [CSVRead: Fails to translate empty Numbers, when cells are quoted · Issue #3785 · h2database/h2database · GitHub](https://github.com/h2database/h2database/issues/3785)
![image.png](https://s3.cn-north-1.jdcloud-oss.com/shendengbucket1/2023-10-24-22-28IJcOqP8gA7NlOfa.png)

开源是一件很费力的事情，众口难调。从讨论中可以看出产品的走向和主张。
向开源开发者和维护者致敬👍