Git
章节 ▾ 第 2 版

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 值表示成功；任何小于该值的值都是错误。

  • 如果 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. 使用头部提交的树填充索引，并在路径 newfile.txt 中添加新文件。

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

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

  5. 提交消息。

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

  7. Rugged（和 Libgit2）在创建提交时可以选择更新一个引用。

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

Ruby 代码简洁明了，但由于 Libgit2 正在执行繁重的工作，因此此代码也将运行得非常快。如果您不是 Rubyist，我们将在其他绑定中讨论一些其他绑定。

高级功能

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