Flarum源码解析

步子哥

开个专门的帖子来记录对Flarum源码的解读过程。

步子哥

在 class AbstractModel 这个类中，Callbacks 容器用于存储在特定事件发生时需要执行的回调函数。具体来说，afterSaveCallbacks 和 afterDeleteCallbacks 是两个主要的回调容器，分别用于在模型保存和删除后执行自定义逻辑。

具体功能：

事件驱动：通过使用回调函数，开发者可以在模型的生命周期中插入自定义逻辑。例如，在模型保存后执行某些操作（如发送通知、更新其他数据等）。
灵活性：回调函数可以根据需要动态添加，允许开发者在运行时定义行为，而不需要修改模型的核心代码。这种灵活性使得代码更具可维护性和可扩展性。
分离关注点：使用回调函数可以将业务逻辑与模型的主要功能分离，使得代码更加清晰和易于理解。

步子哥

addConnection 方法用于在数据库管理器中添加一个新的数据库连接。具体来说，在 Laravel 的 Eloquent ORM 中，addConnection 方法的作用如下：

注册数据库连接：通过调用 addConnection([imath:0]config, 'flarum')，将一个新的数据库连接配置添加到数据库管理器中。这里的 [/imath:0]config 是一个数组，包含了连接所需的配置信息（如数据库驱动、主机名、数据库名、用户名、密码等）。

$config = [
    'driver' => 'mysql',
    'host' => '127.0.0.1',
    'database' => 'flarum',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8mb4',
    'collation' => 'utf8mb4_unicode_ci',
    'prefix' => '',
    'strict' => true,
];

命名连接：第二个参数 'flarum' 是为这个连接指定的名称。这个名称可以在后续的数据库操作中引用，以便于选择和使用特定的连接。
支持多数据库：通过 addConnection 方法，应用程序可以同时支持多个数据库连接。例如，可以在同一个应用中连接到不同的数据库，或者在不同的环境（如开发、测试、生产）中使用不同的数据库配置。

步子哥

与 utf8mb4_general_ci 的比较：utf8mb4_general_ci 是另一种不区分大小写的排序规则，但它的排序和比较规则不如 utf8mb4_unicode_ci 精确。utf8mb4_unicode_ci 更加符合 Unicode 标准，适用于需要精确比较的场景。

步子哥

在 Laravel 中，singleton 函数用于注册一个服务容器中的单例实例。具体来说，singleton 的作用和理解可以从以下几个方面来看：

单例模式：singleton 方法实现了单例模式，这意味着在整个应用程序生命周期中，只有一个实例会被创建和使用。每次请求这个服务时，都会返回同一个实例，而不是每次都创建一个新的实例。
服务容器：Laravel 的服务容器是一个用于管理类依赖和执行依赖注入的工具。通过 singleton 方法，开发者可以将类或接口绑定到容器中，以便在需要时获取。
依赖注入：当你在类中请求一个依赖（例如通过构造函数注入或方法注入）时，Laravel 会自动从服务容器中解析出这个依赖。如果这个依赖是通过 singleton 注册的，Laravel 会确保返回的是同一个实例。
性能：使用单例可以减少内存开销和对象创建的开销，特别是对于那些创建成本较高的对象。因为在整个应用程序中只会创建一次实例，后续的请求都可以复用这个实例。

步子哥

$ability ??= '*';

这里的两个问号的意思是：

基本用法：?? 运算符用于检查左侧的变量是否存在且不为 null。如果存在且不为 null，则返回该变量的值；否则返回右侧的值。
结合赋值：在 ﹩ability ??= '*' 中，??= 是一种简写形式，表示如果 ﹩ability 变量不存在或为 null，则将其赋值为 '*'。如果 ﹩ability 已经有值（即不为 null），则保持原值不变。

步子哥

AbstractModel.php 是 Flarum 框架中用于建立数据库模型的抽象基类，继承自 Eloquent 模型。该类的主要功能和特点如下：

