GitLab (https://gitlab.com/gitlab-org/gitlab)的源码库是一个非常庞大且复杂的项目，它不仅仅是一个 Git 仓库浏览器，而是一个完整的 DevOps 平台。我会从高层次的架构、核心技术栈、关键目录结构和如何开始探索等方面，为你系统地讲解这个源码库。

1. 总体介绍与架构 (High-Level Overview & Architecture)

首先要理解 GitLab 的核心架构。它是一个 “模块化单体” (Modular Monolith) 应用。

• 单体 (Monolith)：主要的核心功能都构建在一个巨大的 Ruby on Rails 应用中。这意味着大部分业务逻辑、网页渲染、API 等都在同一个代码库里。

• 模块化 (Modular)：随着项目发展，一些性能敏感、需要独立扩展的关键组件被拆分成了独立的服务。但主应用依然是所有功能的中心协调者。

核心组件交互流程：

1. 用户通过浏览器或 Git 客户端发起请求。

2. 请求首先到达像 Nginx 这样的 Web 服务器。

3. Nginx 将请求转发给 GitLab Workhorse。这是一个智能反向代理，专门处理大文件上传/下载、Git LFS 等耗时操作，以减轻 Rails 主应用的负担。

4. Workhorse 处理完或判断无需处理后，将请求交给 Rails 应用（运行在 Puma 服务器上）。

5. Rails 应用处理业务逻辑：

   • 如果需要数据库操作（如用户信息、项目元数据、Issue 等），它会查询 PostgreSQL 数据库。

   • 如果需要缓存或处理后台任务，它会使用 Redis 和 Sidekiq。

   • 最关键的一点：当需要对 Git 仓库本身进行任何读写操作时（如 git clone, git push, 查看文件内容、分支信息等），Rails 应用不会直接操作文件系统。它会通过 gRPC 调用一个名为 Gitaly 的独立服务。

6. Gitaly 是一个用 Go 语言编写的后台服务，它负责所有 Git 操作。这种分离使得 Git 操作可以独立扩展，并且提高了系统的稳定性和性能。

![alt text](https://i.imgur.com/8Q61JgI.png)

2. 核心技术栈 (Core Technology Stack)

• 后端 (Backend):

  • Ruby on Rails: 整个项目的基石，负责 Web 界面、API 和大部分业务逻辑。

  • Go (Golang): 用于开发高性能的后台服务，最典型的就是 Gitaly、GitLab Workhorse 和 GitLab Runner 的部分组件。

• 前端 (Frontend):

  • Vue.js: 现代化的前端功能（如 Issue 看板、Merge Request 的实时更新等）主要使用 Vue 构建。

  • Haml/ERB: 传统的 Rails 视图模板，仍然在大量页面中使用。

  • jQuery: 历史遗留，仍在一些旧的页面和代码中使用。

• 数据库 (Database):

  • PostgreSQL: 唯一的官方支持的主数据库，存储除了 Git 仓库本身之外的所有数据（用户信息、项目设置、CI/CD pipeline 记录等）。

• 缓存与后台任务队列 (Cache & Job Queue):

  • Redis: 用于缓存、会话存储，以及作为 Sidekiq 的任务队列。

  • Sidekiq: 用于处理所有异步的后台任务，比如发送邮件通知、运行 CI/CD pipeline、更新 Merge Request 状态等。

3. 关键目录结构解析 (Key Directory Structure)

当你打开 GitLab 的源码库，你会看到一个标准的 Rails 项目结构，但规模要大得多。以下是一些最重要的目录：

• app/

  • 这是 Rails 应用的核心代码。

  • controllers/: 控制器，处理 HTTP 请求的入口。

  • models/: ActiveRecord 模型，对应数据库中的表，包含数据逻辑。

  • views/: 视图文件，主要是 Haml 和 ERB 模板，负责生成 HTML。

  • services/: 非常重要！ GitLab 将复杂的业务逻辑封装在 Service 对象中，而不是放在 Controller 或 Model 里。例如，Projects::CreateService 负责创建一个新项目的所有逻辑。阅读源码时，Service 是理解业务流程的关键。

  • workers/: Sidekiq 的后台任务定义。所有以 ...Worker 结尾的类都在这里。

  • assets/: 前端资源，包括 javascripts/ (大量的 Vue 组件和 vanilla JS), stylesheets/, images/ 等。

• bin/

  • 包含可执行脚本，比如 rails, rake 和很多 GitLab 自定义的命令行工具。

• config/

  • 配置文件目录。

  • routes.rb: 定义了所有的 URL 路由规则，是请求分发的起点。

  • gitlab.yml.example: GitLab 应用的主要配置文件模板。

  • database.yml.example: 数据库连接配置。

  • initializers/: Rails 启动时加载的初始化脚本。

• db/

  • 数据库相关文件，最主要的是 migrate/ 目录，包含了所有的数据库结构变更历史（Migrations）。

• ee/

  • 这是 GitLab 开源模式的核心！ GitLab 采用 "Open Core" 模式。这个目录包含了企业版 (Enterprise Edition) 独有的功能。在构建企业版时，这里的代码会"覆盖"或"增强"社区版 (FOSS - Free and Open Source Software) 的同名文件。例如，如果 app/models/project.rb 是社区版的功能，那么 ee/app/models/project.rb 就会在企业版中扩展它。

• lib/

  • 存放不属于 MVC 模式的核心 Ruby 代码库。

  • gitlab/: 包含了大量 GitLab 的核心模块和类，例如 Git 仓库的封装、API 客户端、CI/CD 逻辑等。这是除了 app/ 目录外最重要的代码目录。

• public/

  • 静态文件目录，可以直接通过 Web 服务器访问。

• spec/

  • 自动化测试代码（使用 RSpec）。GitLab 有非常全面的测试覆盖，这个目录非常庞大。

• vendor/

  • 存放第三方的代码库。

4. 一个请求的生命周期 (Lifecycle of a Request - Simplified)

假设你正在浏览器中查看一个 Merge Request 页面：

1. 路由匹配: 浏览器访问 /:namespace/:project/-/merge_requests/:id。config/routes.rb 将这个 URL 匹配到 Projects::MergeRequestsController 的 show 方法。

2. 控制器处理: Projects::MergeRequestsController#show 开始执行。它会进行权限检查，确保你有权查看这个 MR。

3. 数据获取:

   • 控制器会使用 ActiveRecord 模型（如 Project, MergeRequest, Note）从 PostgreSQL 数据库中加载 MR 的标题、描述、评论等元数据。

   • 当需要显示代码差异 (diff) 或分支信息时，控制器或相关的 Service 会通过 gRPC 调用 Gitaly 服务。

   • Gitaly 收到请求后，在服务器上执行底层的 git 命令（如 git diff），并将结果返回给 Rails 应用。

4. 视图渲染: 控制器将获取到的数据传递给 app/views/projects/merge_requests/show.html.haml 视图模板。

5. 前端交互:

   • 页面加载后，app/assets/javascripts/ 中的 JavaScript 和 Vue 组件开始执行，可能会发起额外的 API 请求来获取实时数据（比如 CI 状态），或者实现评论、代码高亮等动态功能。

5. 如何开始探索源码 (How to Get Started)

GitLab 源码非常庞大，直接通读是不现实的。建议采用以下方法：

1. 搭建本地开发环境: 这是最重要的一步。不要手动搭建，务必使用 GDK (GitLab Development Kit)。GDK 会帮你自动化安装和配置 GitLab、Gitaly、PostgreSQL、Redis 等所有依赖。

   • GDK 官方文档: https://gitlab.com/gitlab-org/gitlab-development-kit

2. 从一个功能点入手: 选择一个你熟悉的功能，比如 "创建一个 Issue"。

   • 在你的本地 GDK 环境中实际操作一下。

   • 查看浏览器开发者工具的网络请求，找到对应的 Controller 和 Action。

   • 使用 grep 或 IDE 的全局搜索功能，在代码库里搜索相关的 Controller 名称或 Service 名称 (e.g., Issues::CreateService)。

   • 顺着代码调用链，一步步往下读，理解它的工作流程。

3. 阅读开发者文档: GitLab 有非常详细的开发者文档，介绍了架构、代码风格、如何贡献等。

   • https://docs.gitlab.com/ee/development/

4. 从小的 Bug 修复或功能改进开始: 在 GitLab 的 Issue 列表里，寻找带有 good for new contributors 标签的 Issue。这通常是一些比较简单、适合新人上手的任务，也是参与社区贡献的好起点。

希望这份讲解能帮助你对 GitLab 的源码有一个清晰的认识！如果你对某个具体部分有更深入的问题，随时可以再问。