Git
章节 ▾ 第二版

A2.2 附录 B：在应用程序中嵌入 Git - Libgit2

Libgit2

另一个可供选择的方案是使用 Libgit2。Libgit2 是 Git 的一个无依赖性实现，专注于提供友好的 API，方便在其他程序中使用。您可以在 https://libgit2.org 找到它。

首先，让我们看一下 C API 的样貌。这里是一个快速浏览

// Open a repository
git_repository *repo;
int error = git_repository_open(&repo, "/path/to/repository");

// Dereference HEAD to a commit
git_object *head_commit;
error = git_revparse_single(&head_commit, repo, "HEAD^{commit}");
git_commit *commit = (git_commit*)head_commit;

// Print some of the commit's properties
printf("%s", git_commit_message(commit));
const git_signature *author = git_commit_author(commit);
printf("%s <%s>\n", author->name, author->email);
const git_oid *tree_id = git_commit_tree_id(commit);

// Cleanup
git_commit_free(commit);
git_repository_free(repo);

前两行代码打开了一个 Git 仓库。git_repository 类型表示一个指向仓库的句柄，它在内存中包含一个缓存。这是最简单的方法，适用于您知道仓库工作目录或 .git 文件夹的精确路径的情况。还有 git_repository_open_ext，它包含用于搜索的选项，以及用于创建远程仓库本地克隆的 git_clone 等函数，以及用于创建全新仓库的 git_repository_init 函数。

第二段代码使用 rev-parse 语法（有关更多信息，请参阅 分支引用）来获取 HEAD 最终指向的提交。返回的类型是一个 git_object 指针，它表示仓库的 Git 对象数据库中存在的内容。git_object 实际上是几种不同类型对象的“父”类型；每个“子”类型的内存布局与 git_object 相同，因此您可以安全地将其转换为正确的类型。在本例中，git_object_type(commit) 将返回 GIT_OBJ_COMMIT，因此可以安全地将其转换为 git_commit 指针。

下一段代码展示了如何访问提交的属性。这里最后一行代码使用 git_oid 类型；它是 Libgit2 中 SHA-1 哈希的表示。

从这个示例中，我们可以看到几个模式开始出现

  • 如果您声明一个指针并将其引用传递给 Libgit2 调用，该调用可能会返回一个整数错误代码。0 值表示成功；任何小于 0 的值都表示错误。

  • 如果 Libgit2 为您填充了一个指针，您有责任释放它。

  • 如果 Libgit2 从调用中返回一个 const 指针，则无需释放它，但在它所属的对象被释放时它将变得无效。

  • 编写 C 代码有点痛苦。

最后一点意味着使用 Libgit2 时，你不太可能编写 C 代码。幸运的是，有许多特定于语言的绑定可用，这些绑定使你在特定语言和环境中使用 Git 存储库变得相当容易。让我们看一下使用 Libgit2 的 Ruby 绑定编写的上述示例，该绑定名为 Rugged，可在 https://github.com/libgit2/rugged 中找到。

repo = Rugged::Repository.new('path/to/repository')
commit = repo.head.target
puts commit.message
puts "#{commit.author[:name]} <#{commit.author[:email]}>"
tree = commit.tree

如你所见，代码简洁得多。首先，Rugged 使用异常；它可以引发 ConfigError 或 ObjectError 等错误来表示错误条件。其次，没有显式释放资源，因为 Ruby 是垃圾回收的。让我们看一个稍微复杂一点的示例：从头开始制作一个提交

blob_id = repo.write("Blob contents", :blob) # (1)

index = repo.index
index.read_tree(repo.head.target.tree)
index.add(:path => 'newfile.txt', :oid => blob_id) # (2)

sig = {
    :email => "[email protected]",
    :name => "Bob User",
    :time => Time.now,
}

commit_id = Rugged::Commit.create(repo,
    :tree => index.write_tree(repo), # (3)
    :author => sig,
    :committer => sig, # (4)
    :message => "Add newfile.txt", # (5)
    :parents => repo.empty? ? [] : [ repo.head.target ].compact, # (6)
    :update_ref => 'HEAD', # (7)
)
commit = repo.lookup(commit_id) # (8)

  1. 创建一个新的 blob，它包含新文件的內容。

  2. 用 HEAD 提交的树填充索引，并在 newfile.txt 路径添加新文件。

  3. 这将在 ODB 中创建一个新的树，并将其用于新提交。

  4. 我们对作者和提交者字段使用相同的签名。

  5. 提交消息。

  6. 创建提交时，必须指定新提交的父提交。这使用 HEAD 的尖端作为单个父提交。

  7. Rugged（和 Libgit2）可以选择在进行提交时更新引用。

  8. 返回值是新提交对象的 SHA-1 哈希值，你可以使用它来获取 Commit 对象。

Ruby 代码很好且干净，但由于 Libgit2 承担了繁重的工作，因此这段代码运行速度也会非常快。如果你不是 Ruby 程序员，我们会在 其他绑定 中介绍其他一些绑定。

