Git

Git 是一个分布式版本控制系统，它将文件的修改记录为不同的快照，通过不同的区域和分支来管理代码。

基础命令

• git init: 初始化仓库

• git clone: 拷贝远程仓库

  （如果要自定义文件夹名，可以在后面加上文件夹名）

• git status: 显示变更

• git diff: 显示变更内容

• git log: 查看提交历史

  --oneline 显示简洁的提交历史

• git add .: 添加文件到暂存区

• git commit -m 'message': 提交到仓库，-m 后面是提交信息

  如果没有 -m 参数，会进入编辑器，你可以在编辑器中输入提交信息

  多行内容时，第一行为标题，第二行留空，后面的内容为详细描述

• git restore .: 撤销修改(version 2.23+)

• git reset: 回退版本

  --mixed 默认参数，回退版本，保留工作区的修改

  --soft 回退版本，保留暂存区的修改

  --hard 回退版本，丢弃工作区和暂存区的修改(谨慎使用)

• git revert [commit_hash]: 撤销某次提交

  会生成一个新的提交，这个提交是对之前提交的撤销

• git rebase: 变基

  git rebase -i HEAD~[n] 可以合并 n 个提交

  git rebase -i [commit_hash] 可以合并某个提交

• git stash: 暂存工作区

  git stash list 查看暂存列表

  git stash pop 恢复并删除暂存

  git stash apply 恢复不删除暂存

  git stash drop 删除暂存

  git stash clear 清空暂存

• git switch: 更换分支(version 2.23+)

  -c 创建并切换到新分支

• git checkout: 更换分支/创建分支/丢弃修改/切到特定的提交版本

  -b <branch_name> 如果没有分支则创建

  -- [.]/[file_name] 撤销未提交的改变（指定文件名）

  [commit_hash_or_tag] 输入 hash 或者 tag 可以切到具体版本

• git fetch: 拉取远程分支

  不会自动合并，需要手动合并

• git merge <branch_name>: 合并 <branch_name> 分支到当前分支

• git pull: 拉取远程分支

  git pull <远程主机名> <远程分支名>:<本地分支名>

  • 如果远程分支名和本地分支名一样，可以省略 :<本地分支名> 部分

  • 如果已经记住远程主机名和分支名，可以直接 git pull

• git push: 推送到远程分支

  git push <远程主机名> <本地分支名>:<远程分支名>

• git branch: 列出本地分支

  -r 列出远程分支

  -a 列出本地远程所有分支

  <branch_name> 创建新的分支

  -d <branch_name> 删除分支

• git remote: 管理远程仓库地址

  -v 查看远程仓库名及地址 (远程仓库不总是 origin 😄)

  show <remote_name> 查看远程仓库详细信息

  add <name> <url> 添加远程仓库

  rename <old_name> <new_name> 重命名远程仓库

  remove <name> 删除远程仓库

基础知识

Git 三个区域

• 工作区：本地的工作目录

• 暂存区：保存了你的改动，但还没有提交到仓库

• 仓库：分为本地仓库和远程仓库，保存了项目的元数据和对象数据库

Git 分支的管理

Git 的分支是一种非常轻量的机制，它本质上只是一个指向特定提交的指针。具体来说：

• Git 的分支并不是把代码复制一份或是创建一个新的目录，而只是创建一个指向提交记录的“指针”。

• 每次在某个分支上提交时，Git 会将该分支的指针前移到最新的提交位置。

• 创建一个新的分支只是创建一个新的指针，指向当前的提交。

• Git 中有一个特殊的指针 HEAD，它始终指向当前所在的分支。每当你切换分支时，HEAD 指针会指向新的分支。

• 每个提交记录都有一个指向它父提交的引用，这样就形成了一条提交链，Git 通过这些链来追踪分支的变化。

通过这种指针和链式结构，Git 可以轻松地管理不同的分支及其之间的关系。这种设计让 Git 的分支切换、合并、变基都非常高效。

Git 分支的合并策略

Git 的分支合并有两种策略：快进合并（Fast-forward Merge）和合并提交（Merge Commit）。

• 快进合并（Fast-forward merge）: 如果当前分支没有新的提交，直接将分支指针向前移动到目标分支的最新提交位置。

• 三方合并（Three-way merge）: 如果两个分支都有新的提交，Git 会创建一个新的合并提交（merge commit），将两个分支的内容结合在一起。这种情况下，有时会出现冲突，需要手动解决。

