Skip to content

Latest commit

 

History

History
236 lines (149 loc) · 7.55 KB

README.md

File metadata and controls

236 lines (149 loc) · 7.55 KB
Raw

目录

mini-git：用Java实现一个简易版Git

特此鸣谢UCB提供的skeleton code！

0. 介绍与说明

本玩具项目基于作者对Git的理解与Git操作，基本实现了Git部分指令的底层运行原理。在技术上只使用到了Java 8 官方库，包括序列化、文件、集合等，适合对Git或Java基础不够熟悉的计算机新手进行源码阅读或调试。

本系统已实现的指令在下方，由于代码量小及水平有限，部分命令和Git软件的真实使用效果并不相同，并对一些复杂指令作出简化，请阅读下方指令的注意事项，避免运行中由于人工误操作出现Bug。

同时，该系统不能完全代表Git内部真正的工作流程，仅仅代表本人理解与对Git实操的认识，借此抛砖引玉。（另外安利一个可视化学习Git的网站，Learn Git Branching

1. 内部数据结构

1.1 blob

存在于.git/object文件夹，blob表示保存的文件内容。由于 Git 会保存多个版本的文件，因此一个文件可能对应多个 blob：每个 blob 在不同的commit中被跟踪。

1.2 tree

存在于.git/object文件夹，tree表示文件目录，即将名称映射为 blob 和其他子tree（子目录）引用的目录结构。在本项目中为了简化，没有包含实际的tree对象，而是直接通过文件路径。具体原理可见：Git基础 — 16、Tree对象详解 - 繁华似锦Fighting - 博客园

1.3 commit

存在于.git/object文件夹。commit包含了日志信息、元数据（提交日期、作者等）、对tree对象的引用以及对父commit的引用等。同时Git还会维护从分支头部到提交引用的映射。

1.4 stage

暂存区，对应.git中的index文件，在本项目中，stage包含了新增文件暂存区和删除文件暂存区。在下文中，我们称之为“暂存-新增区”与“暂存-删除区”。

2. 支持的指令

2.1 init

指令

  • git init

说明

  • 该指令会在当前目录下创建一个新的 mini-git 版本控制系统。该系统将自动从一个commit开始：并且该提交不包含任何文件。初始状态下只有一个默认当前分支：master。由于 mini-git创建的所有版本库的初始提交内容完全相同，因此所有版本库都会自动共享该commit（它们都有相同的 UID），所有版本库中的所有commit都会追溯到该次提交。

2.2 add

指令

  • git add .
  • git add [file/folder] [file/folder] ...

说明

  • 将当前存在的文件副本添加到暂存区。因此，被添加文件也称为暂存文件。重新暂存已暂存的文件会用新内容覆盖暂存区域中的前一个条目。如果文件的当前工作版本与当前提交的版本相同，则不要将其添加到暂存区；如果文件已经在暂存区，则应将其从暂存区移除（这可能发生在文件被修改、添加，然后又改回原始版本的情况下）。如果该文件在执行git rm命令时已在暂存区，则不会再被暂存。
  • 具体原理同上。

注意事项

  • 其中，folder为工作目录下的相对路径，如git add a/b.txt，如果你的路径包含空格，请加入双引号，如git add "a b"，表示名为a b的文件夹。由于本系统无vim编辑模式，请不要只输入一个引号。

2.3 commit

指令

  • git commit -m [message]

说明

  • 该操作会保存当前commit和暂存-新增区中跟踪文件的快照，并创建一个新的commit,新的commit的父commit为当前commit。在默认情况下，每个commit的文件快照与其父commit的文件快照完全相同；它将保持文件版本的原样。新commit只会更新已经被添加到暂存-新增区的文件，在这种情况下，新commit将包含在暂存区的文件版本，而不是从父commit中获得的版本。同时，新commit将保存并开始跟踪任何父commit没有跟踪的文件。最后，在当前commit中被跟踪的文件可能会在新commit中被取消跟踪，因为这些文件已被 rm 命令删除。

2.4 status

指令

  • git status

说明

  • 表示当前工作目录的状态，包含的内容信息如下：

    === Staged Files ===

  
=== Removed Files ===

  
=== Modifications Not Staged For Commit ===

  
=== Untracked Files ===

2.5 log

指令

  • git log
  • git log -[number]
  • git log --grep=[message]

说明

  • 按时间先后，展示所有commit记录
  • 展示给定数量的commit记录
  • 展示包含message信息的commit记录

2.6 rm

指令

  • git rm [file/folder] [file/folder] ...
  • git rm -f [file/folder] [file/folder] ...
  • git rm -cached [file/folder] [file/folder] ...

说明

  • 从暂存区和工作目录，删除文件或文件夹
  • 强制删除
  • 只删除暂存区的文件或文件夹，保留工作目录的文件或文件夹

2.7 branch

指令

  • git branch
  • git branch [branch name]
  • git branch -d [branch name]

说明

  • 查看当前所有本地分支

  • 创建分支

  • 删除分支

2.8 checkout

指令

  • git checkout [branch name]
  • git checkout -b [branch name]
  • git checkout -- [file] [file] ...
  • git checkout [commit id] -- [file] [file] ...

说明

  • 所有文件切换到给定分支
  • 创建分支，并切换到该分支
  • 使用当前head commit的文件版本覆写该文件
  • 根据指定commit的文件版本覆写该文件

3. 额外功能

  • 支持git [command] -h查看指令帮助
  • 支持八位commit id检索，如d2ee103f
  • 系统会缓存上一次最近打开的工作目录
  • 系统会缓存指令，通过键盘上的↑与↓按键，即可切换指令

4. 文件目录

├─src
    │  Main.java
    │
    ├─command
    │      AddCommand.java
    │      BranchCommand.java
    │      CheckoutCommand.java
    │      CommitCommand.java
    │      ICommand.java
    │      InitCommand.java
    │      LogCommand.java
    │      MergeCommand.java
    │      ResetCommand.java
    │      RmCommand.java
    │      StatusCommand.java
    │
    ├─engine
    │      Engine.java
    │      Repository.java
    │
    ├─object
    │      Blob.java
    │      Commit.java
    │      Stage.java
    │
    ├─utils
    │      FileTreeUtils.java
    │      PersistanceUtils.java
    │
    └─view
            CommandPromptGUI.java
            ViewResponseEntity.java
            ViewResponseEnum.java

5. 运行截图

如有疑问，欢迎emali至[email protected]；如有bug，那是正常的:)