高级功能

Libgit2 有一些核心 Git 范围之外的功能。一个例子是可插拔性：Libgit2 允许你为几种类型的操作提供自定义“后端”，因此你可以用与 Git 不同的方式存储东西。Libgit2 允许为配置、引用存储和对象数据库等提供自定义后端。

让我们看一下它的工作原理。下面的代码是从 Libgit2 团队提供的后端示例集（可在 https://github.com/libgit2/libgit2-backends 中找到）中借来的。以下是如何设置对象数据库的自定义后端

git_odb *odb;
int error = git_odb_new(&odb); // (1)

git_odb_backend *my_backend;
error = git_odb_backend_mine(&my_backend, /*…*/); // (2)

error = git_odb_add_backend(odb, my_backend, 1); // (3)

git_repository *repo;
error = git_repository_open(&repo, "some-path");
error = git_repository_set_odb(repo, odb); // (4)

请注意，错误已捕获，但未处理。我们希望你的代码比我们的更好。

  1. 初始化一个空的“前端”对象数据库（ODB），它将充当“后端”的容器，这些后端是执行实际工作的组件。

  2. 初始化一个自定义 ODB 后端。

  3. 将后端添加到前端。

  4. 打开一个存储库，并将其设置为使用我们的 ODB 来查找对象。

但是这个 git_odb_backend_mine 是什么呢？好吧，这是你自己的 ODB 实现的构造函数，你可以在其中做任何你想做的事情，只要你正确填充 git_odb_backend 结构。以下是一些可能的示例

typedef struct {
    git_odb_backend parent;

    // Some other stuff
    void *custom_context;
} my_backend_struct;

int git_odb_backend_mine(git_odb_backend **backend_out, /*…*/)
{
    my_backend_struct *backend;

    backend = calloc(1, sizeof (my_backend_struct));

    backend->custom_context = …;

    backend->parent.read = &my_backend__read;
    backend->parent.read_prefix = &my_backend__read_prefix;
    backend->parent.read_header = &my_backend__read_header;
    // …

    *backend_out = (git_odb_backend *) backend;

    return GIT_SUCCESS;
}

这里最微妙的约束是 my_backend_struct 的第一个成员必须是 git_odb_backend 结构；这确保内存布局符合 Libgit2 代码的预期。其余部分是任意的；这个结构可以根据你的需要调整大小。

初始化函数会为结构分配一些内存，设置自定义上下文，然后填充其支持的 parent 结构的成员。查看 Libgit2 源代码中的 include/git2/sys/odb_backend.h 文件，了解完整的调用签名集；你的特定用例将有助于确定要支持的调用。

其他绑定

Libgit2 为多种语言提供了绑定。这里我们使用一些截至目前较为完整的绑定包展示一个小例子；许多其他语言都存在库，包括 C++、Go、Node.js、Erlang 和 JVM，所有这些库都处于不同成熟阶段。可以在 https://github.com/libgit2 中浏览存储库，找到官方的绑定集合。我们将编写的代码将返回最终由 HEAD 指向的提交的提交消息（类似于 git log -1）。

LibGit2Sharp

如果你正在编写 .NET 或 Mono 应用程序，LibGit2Sharp (https://github.com/libgit2/libgit2sharp) 是你的不二之选。这些绑定是用 C# 编写的，并尽心尽力地用原生风格的 CLR API 包装了原始 Libgit2 调用。以下是我们的示例程序

new Repository(@"C:\path\to\repo").Head.Tip.Message;

对于桌面 Windows 应用程序，甚至有一个 NuGet 包可以帮助你快速入门。

objective-git

如果你的应用程序运行在 Apple 平台上，你可能使用 Objective-C 作为你的实现语言。Objective-Git (https://github.com/libgit2/objective-git) 是该环境中 Libgit2 绑定的名称。示例程序如下所示

GTRepository *repo =
    [[GTRepository alloc] initWithURL:[NSURL fileURLWithPath: @"/path/to/repo"] error:NULL];
NSString *msg = [[[repo headReferenceWithError:NULL] resolvedTarget] message];

Objective-git 与 Swift 完全互操作，因此即使你已放弃 Objective-C，也无需担心。

pygit2

Libgit2 在 Python 中的绑定称为 Pygit2，可在 https://www.pygit2.org 中找到。我们的示例程序

pygit2.Repository("/path/to/repo") # open repository
    .head                          # get the current branch
    .peel(pygit2.Commit)           # walk down to the commit
    .message                       # read the message

进一步阅读

当然，对 Libgit2 功能的全面介绍超出了本书的范围。如果你想了解更多关于 Libgit2 本身的信息，可以在 https://libgit2.github.com/libgit2 中找到 API 文档，以及在 https://libgit2.github.com/docs 中找到一组指南。对于其他绑定，请查看捆绑的 README 和测试；通常会有一些小型教程和指向进一步阅读的指针。

scroll-to-top