merge 和 rebase

• merge：直接合并分支，将两个分支的历史“合并”在一起，生成一个新的合并提交。适合保留分支开发历史的场景。

• rebase：将一个分支的提交重放到另一个分支之后，不产生合并提交，历史保持线性。适合在功能完成后整理提交历史的场景。

log 和 reflog

git reflog 是 Git 的引用日志（reference log），记录了所有对分支引用的修改，包括提交、重置、合并、拉取等操作。即使提交被删除或重置，git reflog 仍会保留所有的操作记录，包括分支头指针的移动。

• git log：显示分支的正常提交历史。用于查看项目的开发过程和具体提交内容。

• git reflog：显示所有引用操作记录，包含分支头的变化。用于找回丢失的提交和查看分支的变动历史。

配置管理

使用 git config 命令可以配置 git 的一些参数，比如用户名、邮箱、代理等。

Git 的配置分为三个级别：系统(--system)、用户(--global)、仓库(--local)。

它们的优先级是：仓库 > 用户 > 系统。

设置为全局，只需要加上 --global 参数即可。

git config --global user.name "yourname"
git config --global user.email "youremail"

另外如果你想对配置管理，可以使用下列命令：

• --list 查看配置
• --unset 移除配置
• --get 获取配置
• --replace-all 替换所有配置（这表示会覆盖原有的配置）

  git config --global --replace-all user.name "yourname"

常用配置

通过设置代理，可以加速或者解决无法下载或者提交的问题。