自动加载和命名空间: 使用了 Flarum\Database 命名空间。
时间戳: 默认禁用了时间戳（[imath:0]timestamps = false）。
回调函数: 包含在模型保存和删除后执行的回调函数数组（[/imath:0]afterSaveCallbacks 和 [imath:0]afterDeleteCallbacks）。
自定义类型转换: 允许为模型定义自定义的类型转换（[/imath:0]customCasts）。
默认属性: 支持为模型定义默认属性（[imath:0]defaults）。
表别名: 在查询中可以使用表别名（[/imath:0]tableAlias）。
唯一键: 如果模型有唯一键，可以在 $uniqueKeys 中定义。
引导方法: 在模型保存和删除后，依次执行相应的回调函数。
构造函数: 初始化模型属性，并合并所有父类的默认属性。
类型转换方法: 获取模型的所有类型转换，包括自定义类型转换。
回调注册方法: 提供方法注册在模型保存和删除后的回调函数。
回调释放方法: 提供方法释放并执行保存和删除后的回调函数。
新模型查询: 支持在查询中使用表别名。
列限定: 确保列名在查询中是合格的。
表别名回调: 提供方法在回调中使用表别名。
新集合: 返回自定义的集合类。
序列化: 在模型序列化时，清空回调函数数组，因为闭包无法被序列化。

详细代码可以在这里查看。

步子哥

DatabaseServiceProvider.php 是 Flarum 框架中的数据库服务提供者类，继承自 AbstractServiceProvider，主要用于注册和配置数据库相关的服务。它的主要功能包括：

注册服务:
- 注册 Eloquent 工厂 (registerEloquentFactory)
- 注册查询构建器宏 (registerBuilderMacros)
- 注册数据库管理器 (Manager)
- 注册连接解析器 (ConnectionResolverInterface)
- 注册数据库连接 (ConnectionInterface)
- 注册迁移库 (MigrationRepositoryInterface)
- 注册模型私有检查器 (flarum.database.model_private_checkers)
宏功能:
- 为不同的数据库驱动（MySQL、MariaDB、PostgreSQL、SQLite）注册 when 和 unless 宏，用于在特定驱动下执行回调函数。
Eloquent 工厂:
- 使用 Faker 生成器注册 Eloquent 工厂。
启动方法:
- 在启动时设置模型的连接解析器和事件分发器。
- 配置工厂名称和模型名称的推测方法。
- 注册模型保存时的私有检查逻辑。

详细代码可以在这里查看。

步子哥

Migrator.php 文件是 Flarum 框架中的迁移类，负责管理数据库迁移的执行。主要功能和方法包括：

属性:
- [imath:0]output: 用于输出消息的接口。
- [/imath:0]repository, [imath:0]connection, [/imath:0]files: 分别是迁移库、数据库连接和文件系统。
方法:
- run: 运行指定路径下的所有待迁移的迁移文件。
- runMigrationList: 执行一系列迁移文件。
- runUpMigrations: 执行一系列迁移文件的 "up" 方法。
- runDownMigrations: 执行一系列迁移文件的 "down" 方法。
- runUp: 运行单个迁移文件的 "up" 方法并记录。
- reset: 回滚所有已执行的迁移。
- runDown: 运行单个迁移文件的 "down" 方法并删除记录。
- runClosureMigration: 运行基于闭包的迁移。
- resolveAndRunClosureMigration: 解析并运行迁移，处理异常。
- getMigrationFiles: 获取指定路径下的所有迁移文件。
- resolve: 从文件中解析迁移实例。
- installFromSchema: 从模式转储初始化 Flarum 数据库。
- setOutput: 设置输出接口。
- note: 输出消息。
- getRepository: 获取迁移库实例。
- repositoryExists: 检查迁移库是否存在。

详细代码可以在这里查看。

步子哥

Collection.php 文件是 Flarum 框架中的一个自定义集合类，继承自 Laravel 的 BaseCollection。该类主要用于处理数据库模型的集合，具有以下主要功能：

命名空间: Flarum\Database\Eloquent
继承: 继承自 Illuminate\Database\Eloquent\Collection

主要方法包括：

loadAggregate:
- 作用: 解决在使用可见性作用域和急切加载 mentionedBy 的计数时产生的查询冲突问题。
- 实现: 通过在父查询中应用别名，防止 Laravel 自动为子查询生成别名。
- 示例查询问题见注释部分。
loadMissingRelation:
- 作用: 优化加载缺失关系的逻辑，避免不必要的属性变换器运行。
- 实现: 替换 ->whereNotNull() 为简单的 ->where(fn (mixed [imath:0]relation) => [/imath:0]relation !== null)，以避免变换器在 loadMissing() 调用完成前运行。

这个自定义集合类通过优化查询和关系加载，提升了性能并解决了一些特定场景下的冲突问题。详细代码可以在这里查看。