您是否想过提交及其内容如何存储在Git中? 好吧,我有,在上一个下雨的周末,我有一些空闲时间,所以我做了一些研究。
因为我对Java的感觉比对Bash的感觉要多,所以我使用了JGit和一些学习测试来探索提交的Git内部。 这是我的发现:
Git –对象数据库
Git的核心是简单的内容可寻址数据存储。 这意味着您可以在其中插入任何类型的内容,并且它将返回一个密钥,您可以使用该密钥在以后的某个时间点再次检索数据。
对于Git,关键是从内容计算出的20字节SHA-1哈希。 内容也被称为在GIT中术语的对象 ,因此数据存储也被称为对象数据库 。
让我们看看如何使用JGit来存储和检索内容。
斑点
在JGit中,ObjectInserter用于将内容存储到对象数据库中。 可以将其视为与Git中的git hash-object
大致等效。
使用其insert()方法,您可以将对象写入数据存储,而其idFor()方法仅计算给定字节的SHA-1哈希。 因此,用于存储字符串的代码如下所示:
ObjectInserter objectInserter = repository.newObjectInserter();
byte[] bytes = "Hello World!".getBytes( "utf-8" );
ObjectId blobId = objectInserter.insert( Constants.OBJ_BLOB, bytes );
objectInserter.flush();
所有代码示例均假定存储库变量指向在代码段外部创建的空存储库 。
第一参数表示要插入的对象的对象类型 ,在这种情况下,斑点的类型。 还有其他对象类型,我们将在后面学习。 Blob类型用于存储任意内容。
有效载荷必须在第二个参数中给出,在这种情况下,必须作为字节数组。 也可以使用接受InputStream的重载方法。
最后,需要刷新ObjectInserter,以使其他访问存储库的更改可见。
insert()方法返回根据类型,内容长度和内容字节计算得出的SHA-1哈希。 但是,在JGit中,SHA-1哈希通过ObjectId类表示,ObjectId类是一种不变的数据结构,可以在字节,整数和字符串之间来回转换。
现在,您可以使用返回的blobId取回内容,从而确保上面的代码实际写入了内容。
ObjectReader objectReader = repository.newObjectReader();
ObjectLoader objectLoader = objectReader.open( blobId );
int type = objectLoader.getType(); // Constants.OBJ_BLOB
byte[] bytes = objectLoader.getBytes();
String helloWorld = new String( bytes, "utf-8" ) // Hello World!
ObjectReader的open()方法返回一个ObjectLoader,该对象可用于访问由给定对象ID标识的对象。 借助ObjectLoader,您可以将对象的类型,大小以及内容作为字节数组或流获取。
要验证JGit编写的对象与本机Git兼容,可以使用git cat-file
检索其内容。
$ git cat-file -p c57eff55ebc0c54973903af5f72bac72762cf4f4
Hello World!
git cat-file -t c57eff55ebc0c54973903af5f72bac72762cf4f4
blob
如果查看存储库的.git/objects
目录,则会发现一个名为'c5'的目录,其中包含名为'7eff55ebc0c54973903af5f72bac72762cf4f4'的文件。 最初是这样存储内容的:每个对象作为一个文件,以内容的SHA-1哈希命名。 子目录以SHA-1的前两个字符命名,文件名由其余字符组成。
现在您可以存储文件的内容,下一步就是存储文件的名称。 而且可能不仅仅是一个文件,因为提交通常由一组文件组成。 为了保存此类信息,Git使用了所谓的树对象。
树对象
树对象可以看作是简化的文件系统结构,其中包含有关文件和目录的信息。
它包含任意数量的树条目。 每个条目都有一个路径名,一个文件模式,并指向一个文件(一个blob对象)或另一个(子)树对象(如果它代表一个目录)的内容。 指针当然是Blob对象或树对象的SHA-1哈希。
首先,您可以创建一个树,其中包含一个名为“ hello-world.txt”的文件的单个条目,该文件指向上面存储的“ Hello World!”。 内容。
TreeFormatter treeFormatter = new TreeFormatter();
treeFormatter.append( "hello-world.txt", FileMode.REGULAR_FILE, blobId );
ObjectId treeId = objectInserter.insert( treeFormatter );
objectInserter.flush();
TreeFormatter在这里用于构造内存中的树对象。 通过调用append(),将添加具有给定路径名,模式和ID(用于存储其内容)的条目。
从根本上讲,您可以自由选择任何路径名。 但是,Git希望路径名是相对于工作目录的,且不带前导“ /”。
此处使用的文件模式表示正常文件。 其他模式是EXECUTABLE_FILE(它是一个可执行文件)和SYMLINK(它指定一个符号链接)。 对于目录条目,文件模式始终为TREE。
同样,您将需要一个ObjectInserter。 其重载的insert()方法之一接受TreeFormatter并将其写入对象数据库。
现在,您可以使用TreeWalk检索和检查树对象:
TreeWalk treeWalk = new TreeWalk( repository );
treeWalk.addTree( treeId );
treeWalk.next();
String filename = treeWalk.getPathString(); // hello-world.txt
实际上,TreeWalk旨在对添加的树及其子树进行迭代。 但是由于我们知道只有一个条目,因此只需调用next()就足够了。
如果使用本地Git查看刚刚编写的树对象,则会看到以下内容:
$ git cat-file -p 44d52a975c793e5a4115e315b8d89369e2919e51
100644 blob c57eff55ebc0c54973903af5f72bac72762cf4f4 hello-world.txt
现在您已经拥有提交的必要条件,让我们创建提交对象本身。
提交对象
提交对象 (通过树对象)引用构成提交的文件以及一些元数据。 详细而言,提交包括:
- 指向树对象的指针
- 指向零个或多个父提交的指针(稍后会详细介绍)
- 提交消息
- 以及作者和提交者
由于提交对象只是对象数据库中的另一个对象,因此它也被在其内容上计算出的SHA-1哈希密封。
为了形成提交对象,JGit提供了CommitBuilder实用程序类。
CommitBuilder commitBuilder = new CommitBuilder();
commitBuilder.setTreeId( treeId );
commitBuilder.setMessage( "My first commit!" );
PersonIdent person = new PersonIdent( "me", "me@example.com" );
commitBuilder.setAuthor( person );
commitBuilder.setCommitter( person );
ObjectInserter objectInserter = repository.newObjectInserter();
ObjectId commitId = objectInserter.insert( commitBuilder );
objectInserter.flush();
使用它很简单,它具有针对提交的所有属性的setter方法。
作者和提交者通过PersonIdent类表示,该类包含名称,电子邮件,时间戳和时区。 此处使用的构造函数应用给定的名称和电子邮件,并采用当前时间和时区。
剩下的应该已经很熟悉了:ObjectInserter用于实际写入提交对象并返回提交ID。
要从存储库中检索提交对象,可以再次使用ObjectReader:
ObjectReader objectReader = repository.newObjectReader();
ObjectLoader objectLoader = objectReader.open( commitId );
RevCommit commit = RevCommit.parse( objectLoader.getBytes() );
生成的RevCommit表示具有与CommitBuilder中指定的相同属性的提交。
再一次-仔细检查git cat-file
的输出:
$ git cat-file -p 783341299c95ddda51e6b2393c16deaf0c92d5a0
tree 4b825dc642cb6eb9a060e54bf8d69288fbee4904
author me <me@example.com> 1412872859 +0200
committer me <me@example.com> 1412872859 +0200My first commit!
父母
父母链形成了Git仓库的历史,并建模了有向无环图 。 这意味着提交“遵循”一个方向
一个提交可以有零个或多个父母。 存储库中的第一个提交没有父提交(aka根提交)。 第二个提交又将第一个提交作为其父级,依此类推。
创建多个根提交完全合法。 如果使用git checkout --orphan new_branch
将创建一个新的孤立分支并将其切换到。 在此分支上进行的第一次提交将没有父项,并且将成为与所有其他提交断开连接的新历史记录的根。
如果开始分支并最终合并变化的分歧线,通常会导致合并提交 。 并且这样的提交具有分支的父分支作为其父分支。
为了构造父提交,需要在CommitBuilder中指定父提交的ID。
commitBuilder.setParents( parentId );
还可以查询RevCommit类,该类表示存储库中的提交,并且可以查询其父级。 它的getParents()和getParent(int)方法返回全部或第n个父RevCommit。
请注意,尽管这些方法返回RevCommits,但这些方法尚未完全解决。 设置其ID属性后,所有其他属性(fullMessage,author,committer等)均未设置。 因此,例如,尝试调用parent.getFullMessage()会引发NullPointerException。 为了实际使用父提交,您需要通过上面概述的ObjectReader检索完整的RevCommit,或者使用RevWalk加载和解析提交标头:
RevWalk revWalk = new RevWalk( repository );
revWalk.parseHeaders( parentCommit );
总而言之,请记住将返回的父提交视为ObjectId而不是RevCommits。
有关树对象的更多信息
如果要将文件存储在子目录中,则需要自己构造子树。 假设您要将文件“ file.txt”的内容存储在文件夹“文件夹”中。
首先,为子树创建并存储TreeFormatter,该子树具有文件的条目:
TreeFormatter subtreeFormatter = new TreeFormatter();
subtreeFormatter.append( "file.txt", FileMode.REGULAR_FILE, blobId );
ObjectId subtreeId = objectInserter.insert( subtreeFormatter );
然后,创建并存储TreeFormatter以及一个表示文件夹的条目,并指向刚创建的子树。
TreeFormatter treeFormatter = new TreeFormatter();
treeFormatter.append( "folder", FileMode.TREE, subtreeId );
ObjectId treeId = objectInserter.insert( treeFormatter );
条目的文件模式为TREE,表示目录,其ID指向保存文件条目的子树。 返回的treeId是将传递给CommitBuilder的那个。
Git对树对象中的条目要求一定的排序顺序。 我在这里找到的“ Git数据格式”文档指出:
树条目按包含条目名称的字节序列排序。 但是,出于排序比较的目的,比较树对象的条目,就好像条目名称字节序列具有尾随的ASCII'/'(0x2f)。
要读取树对象的内容,可以再次使用TreeWalk。 但是这一次,如果要访问所有条目,则需要告诉它递归到子树中。 而且,如果您希望看到指向树的条目,请不要忘记将postOrderTraversal设置为true。 否则将被跳过。
最终,整个TreeWalk循环将如下所示:
TreeWalk treeWalk = new TreeWalk( repository );
treeWalk.addTree( treeId );
treeWalk.setRecursive( true );
treeWalk.setPostOrderTraversal( true );
while( treeWalk.next() ) {int fileMode = Integer.parseInt( treeWalk.getFileMode( 0 ).toString() );String objectId = treeWalk.getObjectId( 0 ).name();String path = treeWalk.getPathString();System.out.println( String.format( "%06d %s %s", fileMode, objectId, path ) );
}
…并将导致以下输出:
100644 6b584e8ece562ebffc15d38808cd6b98fc3d97ea folder/file.txt
040000 541550ddcf8a29bcd80b0800a142a7d47890cfd6 folder
尽管我发现API不是很直观,但它可以完成工作并显示树对象的所有详细信息。
总结Git内部
毫无疑问,对于常见用例,建议将高层Add-和CommitCommands提交到存储库中。 不过,我发现值得深入研究JGit和Git,希望您也这样做。 而且,在您需要将文件提交到没有工作目录和/或索引的存储库的情况下(这种情况不太常见),这里提供的信息可能会有所帮助。
如果您想亲自尝试此处列出的示例,建议您设置JGit并对其源代码和JavaDoc进行访问,以便您拥有有意义的上下文信息,内容帮助,调试源等。
- 完整的源代码托管在这里: https : //gist.github.com/rherrmann/02d8d4fe81bb60d9049e
为简便起见,此处显示的示例省略了用于释放分配的资源的代码。 请参考完整的源代码以获取所有详细信息。
翻译自: https://www.javacodegeeks.com/2014/10/explore-git-internals-with-the-jgit-api.html