• user.name 用户名
• user.email 邮箱
• http.proxy 设置 HTTP 代理 (值为 http://proxy.com:port)
• https.proxy 设置 HTTPS 代理 (值为 http://proxy.com:port)
• core.ignorecase 区分文件名大小写（如果 false 区分大小写）
• core.filemode 是否检查文件权限（如果 false 忽略文件权限的变化）
• core.editor 编辑器
• core.base 默认分支名
• core.repositoryformatversion 仓库格式版本
• core.precomposeunicode 是否使用 Unicode
• core.logallrefupdates 是否记录所有引用更新
• http.sslVerify 是否验证 SSL 证书
• remote.origin.url 远程仓库地址

本地配置

每个项目下都有一个 .git/config 文件，这个文件是本地的配置文件，它会覆盖全局的配置。

通常我们会在这个文件中配置一些项目特有的配置，比如远程仓库地址等。

• url 远程仓库地址

  你也可以把用户名和密码写在地址后面，这样就不用每次都输入用户名和密码了。

  [remote "origin"]
    url = https://<username>:<password>@<repository-url>

• branch 分支

  你可以设置默认的分支，这样每次 push 或者 pull 的时候就不用指定分支了。

  [branch "master"]
    remote = origin
    merge = refs/heads/master

Gitee 要注意的点

• Gitee 的远程仓库地址如果想放入账号密码，无法使用 token 名加 token 组合，只能使用用户名加 token

  如: https://<username>:<token>@<repository-url>

• 用户名必须要全部小写，否则会报无效的用户名

• 配置了 ssh 后再拉取隐私仓库就无需输入用户名和密码

开发实践

开发分支

可以通过创建开发分支来进行特性开发，然后合并到主分支。

git checkout -b feature-branch

开发完成后，可以合并到主分支。

推荐使用 rebase 来变基，这样可以保持提交历史的整洁（详见下文 合并策略 部分）

git checkout master
git merge feature-branch

合并后，可以删除开发分支。

git branch -d feature-branch

使用标签

Git 标签（tag）是一个指向某个特定提交的固定指针。

它是在提交历史上的一个静态的指针，可以用来标记重要的提交，比如发布版本。

（官方推荐做法是每一次修改都是一次提交，一个版本可能会包含多次提交，这个时候就可以使用标签来标记）

• 创建标签: 在发布一个新的版本时，可以使用 git tag 创建一个标签。

  它会在当前的提交上创建一个标签，可以指定标签名和注释。

  git tag -a v1.0 -m "Version 1.0"

• 查看标签: 使用 git tag 命令可以查看所有标签。

  git tag

• 查看标签信息: 使用 git show 命令可以查看标签的详细信息。

  git show v1.0

• 删除标签: 使用 git tag -d 命令可以删除标签。

  git tag -d v1.0

• 推送标签: 使用 git push origin <tag name> 可以推送标签到远程仓库。

  git push origin v1.0

• 推送所有标签: 使用 git push origin --tags 可以推送所有标签到远程仓库。

  git push origin --tags

• 删除远程标签: 使用 git push origin :refs/tags/<tag name> 可以删除远程标签。

  git push origin :refs/tags/v1.0

lightweight 标签

除了带注释的标签，还有一种轻量级标签，它只是一个指向某个提交的指针。

git tag v1.0

这种标签不会记录任何额外的信息，只是一个指向某个提交的指针。

管理多个版本

当需要维护多个版本的应用时，你可以创建不同的分支来分别管理生产版本和开发版本。例如，你可以使用以下的分支结构：

• master 分支：用于发布生产版本。

• develop 分支：用于开发新特性。

• release 分支：用于发布新版本。

• hotfix 分支：用于修复生产版本的 bug。

• feature 分支：用于开发新特性。

合并策略

如果直接合并分支，Git 会创建一个新的合并提交，这样会使提交历史变得混乱。

为了保持提交历史的整洁，可以使用 rebase 命令来变基。

git checkout feature-branch
git rebase master

要注意的是， git rebase master 实际上是在 feature-branch 分支上进行的操作。

rebase 的目的是将一个分支的提交重新应用到目标分支（通常是主分支）的末尾，这样可以避免出现分支和合并的痕迹，让分支历史保持线性。

注意: 如果在执行 rebase 时出现冲突，你需要手动解决冲突并继续 rebase。解决冲突后，使用以下命令继续：

git rebase --continue

如果你希望让主分支和开发分支保持一致，你还需要切换到主分支，然后合并开发分支。

git checkout master
git merge --ff-only feature-branch

• --ff-only 参数表示只允许快进合并（适用在目标分支是直接的父分支的情况，也就是目标分支没有新的提交，仅在源分支上有新提交）。

  如果主分支已经有新的提交，就不需要这个参数了。

通过这种方法，Git 的提交历史不会显示分支的合并痕迹，历史看起来就像在一条线上演进。

Commit 规范

每次提交消息中应该包含以下内容：

• type: 提交的类型。

• scope: 可选，提交的范围，比如 button、header、footer 等。

• subject: 提交的简短描述，不超过 50 个字符。

• body: 提交的详细描述，可以包含原因、解决方案等。

• footer: 提交的备注，比如关联的 issue、关闭的 issue 等。

type 类型

• feat: 新功能（feature）

• fix: 修复 bug

• docs: 文档（documentation），比如 README、CHANGELOG 等

• style: 格式（不影响代码运行的变动），比如空格、格式化等

• refactor: 重构（不是新增功能，也不是修复 bug）

• perf: 性能优化，体验优化

• test: 测试用例

• chore: 构建过程或辅助工具的变动

• revert: 撤销

示例

feat(button): add new button component

Add a new button component to the project.

- Add button component
- Add button styles
- Add button tests

Closes #123

案例及技巧

关联远程仓库

如果先在本地创建了一个仓库，然后想关联到远程仓库，可以使用以下命令：

git remote add origin <repository-url>

可以通过 git remote -v 检查关联的远程仓库。

查看提交历史

查看提交历史可以使用 git log 命令，通过不同的选项组合，git log 可以满足各种需求，从简单的日志查看到复杂的差异分析。

基础用法

• git log: 显示所有提交历史

  按时间顺序显示提交历史（从最近到最早）

  默认显示提交的完整信息：提交哈希、作者、时间、提交信息

• git log --oneline: 显示简洁的提交历史

  每行显示一个提交，格式为: <短哈希> <提交信息>

• git log --graph: 显示提交历史的图形化分支(可以结合 --oneline 使用)

  显示提交历史的分支图，可以清晰地看到分支的合并和分叉

筛选提交记录

• git log -n: 限制显示的提交数量

  -n 后面跟数字，表示显示最近的 n 条提交

• git log --author="Author Name": 按作者筛选提交记录

• git log --grep="keyword": 按关键字筛选提交记录

• git log -- <file_name>: 查看某个文件的提交历史

  git log --follow -- <file_name>: 查看文件的移动和重命名历史(即使文件被重命名，仍可查看其完整历史)

• git log --since="2 weeks ago" --until="yesterday": 按时间筛选提交记录

  --since 和 --until 支持多种时间格式，比如 2 weeks ago、2021-01-01 等

• git log -p: 显示每次提交的详细修改内容

• git log --stat: 显示每次提交修改的文件、行数变化统计

• git log --shortstat: 显示每次提交修改的文件、行数变化统计（简洁版）

• git log --numstat: 以数字形式显示每次提交的新增和删除行数

• git log --oneline --graph --decorate -10: 图形化显示最近的提交和分支结构

比较与差异

• git log branch1..branch2: 显示 branch1 没有而 branch2 有的提交

  如 git log your-branch..origin/your-branch 可以查看远程分支的新增提交

• git log branch1...branch2: 显示 branch1 和 branch2 之间的差异

  三点语法 ... 显示两个分支各自独有的提交

• git log --oneline --graph --left-right your-branch...origin/your-branch: 显示两个分支的提交差异

  左右箭头指示差异归属，--left-right 显示提交是在哪个分支上的

自定义显示格式

通过 --pretty 参数，可以自定义显示提交历史的格式。

如 git log --pretty=format:"%h - %an, %ar : %s" 可以显示提交的短哈希、作者、提交时间、提交信息。

常用的占位符有：

• %h：提交的短哈希

• %H：提交的完整哈希

• %an：作者名

• %ae：作者邮箱

• %ar：提交时间（相对时间）

• %s：提交信息

撤销和回退操作

撤销本次修改

如果只需要撤销当前工作区的修改，可以使用以下命令：

• 使用git restore . （适用于 Git 2.23+）撤销所有修改。

• 如果是老版本的 Git，可以使用git checkout -- .命令。

  . 表示当前目录，如果只想撤销某个文件的修改，可以指定文件名

  如果没有参数--，后面直接跟具体的文件名，表示撤销单个文件

清理未追踪文件

新增的文件属于未追踪状态，无法通过撤销修改恢复，需要使用 git clean 命令：

• 预览将要删除的文件，避免误删，可以使用git clean -n来预览。

• 确认后，可以使用git clean -f来删除文件，或者使用git clean -f -d来删除文件和目录。

注意: 这个命令会删除未追踪的文件，无法恢复，需要谨慎使用。

撤销已经暂存的修改

如果已经使用git add将文件添加到暂存区，但是又不想提交，可以使用git reset命令来撤销。

• 使用git reset HEAD . 撤销暂存区的修改。

  . 表示当前目录，如果只想撤销某个文件的修改，可以指定文件名

回退到之前的操作

如果发现操作错误，可以回退到之前的某个版本或提交:

• 使用 git reflog 查看最近的操作记录:

  abc1234 (HEAD -> main) HEAD@{0}: pull origin main: Fast-forward
  def5678 HEAD@{1}: commit: Fixed bug
  ghi9012 HEAD@{2}: checkout: moving from feature-branch to main

• 找到目标记录(比如HEAD@{1})，然后使用git reset回退：

  git reset --hard HEAD@{1}

  注意: git reset --hard 会丢失未保存的修改，并删除之后的提交，需要小心使用。

• 如果只想撤回最近一次提交，将修改保留在工作区，可以使用：

  git reset --mixed HEAD~1

• 回退后，可通过git log查看提交历史，确认操作是否成功。

修改最近的提交信息

如果你提交了代码后，发现提交信息有误，可以使用 git commit --amend 来修改最近的提交信息。

这个命令会打开编辑器，你可以修改提交信息，然后保存退出。

如果已经提交到了远程服务器后，再次提交会导致冲突，这时候可以使用 --force 参数来强制提交。

git commit --amend
git push --force

注意: 强制提交会覆盖远程仓库的提交，因此请确保其他人没有基于旧的提交进行工作，否则可能导致他们的提交丢失或需要重新同步。

放弃本地修改，与远程仓库同步

如果本地代码和远程仓库有冲突，你不想要本地的修改，可以使用以下命令：

git fetch --all # 取回远程库的所有修改；
git reset --hard origin/main  # 指向远程库origin的main分支；

避免本地修改被远程覆盖

仅讨论文件已经被追踪的情况。

如果你在本地修改了文件，但是远程仓库也有修改，这时候你直接 pull 会导致冲突。

保留本次修改

这时候你可以使用 stash 命令来暂存本地修改，然后再 pull。

git stash
git pull
git stash pop

恢复本地版本

拉取远程后，如果你想保留本地修改，可以使用 checkout 命令。

git checkout --ours file.txt

• ours 表示保留本地版本

保留本地配置不受版本控制

正常情况下，不应该有这个操作，如果是配置文件，应该在本地配置文件中添加忽略，不要提交到远程仓库，如果希望远程仓库有参考，应该使用模板文件，比如 config.file.example。

如果本地是一个配置文件，你希望一直保留，不受版本控制的影响，可以使用 update-index 命令。

git update-index --skip-worktree config.json
# 恢复使用
git update-index --no-skip-worktree config.json

这样就可以避免本地修改被覆盖。（实测如果远程仓库对该文件有修改，会导致无法 pull @2024-11-27）

还可以使用 assume-unchanged 命令，这个命令和skip-worktree类似，但是它会在git status中显示。

git update-index --assume-unchanged config.json
# 取消使用
git update-index --no-assume-unchanged config.json

注意: 仅推荐配置文件使用，因为如果远程仓库对该文件有更新，你的本地版本可能会与远程版本产生差异。

Git 区分文件名大小写

可以通过修改配置来决定是否区分文件名的大小写：

git config core.ignorecase false

如果已经提交了，你之后即使在本地更改文件夹大小写，也不在更新线上的版本，这在部署时，就很容易出问题。

所以一定要修改成正确的，解决方法就是通过把要修改的文件夹名改成临时的，提交后，再改回正确的，这样就完成了修改。

具体步骤及命令为：

# 将要修改的文件夹名称改为临时的，比如 Temp
mv incorrectFolder tempFolder
git add tempFolder
git commit -m "Temporary folder name change to fix case"
# 再将 Temp 改成正确的目录名称
mv tempFolder correctFolder
git add correctFolder
git commit -m "Fix folder name case"
# 之后提交就能解决问题
git push origin BRANCH_NAME

提交空文件夹到远程仓库

git 默认会忽略空文件夹，如果我们希望提交一些空的文件夹，以达到某种特定的目的，可以用两种方法来实现这个效果：

1. 为空文件夹添加 .gitkeep 文件(推荐)

   这个文件它本身是没有意义的，更像是团队使用者之间的一种约定，仅仅是为了标记这个空的文件夹是需要添加到仓库的。

   find ./ -type d -empty -exec touch {}/.gitkeep \;

2. 为空文件夹添加 .gitignore 文件

   添加这个文件也可以实现这个效果，但不是最佳的，因此推荐用第一种（因为它本身是有意义的）。

利用仓库快照实现本地设备间代码传输

如果我们不想利用线上仓库管理代码，只想本地设备间传输代码，可以使用 git bundle 命令来创建一个快照文件。

git bundle create repo.bundle --all

这个命令会将所有的分支和提交记录打包成一个文件，然后可以通过 git clone 来恢复仓库。

git clone repo.bundle

如果已经拉取过了仓库，可以使用 git pull 来更新仓库，就和正常的仓库一样。

git pull repo.bundle <branch>

注意: 这个时候是不需要指定<远程主机名>的，因为这个是本地的快照文件。

常见问题

ahead of 'origin/master' by 1 commit

原因是本地仓库中记录的 origin/master 可能没有更新到最新状态。

同步操作如 git pull 后，Git 可能并没有自动更新本地的远程分支状态。

你可以运行一下命令来更新远程分支引用：

git fetch origin

Github 远程仓库

Access Token

生成 Access Token

在使用 Github 的时候，可以使用 Access Token 来代替帐号密码，这样更加安全。

你可以在 Github 的设置中生成一个 Access Token，然后使用这个 Token 来代替密码。

git clone https://<username>:<token>@<repository-url>

权限设置

在生成 Token 的时候，可以设置 Token 的权限，推荐 最小权限原则。

权限解释

• Actions: 管理 GitHub Actions 工作流及其运行。

• Administration: 管理仓库的高级设置、协作者、团队权限。

• Attestations: 创建和查看与仓库相关的声明（attestations）, 例如代码签名。

• Custom properties: 创建和查看与仓库相关的自定义属性, 例如标记。

• Issues: 查看、创建和更新问题。

• Metadata: 仓库的基本信息，包括名称、描述、语言等。

• Contents: 仓库的文件内容。（可写的话，则可以提交代码、创建分支等）

下面是一些常用的权限组合：

只允许提交代码到仓库

• Metadata(mandatory): Read-only

• Contents: Read and write

工具推荐

gitkraken

可视化的分支，管理起来非常方便，也支持控制台操作。

注意: 免费用户不支持管理私有库。