Skip to content
项目
群组
代码片段
帮助
当前项目
正在载入...
登录 / 注册
切换导航面板
S
studyweb
项目
项目
详情
活动
周期分析
仓库
仓库
文件
提交
分支
标签
贡献者
图表
比较
统计图
议题
0
议题
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
CI / CD
CI / CD
流水线
作业
日程
统计图
Wiki
Wiki
代码片段
代码片段
成员
成员
折叠边栏
关闭边栏
活动
图像
聊天
创建新问题
作业
提交
问题看板
Open sidebar
project
studyweb
Commits
913a48da
提交
913a48da
authored
7月 07, 2026
作者:
zhangqianwei
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
cfm_模块一(1.1)
上级
9ce011f1
显示空白字符变更
内嵌
并排
正在显示
1 个修改的文件
包含
96 行增加
和
50 行删除
+96
-50
模块一-Python工程化.md
docs/Python工程化/模块一-Python工程化.md
+96
-50
没有找到文件。
docs/Python工程化/模块一-Python工程化.md
浏览文件 @
913a48da
...
@@ -3,6 +3,7 @@
...
@@ -3,6 +3,7 @@
> **本模块导读**:本模块面向 Python 后端 / LLM 应用开发者,目标是建立工程化的 Python 编程基础。包含 5 个章节,从代码版本管理(Git)到面向对象、设计模式(装饰器)、异步编程,最后到代码规范。学完本模块,你应该能像一名"工程化思维"的开发者一样,写出可维护、可协作、可部署的 Python 代码。
> **本模块导读**:本模块面向 Python 后端 / LLM 应用开发者,目标是建立工程化的 Python 编程基础。包含 5 个章节,从代码版本管理(Git)到面向对象、设计模式(装饰器)、异步编程,最后到代码规范。学完本模块,你应该能像一名"工程化思维"的开发者一样,写出可维护、可协作、可部署的 Python 代码。
>
>
> **章节列表**:
> **章节列表**:
>
> - **1.1 Git 使用** ← 本文档当前章节(★5 必会)
> - **1.1 Git 使用** ← 本文档当前章节(★5 必会)
> - 1.2 面向对象
> - 1.2 面向对象
> - 1.3 装饰器
> - 1.3 装饰器
...
@@ -22,7 +23,7 @@
...
@@ -22,7 +23,7 @@
### 📋 本章知识点速览
### 📋 本章知识点速览
| 编号 | 知识点 | 难度 | 一句话概括 |
| 编号 | 知识点 | 难度 | 一句话概括 |
| ------
- | ------------ | ----- |
-------------------- |
| ------
| --------------------- | ---------- | --------------
-------------------- |
| 1.1.1 | 首次配置 | ★★☆ | 装好 Git 后的第一件事 |
| 1.1.1 | 首次配置 | ★★☆ | 装好 Git 后的第一件事 |
| 1.1.2 | 克隆项目 | ★★☆ | 把远程代码下载到本地 |
| 1.1.2 | 克隆项目 | ★★☆ | 把远程代码下载到本地 |
| 1.1.3 | 分支操作 | ★★★ | 多人协作不打架的关键 |
| 1.1.3 | 分支操作 | ★★★ | 多人协作不打架的关键 |
...
@@ -78,7 +79,7 @@ v1.docx → v2.docx → v3-改哭了版.docx → v3-真的改哭了.docx →
...
@@ -78,7 +79,7 @@ v1.docx → v2.docx → v3-改哭了版.docx → v3-真的改哭了.docx →
#### 6 条命令速查表(先背这 6 条)
#### 6 条命令速查表(先背这 6 条)
| 场景 | 命令 | 含义 |
| 场景 | 命令 | 含义 |
| -------
| ---------------------------------------- |
----------- |
| -------
----------- | ------------------------------------- | ---------
----------- |
| 看当前状态 |
`git status`
| 当前改了什么 |
| 看当前状态 |
`git status`
| 当前改了什么 |
| 看历史 |
`git log --oneline`
| 列出所有提交 |
| 看历史 |
`git log --oneline`
| 列出所有提交 |
| 把改动加入"购物车" |
`git add <文件名>`
或
`git add .`
| 暂存改动 |
| 把改动加入"购物车" |
`git add <文件名>`
或
`git add .`
| 暂存改动 |
...
@@ -118,10 +119,12 @@ Git 就像一个**班级签到表**——每次提交都相当于签到,签到
...
@@ -118,10 +119,12 @@ Git 就像一个**班级签到表**——每次提交都相当于签到,签到
### 输入
### 输入
#### 全局配置(张三在个人电脑上配置)
```
bash
```
bash
# 1. 设置全局用户名和邮箱(只需要做一次)
# 1. 设置全局用户名和邮箱(只需要做一次)
git config
--global
user.name
"
蔡馥名
"
git config
--global
user.name
"
张三
"
git config
--global
user.email
"
caifuming
@example.com"
git config
--global
user.email
"
zhangsan
@example.com"
# 2. 设置默认编辑器为 VS Code(推荐)
# 2. 设置默认编辑器为 VS Code(推荐)
git config
--global
core.editor
"code --wait"
git config
--global
core.editor
"code --wait"
...
@@ -130,27 +133,59 @@ git config --global core.editor "code --wait"
...
@@ -130,27 +133,59 @@ git config --global core.editor "code --wait"
git config
--global
init.defaultBranch main
git config
--global
init.defaultBranch main
```
```
#### 局部配置(张三在某个项目仓库中配置)
```
bash
# 进入某个项目目录
cd
~/projects/smart-app
# 在当前仓库单独设置用户信息(不加 --global)
git config user.name
"张三"
git config user.email
"zhangsan@company.com"
# 设置该仓库专用的编辑器
git config core.editor
"code --wait"
# 查看当前仓库的配置
git config
--list
--local
```
### 输出
### 输出
#### 全局配置输出
```
bash
```
bash
# 查看刚刚的配置
# 查看刚刚的配置
git config
--list
|
grep
-E
"user|editor|defaultBranch"
git config
--list
|
grep
-E
"user|editor|defaultBranch"
# user.name=
蔡馥名
# user.name=
张三
# user.email=
caifuming
@example.com
# user.email=
zhangsan
@example.com
# core.editor=code --wait
# core.editor=code --wait
# init.defaultBranch=main
# init.defaultBranch=main
```
```
#### 局部配置输出
```
bash
# 查看当前仓库的配置
git config
--list
--local
# user.name=张三
# user.email=zhangsan@company.com
# core.editor=code --wait
# 当你在这个仓库里 commit 时,作者信息就是:
# 张三 <zhangsan@company.com>
```
---
---
## 正解 vs 错误
## 正解 vs 错误
| 维度 | 正解 ✅ | 错误 ❌ |
| 维度 | 正解 ✅ | 错误 ❌ |
| --------
|
----------------------------------------------------- | ------------------------------------- |
| --------
-------- | ---------------------
----------------------------------------------------- | ------------------------------------- |
| 邮箱
| 用自己的
**真实邮箱**
(公司邮箱或 GitHub 注册邮箱) | 随便填一个邮箱,比如
`123@qq.com`
|
| 邮箱
| 用自己的
**真实邮箱**
(公司邮箱或 GitHub 注册邮箱) | 随便填一个邮箱,比如
`123@qq.com`
|
| 用户名
| 用
**全名**
或
**统一昵称**
,避免中英文混用 | 用中文 + 空格:
`蔡馥名 CFM`
|
| 用户名
| 用
**全名**
或
**统一昵称**
,避免中英文混用 | 用中文 + 空格:
`张三 ZS`
|
| 范围
| 个人电脑 →
`--global`
;临时改身份 → 仓库级不加 global | 每次提交前都临时改
|
| 范围
| 个人电脑 →
`--global`
;临时改身份 → 仓库级不加 global | 每次提交前都临时改
|
| 修改已提交的信息 | 用
`git commit --amend --author="新名字 <新邮箱>"`
修改
**最近一次**
| 直接
`git config`
然后重提(不生效)
|
| 修改已提交的信息 | 用
`git commit --amend --author="新名字 <新邮箱>"`
修改
**最近一次**
| 直接
`git config`
然后重提(不生效)
|
**错误表现**
:
**错误表现**
:
...
@@ -199,8 +234,8 @@ git config --list
...
@@ -199,8 +234,8 @@ git config --list
### 全局 vs 仓库级 vs 单次命令
### 全局 vs 仓库级 vs 单次命令
| 范围 | 命令示例 | 作用范围 |
| 范围 | 命令示例 | 作用范围 |
| --------
| ----------------------------------------------- |
--------------- |
| --------
-------- | ------------------------------------------ | -----------
--------------- |
| 全局
`--global`
|
`git config --global user.name "X"`
| 当前用户
**所有**
仓库
|
| 全局
`--global`
|
`git config --global user.name "X"`
| 当前用户
**所有**
仓库
|
| 仓库级(无标志) |
`cd my-repo && git config user.name "Y"`
| 仅当前仓库 |
| 仓库级(无标志) |
`cd my-repo && git config user.name "Y"`
| 仅当前仓库 |
| 单次命令 |
`git -c user.name="Z" commit -m "..."`
| 仅这一次提交 |
| 单次命令 |
`git -c user.name="Z" commit -m "..."`
| 仅这一次提交 |
...
@@ -248,6 +283,7 @@ A:GitHub 提供了 noreply 邮箱(`username@users.noreply.github.com`),
...
@@ -248,6 +283,7 @@ A:GitHub 提供了 noreply 邮箱(`username@users.noreply.github.com`),
## 参考文献
## 参考文献
[
1
]
Scott Chacon & Ben Straub.
*Pro Git (2nd Edition)*
. Apress, 2014. 第 1.5 节.
[
1
]
Scott Chacon & Ben Straub.
*Pro Git (2nd Edition)*
. Apress, 2014. 第 1.5 节.
[
2
]
Git 官方文档.
*Git Config*
.
[
https://git-scm.com/docs/git-config
](
https://git-scm.com/docs/git-config
)
---### 1.1.2 克隆项目
---### 1.1.2 克隆项目
...
@@ -255,9 +291,9 @@ A:GitHub 提供了 noreply 邮箱(`username@users.noreply.github.com`),
...
@@ -255,9 +291,9 @@ A:GitHub 提供了 noreply 邮箱(`username@users.noreply.github.com`),
---
---
##
什么是克隆(clone)?
##
1.1.2 克隆项目
### 一句话定义
###
什么是克隆(clone)?
一句话定义
`git clone <仓库地址>`
把远程仓库的
**完整历史**
复制到本地,生成一个全新的工作目录。
`git clone <仓库地址>`
把远程仓库的
**完整历史**
复制到本地,生成一个全新的工作目录。
...
@@ -301,11 +337,11 @@ Resolving deltas: 100% (856/856), done.
...
@@ -301,11 +337,11 @@ Resolving deltas: 100% (856/856), done.
## 正解 vs 错误
## 正解 vs 错误
| 维度 | 正解 ✅ | 错误 ❌ |
| 维度 | 正解 ✅ | 错误 ❌ |
| -------- | -------------------------------------------
|
-------------------------------------- |
| -------- | -------------------------------------------
-------------------------------------- | --------------------
-------------------------------------- |
| 仓库地址
| 用 SSH 地址:
`git@github.com:user/repo.git`
(无需每次输密码) | 用 HTTPS 地址但每次
`push`
都要输用户名密码(除非用 PAT)
|
| 仓库地址
| 用 SSH 地址:
`git@github.com:user/repo.git`
(无需每次输密码) | 用 HTTPS 地址但每次
`push`
都要输用户名密码(除非用 PAT)
|
| 子目录名
| 默认即可,要改的话用
`git clone <url> <新目录名>`
| 克隆完再 mv 改名(容易破坏 git 内部相对路径) |
| 子目录名
| 默认即可,要改的话用
`git clone <url> <新目录名>`
| 克隆完再 mv 改名(容易破坏 git 内部相对路径) |
| 深度
| 完整克隆:
`git clone <url>`
| 不小心加了
`--depth 1`
(后续
`git log`
看不到历史) |
| 深度
| 完整克隆:
`git clone <url>`
| 不小心加了
`--depth 1`
(后续
`git log`
看不到历史) |
| 已有目录
| 直接克隆到当前目录:先
`cd`
进空目录再
`git clone <url> .`
(注意末尾的
`.`
) | 在已有内容的目录里克隆(会冲突报错) |
| 已有目录
| 直接克隆到当前目录:先
`cd`
进空目录再
`git clone <url> .`
(注意末尾的
`.`
) | 在已有内容的目录里克隆(会冲突报错) |
---
---
...
@@ -314,7 +350,7 @@ Resolving deltas: 100% (856/856), done.
...
@@ -314,7 +350,7 @@ Resolving deltas: 100% (856/856), done.
### HTTPS vs SSH 两种方式对比
### HTTPS vs SSH 两种方式对比
| 维度 | HTTPS 协议 | SSH 协议 |
| 维度 | HTTPS 协议 | SSH 协议 |
| --------
| ----------------------------------------- | ----
------------------------------------ |
| --------
---------- | ----------------------------------------- |
------------------------------------ |
| 地址格式 |
`https://github.com/user/repo.git`
|
`git@github.com:user/repo.git`
|
| 地址格式 |
`https://github.com/user/repo.git`
|
`git@github.com:user/repo.git`
|
| 认证方式 | 用户名 + 密码(或 Personal Access Token) | SSH 密钥对(公钥配远程,私钥留本地) |
| 认证方式 | 用户名 + 密码(或 Personal Access Token) | SSH 密钥对(公钥配远程,私钥留本地) |
| 是否每次都要输密码 | 是(除非配 PAT 或 credential helper) | 否,只需配一次 SSH key |
| 是否每次都要输密码 | 是(除非配 PAT 或 credential helper) | 否,只需配一次 SSH key |
...
@@ -370,6 +406,7 @@ git clone --depth 1 git@github.com:user/repo.git
...
@@ -370,6 +406,7 @@ git clone --depth 1 git@github.com:user/repo.git
**Q:克隆时报错 `Permission denied (publickey)`?**
**Q:克隆时报错 `Permission denied (publickey)`?**
A:SSH Key 没配好。检查:
A:SSH Key 没配好。检查:
1.
私钥路径对不对:
`ls ~/.ssh/id_ed25519`
1.
私钥路径对不对:
`ls ~/.ssh/id_ed25519`
2.
公钥是否已加到 GitHub:
`cat ~/.ssh/id_ed25519.pub`
2.
公钥是否已加到 GitHub:
`cat ~/.ssh/id_ed25519.pub`
3.
SSH agent 加载了没有:
`ssh-add ~/.ssh/id_ed25519`
3.
SSH agent 加载了没有:
`ssh-add ~/.ssh/id_ed25519`
...
@@ -377,15 +414,18 @@ A:SSH Key 没配好。检查:
...
@@ -377,15 +414,18 @@ A:SSH Key 没配好。检查:
**Q:克隆很慢/超时?**
**Q:克隆很慢/超时?**
A:换协议试试:
A:换协议试试:
```
bash
```
bash
# 用 SSH 替代 HTTPS(在国内通常更快)
# 用 SSH 替代 HTTPS(在国内通常更快)
git clone git@github.com:user/repo.git
git clone git@github.com:user/repo.git
```
```
或者配 git proxy:
`git config --global http.proxy http://127.0.0.1:7890`
或者配 git proxy:
`git config --global http.proxy http://127.0.0.1:7890`
**Q:克隆完发现忘了 --depth,怎么补全历史?**
**Q:克隆完发现忘了 --depth,怎么补全历史?**
A:
A:
```
bash
```
bash
git fetch
--unshallow
git fetch
--unshallow
```
```
...
@@ -413,16 +453,14 @@ git fetch --unshallow
...
@@ -413,16 +453,14 @@ git fetch --unshallow
---
---
### 1.1.3 分支操作
## 1.1.3 分支操作
#### 什么是分支?
> 用 1-2 话说清:**分支 = 你的"平行宇宙"**,在分支上随便改不会影响主线,合并时再合到一起。
> 用 1-2 话说清:**分支 = 你的"平行宇宙"**,在分支上随便改不会影响主线,合并时再合到一起。
---
---
## 什么是分支?
### 一句话定义
分支(branch)是指向某个 commit 的
**可移动指针**
。新分支让你在不影响主线的情况下自由开发。
分支(branch)是指向某个 commit 的
**可移动指针**
。新分支让你在不影响主线的情况下自由开发。
### 为什么重要
### 为什么重要
...
@@ -432,6 +470,7 @@ git fetch --unshallow
...
@@ -432,6 +470,7 @@ git fetch --unshallow
### 生活类比
### 生活类比
想象你在写一本书:
想象你在写一本书:
-
`main`
分支 = 正式发行的版本
-
`main`
分支 = 正式发行的版本
-
`feature/新章节`
分支 = 你正在写的新章节
-
`feature/新章节`
分支 = 你正在写的新章节
-
`bugfix/第3章错别字`
分支 = 你同时在改的错别字
-
`bugfix/第3章错别字`
分支 = 你同时在改的错别字
...
@@ -495,13 +534,13 @@ Switched to a new branch 'feature/login'
...
@@ -495,13 +534,13 @@ Switched to a new branch 'feature/login'
## 正解 vs 错误
## 正解 vs 错误
| 维度 | 正解 ✅ | 错误 ❌ |
| 维度 | 正解 ✅ | 错误 ❌ |
| ---------------
| ---------------------------------------------------- |
-------------------------------------- |
| ---------------
--- | -------------------------------------------------------------- | ------------------
-------------------------------------- |
| 创建并切换分支 |
`git switch -c <新分支名>`
(Git 2.23+ 推荐) |
`git checkout -b <新分支名>`
(能用但语义混乱) |
| 创建并切换分支 |
`git switch -c <新分支名>`
(Git 2.23+ 推荐) |
`git checkout -b <新分支名>`
(能用但语义混乱) |
| 仅切换分支 |
`git switch <分支名>`
|
`git checkout <分支名>`
(同上) |
| 仅切换分支 |
`git switch <分支名>`
|
`git checkout <分支名>`
(同上) |
| 仅创建分支不切换 |
`git branch <新分支名>`
|
`git switch -c`
不想切换时 |
| 仅创建分支不切换 |
`git branch <新分支名>`
|
`git switch -c`
不想切换时 |
| 在 main 上直接开发 | ❌ 实际不推荐(实战中应切到 feature 分支) | 实习生最爱犯——直接在 main 改代码然后 push |
| 在 main 上直接开发 | ❌ 实际不推荐(实战中应切到 feature 分支) | 实习生最爱犯——直接在 main 改代码然后 push |
| 删未合并的分支 |
`git branch -D feature/login`
(强制删除) |
`git branch -d feature/login`
(会被警告分支未合并) |
| 删未合并的分支 |
`git branch -D feature/login`
(强制删除) |
`git branch -d feature/login`
(会被警告分支未合并) |
| 远程分支
|
`git switch -c feature/x origin/feature/x`
(基于远程建分支) | 手动
`git checkout origin/feature/x`
进入 detached 状态 |
| 远程分支
|
`git switch -c feature/x origin/feature/x`
(基于远程建分支) | 手动
`git checkout origin/feature/x`
进入 detached 状态 |
**错误表现**
:
**错误表现**
:
...
@@ -571,7 +610,7 @@ git branch -d feature/add-login
...
@@ -571,7 +610,7 @@ git branch -d feature/add-login
### 分支命名约定(见 1.1.11 详述)
### 分支命名约定(见 1.1.11 详述)
| 类型 | 前缀 | 示例 |
| 类型 | 前缀 | 示例 |
| ----
|
------------- | ----------------------------- |
| ----
---- | --
------------- | ----------------------------- |
| 新功能 |
`feature/`
|
`feature/user-auth`
|
| 新功能 |
`feature/`
|
`feature/user-auth`
|
| 修复 |
`bugfix/`
|
`bugfix/login-500-error`
|
| 修复 |
`bugfix/`
|
`bugfix/login-500-error`
|
| 紧急修复 |
`hotfix/`
|
`hotfix/critical-security`
|
| 紧急修复 |
`hotfix/`
|
`hotfix/critical-security`
|
...
@@ -586,7 +625,7 @@ git branch -d feature/add-login
...
@@ -586,7 +625,7 @@ git branch -d feature/add-login
A:
**Git 2.23 (2019) 起推荐用 `switch`**
,因为
`checkout`
同时承担"切换分支"和"恢复文件"两种语义,容易混淆。新项目统一用
`switch`
即可。
A:
**Git 2.23 (2019) 起推荐用 `switch`**
,因为
`checkout`
同时承担"切换分支"和"恢复文件"两种语义,容易混淆。新项目统一用
`switch`
即可。
| 任务 | 新写法(推荐) | 老写法 |
| 任务 | 新写法(推荐) | 老写法 |
| ----
| ---------------------- |
-------------- |
| ----
------ | ------------------------- | --------------------
-------------- |
| 切换分支 |
`git switch main`
|
`git checkout main`
|
| 切换分支 |
`git switch main`
|
`git checkout main`
|
| 创建并切换 |
`git switch -c dev`
|
`git checkout -b dev`
|
| 创建并切换 |
`git switch -c dev`
|
`git checkout -b dev`
|
| 恢复文件 |
`git restore README.md`
|
`git checkout HEAD -- README.md`
|
| 恢复文件 |
`git restore README.md`
|
`git checkout HEAD -- README.md`
|
...
@@ -594,6 +633,7 @@ A:**Git 2.23 (2019) 起推荐用 `switch`**,因为 `checkout` 同时承担"
...
@@ -594,6 +633,7 @@ A:**Git 2.23 (2019) 起推荐用 `switch`**,因为 `checkout` 同时承担"
**Q:怎么查看所有分支(含远程)?**
**Q:怎么查看所有分支(含远程)?**
A:
A:
```
bash
```
bash
git branch
-a
# -a 表示 all,包括远程
git branch
-a
# -a 表示 all,包括远程
git branch
-r
# 只看远程
git branch
-r
# 只看远程
...
@@ -639,6 +679,7 @@ A:能!Git 不会轻易丢弃对象(至少 30 天)。用 `git reflog` 找
...
@@ -639,6 +679,7 @@ A:能!Git 不会轻易丢弃对象(至少 30 天)。用 `git reflog` 找
### 一句话定义
### 一句话定义
"同步"包含
**两个动作**
:
"同步"包含
**两个动作**
:
-
**下载**
(fetch):把远程的新 commit 拉到本地,但
**不修改**
你的工作区
-
**下载**
(fetch):把远程的新 commit 拉到本地,但
**不修改**
你的工作区
-
**合并 / 变基**
(merge / rebase):把下载下来的 commit 整合到你当前分支
-
**合并 / 变基**
(merge / rebase):把下载下来的 commit 整合到你当前分支
...
@@ -649,6 +690,7 @@ A:能!Git 不会轻易丢弃对象(至少 30 天)。用 `git reflog` 找
...
@@ -649,6 +690,7 @@ A:能!Git 不会轻易丢弃对象(至少 30 天)。用 `git reflog` 找
### 生活类比
### 生活类比
想象你在改论文,老师时不时在共享文档里加批注:
想象你在改论文,老师时不时在共享文档里加批注:
-
`git fetch`
=
**只刷新你本地"看到的批注列表"**
,但不改你的文字
-
`git fetch`
=
**只刷新你本地"看到的批注列表"**
,但不改你的文字
-
`git pull`
=
`fetch`
+
`merge`
:刷新列表 +
**把你的文字和批注合并到一起**
-
`git pull`
=
`fetch`
+
`merge`
:刷新列表 +
**把你的文字和批注合并到一起**
-
`git pull --rebase`
=
`fetch`
+
`rebase`
:刷新列表 +
**把批注"挪到"你的文字前面**
-
`git pull --rebase`
=
`fetch`
+
`rebase`
:刷新列表 +
**把批注"挪到"你的文字前面**
...
@@ -689,7 +731,7 @@ Your branch is behind 'origin/main' by 3 commits, and can be fast-forwarded.
...
@@ -689,7 +731,7 @@ Your branch is behind 'origin/main' by 3 commits, and can be fast-forwarded.
## 正解 vs 错误
## 正解 vs 错误
| 维度 | 正解 ✅ | 错误 ❌ |
| 维度 | 正解 ✅ | 错误 ❌ |
| ----------
| ---------------------------------------------- |
---------------------------------------- |
| ----------
-- | ------------------------------------------------------- | ---------
---------------------------------------- |
| 日常同步 |
`git pull --rebase`
(保持线性历史) |
`git pull`
(默认会留下 merge commit,历史难看) |
| 日常同步 |
`git pull --rebase`
(保持线性历史) |
`git pull`
(默认会留下 merge commit,历史难看) |
| 多人共用分支 |
`git pull`
(用 merge,不要 rebase 别人写过的 commit) |
`git pull --rebase`
(改写已共享历史会坑队友) |
| 多人共用分支 |
`git pull`
(用 merge,不要 rebase 别人写过的 commit) |
`git pull --rebase`
(改写已共享历史会坑队友) |
| 提交前先拉 | 永远
**先 fetch/pull,再 commit,再 push**
| 写完直接 push(大概率推不上去) |
| 提交前先拉 | 永远
**先 fetch/pull,再 commit,再 push**
| 写完直接 push(大概率推不上去) |
...
@@ -770,7 +812,7 @@ A ── C ── B'(你的 commit 改了个"新爸爸")
...
@@ -770,7 +812,7 @@ A ── C ── B'(你的 commit 改了个"新爸爸")
### 一张表三选一
### 一张表三选一
| 行为 | 改不改你的 commit? | 历史形态 | 适用场景 |
| 行为 | 改不改你的 commit? | 历史形态 | 适用场景 |
| --------
| ------------- | ------ |
--------------- |
| --------
--------- | ------------------------- | ------------ | -------------
--------------- |
|
`fetch`
| 不改,仅下载远程 | 不变 | 看一眼远程状态 |
|
`fetch`
| 不改,仅下载远程 | 不变 | 看一眼远程状态 |
|
`pull`
| 改,生成 merge commit | 菱形分叉合并 | 多人共用分支、想保留完整拓扑 |
|
`pull`
| 改,生成 merge commit | 菱形分叉合并 | 多人共用分支、想保留完整拓扑 |
|
`pull --rebase`
| 改,重写你的 commit"爸爸" | 线性 | 个人 feature 分支提 PR 前 |
|
`pull --rebase`
| 改,重写你的 commit"爸爸" | 线性 | 个人 feature 分支提 PR 前 |
...
@@ -835,6 +877,7 @@ A:**已推送到远程且有别人基于它开发的 commit**。黄金法则
...
@@ -835,6 +877,7 @@ A:**已推送到远程且有别人基于它开发的 commit**。黄金法则
**Q:`git pull --rebase` 后我的 commit ID 全变了,会有问题吗?**
**Q:`git pull --rebase` 后我的 commit ID 全变了,会有问题吗?**
A:在
**个人 feature 分支上没问题**
:
A:在
**个人 feature 分支上没问题**
:
-
自己的 commit 改个 ID 没事,反正你 push 时 Git 会发现是同一个人
-
自己的 commit 改个 ID 没事,反正你 push 时 Git 会发现是同一个人
-
最后 push 时加
`-f`
强制推送即可
-
最后 push 时加
`-f`
强制推送即可
...
@@ -883,6 +926,7 @@ commit 是 Git 最小的"撤销单位"。一个 commit 就是一个完整的快
...
@@ -883,6 +926,7 @@ commit 是 Git 最小的"撤销单位"。一个 commit 就是一个完整的快
### 生活类比
### 生活类比
commit = 游戏的
**存档点**
:
commit = 游戏的
**存档点**
:
-
每次打 boss 前先存档
-
每次打 boss 前先存档
-
挂了就读档重来
-
挂了就读档重来
-
存档有"存档时间/标签"(commit message)
-
存档有"存档时间/标签"(commit message)
...
@@ -925,9 +969,9 @@ $ git commit -m "docs: 新增 README"
...
@@ -925,9 +969,9 @@ $ git commit -m "docs: 新增 README"
## 正解 vs 错误
## 正解 vs 错误
| 维度 | 正解 ✅ | 错误 ❌ |
| 维度 | 正解 ✅ | 错误 ❌ |
| -------------
|
-------------------------------------------------- | ------------------------------------------- |
| -------------
----- | --------
-------------------------------------------------- | ------------------------------------------- |
| 提交粒度 | 一个 commit 只做一件事(修一个 bug / 加一个功能) | 一个 commit 改了 10 个无关文件 |
| 提交粒度 | 一个 commit 只做一件事(修一个 bug / 加一个功能) | 一个 commit 改了 10 个无关文件 |
| add 范围
| 用
`git add <具体文件>`
或
`git add -p`
(交互式选改动) | 直接
`git add .`
把日志/构建产物一起加进去
|
| add 范围
| 用
`git add <具体文件>`
或
`git add -p`
(交互式选改动) | 直接
`git add .`
把日志/构建产物一起加进去
|
| commit message | 标题 50 字以内,正文 72 字换行(见 1.1.11) |
`git commit -m "fix"`
一个字打发 |
| commit message | 标题 50 字以内,正文 72 字换行(见 1.1.11) |
`git commit -m "fix"`
一个字打发 |
| 修改上一次 commit |
`git commit --amend`
| 又 commit 一次,造成无意义的 commit |
| 修改上一次 commit |
`git commit --amend`
| 又 commit 一次,造成无意义的 commit |
| 撤回未 push 的 add |
`git restore --staged <file>`
| 强行手动编辑 .git/index(千万不要) |
| 撤回未 push 的 add |
`git restore --staged <file>`
| 强行手动编辑 .git/index(千万不要) |
...
@@ -961,9 +1005,9 @@ b3e1d24 update
...
@@ -961,9 +1005,9 @@ b3e1d24 update
### `git add` 三种模式对比
### `git add` 三种模式对比
| 模式 | 含义 | 适用场景 |
| 模式 | 含义 | 适用场景 |
| -------------------
| ------------------- |
------------- |
| -------------------
- | ------------------------------------ | ---------------------
------------- |
|
`git add <文件名>`
| 只加这个文件 | 最常用、最安全 |
|
`git add <文件名>`
| 只加这个文件 | 最常用、最安全 |
|
`git add .`
| 当前目录及子目录下
**所有改动**
| 快速添加,记得提前看
`git status`
|
|
`git add .`
| 当前目录及子目录下
**所有改动**
| 快速添加,记得提前看
`git status`
|
|
`git add -p`
| 交互式:逐个 hunk 询问是否 add | 想把一个大改动拆成多个 commit |
|
`git add -p`
| 交互式:逐个 hunk 询问是否 add | 想把一个大改动拆成多个 commit |
### `git commit` 三种写法
### `git commit` 三种写法
...
@@ -988,7 +1032,7 @@ git commit --amend -m "新的 message"
...
@@ -988,7 +1032,7 @@ git commit --amend -m "新的 message"
### `git restore` vs `git reset` 撤回
### `git restore` vs `git reset` 撤回
| 任务 | 命令 | 备注 |
| 任务 | 命令 | 备注 |
| ---------
| ------------------------------------------------- | -------
---------- |
| ---------
----------- | ------------------------------- |
---------- |
| 撤回 add(保留改动) |
`git restore --staged <file>`
| 推荐 |
| 撤回 add(保留改动) |
`git restore --staged <file>`
| 推荐 |
| 撤回 add(旧写法) |
`git reset HEAD <file>`
| 等价 |
| 撤回 add(旧写法) |
`git reset HEAD <file>`
| 等价 |
| 撤回工作区改动 |
`git restore <file>`
| 不可恢复! |
| 撤回工作区改动 |
`git restore <file>`
| 不可恢复! |
...
@@ -1033,6 +1077,7 @@ A:用 `git add -p` 交互式添加(hunk by hunk),每个 commit 一个逻
...
@@ -1033,6 +1077,7 @@ A:用 `git add -p` 交互式添加(hunk by hunk),每个 commit 一个逻
**Q:commit 后发现 message 写错了,能改吗?**
**Q:commit 后发现 message 写错了,能改吗?**
A:
A:
-
还没 push:
`git commit --amend -m "新 message"`
-
还没 push:
`git commit --amend -m "新 message"`
-
已 push:
`git rebase -i HEAD~n`
(交互式改写,见 1.1.9)或者走 PR 重新提一个 commit
-
已 push:
`git rebase -i HEAD~n`
(交互式改写,见 1.1.9)或者走 PR 重新提一个 commit
...
@@ -1115,12 +1160,12 @@ Branch 'feature/login' set up to track remote branch 'feature/login' from 'origi
...
@@ -1115,12 +1160,12 @@ Branch 'feature/login' set up to track remote branch 'feature/login' from 'origi
## 正解 vs 错误
## 正解 vs 错误
| 维度 | 正解 ✅ | 错误 ❌ |
| 维度 | 正解 ✅ | 错误 ❌ |
| -------- | ------------------------------------------- | ---------------------------------------------------- |
| -------- | ------------------------------------------- | ----------------------------------------------------
----
|
| 首次推送
|
`git push -u origin <branch>`
(建立跟踪) | 一直
`git push origin <branch>`
(每次都写全名)
|
| 首次推送
|
`git push -u origin <branch>`
(建立跟踪) | 一直
`git push origin <branch>`
(每次都写全名)
|
| 后续推送
|
`git push`
(已有跟踪关系时) | 一直
`git push origin HEAD`
|
| 后续推送
|
`git push`
(已有跟踪关系时) | 一直
`git push origin HEAD`
|
| 强推
| ❌
**几乎永远不要用**
`git push -f`
| 在 main 上强推,删掉同事的 commit
|
| 强推
| ❌
**几乎永远不要用**
`git push -f`
| 在 main 上强推,删掉同事的 commit
|
| 推送前
| 先
`git pull --rebase`
同步 | 直接 push,被远程拒绝(rejected)
|
| 推送前
| 先
`git pull --rebase`
同步 | 直接 push,被远程拒绝(rejected)
|
| 推送 tag
|
`git push origin v1.0.0`
| 打了本地 tag 却没推送,队友
`git fetch --tags`
也看不到
|
| 推送 tag
|
`git push origin v1.0.0`
| 打了本地 tag 却没推送,队友
`git fetch --tags`
也看不到
|
**错误表现**
:
**错误表现**
:
...
@@ -1188,12 +1233,12 @@ git push
...
@@ -1188,12 +1233,12 @@ git push
### `push -f` 的"危险等级"对照表
### `push -f` 的"危险等级"对照表
| 场景
| 能否
`push -f`
| 后果
|
| 场景
| 能否
`push -f`
| 后果
|
| ------------------------
| ----------- |
----------------- |
| ------------------------
------------- | ------------------------------------------ | ------------
----------------- |
| 推送到你的
**个人 feature 分支**
| ✅ 可以(用
`--force-with-lease`
更安全) | 改写自己分支历史,无人受影响
|
| 推送到你的
**个人 feature 分支**
| ✅ 可以(用
`--force-with-lease`
更安全) | 改写自己分支历史,无人受影响
|
| 推送到
**多人共用的 dev 分支**
| ❌
**绝对禁止**
| 删掉同事的 commit,他们全炸了
|
| 推送到
**多人共用的 dev 分支**
| ❌
**绝对禁止**
| 删掉同事的 commit,他们全炸了
|
| 推送到 main / master
| ❌
**绝对禁止**
| 全员受影响,CI 挂一地
|
| 推送到 main / master
| ❌
**绝对禁止**
| 全员受影响,CI 挂一地
|
| 推送到 team 的 release-x 分支
| ❌
**绝对禁止**
| 影响版本发布
|
| 推送到 team 的 release-x 分支
| ❌
**绝对禁止**
| 影响版本发布
|
**安全替代**
:
`--force-with-lease`
**安全替代**
:
`--force-with-lease`
...
@@ -1209,6 +1254,7 @@ git push --force-with-lease origin feature/my-branch
...
@@ -1209,6 +1254,7 @@ git push --force-with-lease origin feature/my-branch
**Q:push 时报错 `non-fast-forward`,怎么办?**
**Q:push 时报错 `non-fast-forward`,怎么办?**
A:
A:
```
bash
```
bash
# 先拉取,再合并/变基,再 push
# 先拉取,再合并/变基,再 push
git pull
--rebase
origin <branch>
git pull
--rebase
origin <branch>
...
@@ -1222,6 +1268,7 @@ A:分支保护(GitHub Branch Protection)启用,禁止强推。联系管
...
@@ -1222,6 +1268,7 @@ A:分支保护(GitHub Branch Protection)启用,禁止强推。联系管
**Q:我 push 错了,想撤回怎么办?**
**Q:我 push 错了,想撤回怎么办?**
A:见 1.1.9 版本回退。一般做法:
A:见 1.1.9 版本回退。一般做法:
-
撤回自己 push 的最后一次 commit:
`git revert HEAD && git push`
-
撤回自己 push 的最后一次 commit:
`git revert HEAD && git push`
-
撤回本地的错误 commit 后再 push(如果是自己独有分支):
`git reset --hard HEAD^ && git push -f`
-
撤回本地的错误 commit 后再 push(如果是自己独有分支):
`git reset --hard HEAD^ && git push -f`
...
@@ -1247,4 +1294,3 @@ A:见 1.1.9 版本回退。一般做法:
...
@@ -1247,4 +1294,3 @@ A:见 1.1.9 版本回退。一般做法:
[
1
]
*Pro Git*
第 2.5 节 "远程仓库的使用"。
[
1
]
*Pro Git*
第 2.5 节 "远程仓库的使用"。
---
---
编写
预览
Markdown
格式
0%
重试
或
添加新文件
添加附件
取消
您添加了
0
人
到此讨论。请谨慎行事。
请先完成此评论的编辑!
取消
请
注册
或者
登录
后发表评论