Git 高级玩法

发表于 更新于 分类于 阅读次数： 本文字数： 29k 阅读时长 ≈ 27 分钟
Git 相关的使用技巧、常见的坑 和 Github 社区中高频的缩写。

Github Octocat

（图片来源：Github™ 官网）

Git Apply

1
2
# 指定 --reject 强制打补丁，会生成 .rej 文件，需要手动解决冲突
$ git apply --reject yuzhouwan.patch

Git Blame

1
2
3
# 查看文件中，每一行的修改人和最后改动时间
$ git blame pom.xml
  ^e81ccde3 (BenedictJin 2018-06-04 11:16:19 +0800   1) <?xml version="1.0" encoding="UTF-8"?>

Git Branch

1
2
3
4
5
6
7
8
9
10
11
12
# 克隆当前分支，以此创建新的 branch，并切换
$ git checkout -b <branch>

# 重命名 branch 名称
$ git branch -m <old_name> <new_name>
$ git branch -m <new_name>

# 恢复删除掉的 branch
# 查看你上一次 commit SHA1 值
$ git reflog
# 恢复
$ git branch <branch_name> <sha1>

Git Cache

1
2
3
4
5
6
7
# 添加 .gitignore 文件之后，可能有些文件报错 `ignored tracked with git`
# 需要用 `git rm --cached` 进行删除
$ git rm --cached <file>

# 部分动态文件可能报错文件内容不一致 `the following files have staged content different from both the file and the HEAD`
# 需要增加 `-f` 参数进行强制删除
$ git rm --cached -f .idea/workspace.xml

Git Cherry-pick

1
2
# 指定某一次提交，合并到当前分支中
$ git cherry-pick 5738c801c

Git Checkout

checkout 的同时，创建新的 branch

1
$ git checkout -b <new_branch_new>

撤销某个文件的修改

1
$ git checkout -- <file>

Git Clone

1
2
3
4
5
# 只下载最后一次 commit 版本的代码
$ git clone --depth 1 https://github.com/asdf2014/yuzhouwan

# 此时，是不可以直接 push 代码的，需要下载剩下的历史 commit 记录，否则会报错 shallow update not allowed
$ git fetch --unshallow origin

Git Config

1
2
3
4
5
$ git config --global user.name "asdf2014"
$ git config --global user.email "asdf2014@apache.org"
$ git reset .
$ git add -A
$ git diff --staged

Git Commit

Allow Empty

1
$ git commit --allow-empty -m 'yuzhouwan.com'

Commit Merge

常规操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$ git log --pretty=oneline

  651cc60d971aba93bdde645b6331c33068462645 Merge branch 'master' of https://github.com/asdf2014/superset
  415610958494446ccd37c0c87da98eba56af42ac Merge branch 'temp'
  b881140282893fa4add183a2b3f2637968f95069 Merge branch 'master' into master
  f2bf3160583533bd0dc5004f248f81251aa8c57e Add NUMERIC num_type (#2127)
  6a0fefdbd542da4ea313313a191eadd1efe58faa Using the time zone with specific name for querying Druid
  9cd38fa1eda63152c27b76c29dd948f29444b686 little code refactor in models.py (#2124)

# 增加 --reverse 参数，可以倒序展示
$ git log --pretty=oneline --reverse
$ git reset --soft HEAD~2 &&
$ git commit --edit -m "$($ git log --format=%B --reverse HEAD..HEAD@{1})"

  [master fd41c16] Add NUMERIC num_type (#2127)
  1 file changed, 1 insertion(+), 1 deletion(-)

# 更改之后的 commit 信息
fd41c1608579408fcd26d0dd03adf0d461599101 Add NUMERIC num_type (#2127)
6a0fefdbd542da4ea313313a191eadd1efe58faa Using the time zone with specific name for querying Druid
9cd38fa1eda63152c27b76c29dd948f29444b686 little code refactor in models.py (#2124)

踩到的坑

Failed to push some refs
描述
1
2
3
4
5
6
7
8
Username for 'https://github.com': asdf2014
To https://github.com/asdf2014/superset.git
! [rejected]        ext_deprecation_warning -> ext_deprecation_warning (non-fast-forward)
error: failed to push some refs to 'https://github.com/asdf2014/superset.git'
hint: Updates were rejected because the tip of your current branch is behind
hint: its remote counterpart. Integrate the remote changes (e.g.
hint: '$ git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in '$ git push --help' for details.
解决
1
2
# 强制提交
$ git push -u origin ext_deprecation_warning --force

Commit Remove

1
2
$ git reset --hard <sha1-commit-id>
$ git push origin HEAD --force

Commit Change

只修改最后一次提交

1
2
3
4
5
6
7
# 格式
$ git commit --amend
$ git commit --amend -m "New commit message"
$ git commit --amend --author "Author Name <email@address.com>"
# 示例
$ git commit --amend -m 'remove warnings.simplefilter from cli.py into superset for PEP (#2137)'
$ git commit --amend --author "asdf2014 <asdf2014@apache.org>"

修改之前的提交信息

1
2
3
$ git rebase -i HEAD~2
  pick xxxx
  reword yyyy

修改提交的日期

1
2
3
4
5
6
7
8
9
# 查看当前时间
$ date -R
  Mon, 07 Jan 2018 11:12:55 +0800

# 修改最后一次 commit 的提交日期
$ git commit --amend --date="Mon, 07 Jan 2018 12:00:00 +0800"

# 更新提交日期为当前时间
$ git commit --amend --date="$(date -R)"

Reset into Specific Commit

1
2
3
4
5
# It will make your local code and local history be just like it was at that commit. But then if you wanted to push this to someone else who has the new history, it would fail.
$ git reset --hard c14809fa

# It will make your local files changed to be like they were then, but leave your history etc. the same.
$ git reset --soft c14809fa

Squash Commits into a Single Commit

常规操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 查看哪些 commits 需要进行合并
$ git log --pretty=oneline
# 合并最后 11 个 commit
$ git rebase -i HEAD~11
  pick xxxx yyyy
  pick xxxx yyyy
  pick xxxx yyyy
  # 将需要压缩的 commit 之前的 `pick` 替换为 `squash`
  pick xxxx yyyy
  squash xxxx yyyy
  squash xxxx yyyy

$ git commit --amend -m 'The log length has exceeded the limit of 4 MB in Travis'
$ git push origin travis_log --force

# 如需解决冲突后，继续进行 rebase 操作，可执行
$ git rebase --continue
# 如果想中断 rebase 操作，则执行
$ git rebase --abort
# 更多细节
$ git rebase --help

其他

回滚
1
$ git reset --hard ORIG_HEAD
回滚上一次操作
1
2
3
4
5
$ git commit -m "Something terribly misguided"
$ git reset HEAD~
<< edit files as necessary >>
$ git add ...
$ git commit -c ORIG_HEAD
指定 commit number
1
$ git rebase <commit number>
合并 branch 改动到 master 中
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 会将 branch 里的 commit 排到 master 的顶部，避免带 Merge 信息的 `空 commit` 出现
$ git checkout <branch name>
$ git rebase -i master

# 如果已经在当前 branch 执行了 git merge master，并解决了冲突，可以直接执行下面这行命令，完成 rebase 操作
$ git rebase --root --onto master --preserve-merges

# 万一出现太多的问题，难以解决，可以采用如下暴力的方式（在意 commit 信息的，请预先备份好）
$ git rebase --abort                # 首先 abort 之前的 rebase 流程
$ git checkout code_refactoring
$ git checkout -b re2
$ git branch root bbb61e638b391d29  # 以当前 branch 未做任何修改之前的 commit 为基础，创建 root 分支
$ git checkout re2
$ git diff master > ../123.patch    # 当前 branch 相对 master 已经做的修改打出 patch 文件
$ git checkout master
$ git checkout -b r2
$ git apply ../123.patch            # 以 master 为基础，apply 分支上做的修改
$ git diff master
$ git status
$ git diff --name-status | wc -l    # 确认修改的文件数 是否正确
$ git add .
$ git status
$ git diff master
$ git commit -m 'Improve `collection` related things that reusing a immutable object instead of creating a new object'
$ git status
$ git push origin r2:code_refactoring -f

Git Diff

Git diff two commits

1
$ git diff 1285c982 b0aaa7de > v3.4.6_vs_v3.4.10.patch

Git diff two branchs

1
$ git diff branch_1..branch_2

Git Fetch

Normal

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Github 上对某一个开源项目进行 fork
https://github.com/apache/superset
https://github.com/asdf2014/superset (forked from apache/superset)

# 本地获取 fork 出来的 asdf2014/superset
$ git init
$ git remote add origin https://github.com/asdf2014/superset.git
$ git remote -v
  origin  https://github.com/asdf2014/superset.git (fetch)
  origin  https://github.com/asdf2014/superset.git (push)

## 发现并没有 airbnb/superset 的 origin/master，可以在直接往 asdf2014/superset 提交，然后在 github 上进行 pull request 的创建
https://github.com/apache/superset/pull/2136 (Fix werkzeug instance was created twice in Debug Mode (#2135) #2136)

$ git fetch https://github.com/apache/superset.git master:tmp
$ git diff tmp
$ git merge tmp
$ git branch -d tmp

Fetch all tags

1
2
3
4
5
$ git fetch --tags
$ git checkout tags/release-3.4.6
$ git checkout master
  Previous HEAD position was 1285c982... ZooKeeper 3.4.6 release.
  Switched to branch 'master'

Git Merge

1
2
3
4
5
# 如果不希望 PR 中的 comment 信息被冲掉，可以使用 `git merge` 替代 `git rebase`
$ git merge
# 如果存在冲突，解决后，执行如下两个命令
$ git add .
$ git merge --continue

Git Push

1
2
3
# 设置上游仓库是 origin 之后，可以使用 git push 命令，而不用打全 git push origin master 命令了
$ git push --set-upstream origin master
$ git push

Git Reflog

恢复 git reset --hard

1
2
3
4
5
6
7
# 找到 reset 操作的
$ git reflog
  2a93709d (HEAD -> yuzhouwan, origin/yuzhouwan) HEAD@{0}: reset: moving to 631cc5233063bb014587a9caf0c9e3095fe6a60e
  b5b67779 HEAD@{1}: commit: Something important

# 回滚到 reset 操作前的一次提交
$ git reset --hard b5b67779

Git Remote

Change remote url

1
$ git remote set-url origin <url>

Pull specific tag from remote

1
$ git pull origin release-1.7.7:release-1.7.7

同时 push 到多个仓库

1
2
3
4
5
$ git remote set-url --add origin git@github.com:asdf2014/draft.git
$ git remote -v
  origin  https://git.coding.net/BenedictJin/test.git (fetch)
  origin  https://git.coding.net/BenedictJin/test.git (push)
  origin  git@github.com:asdf2014/test.git (push)

删除远程仓库

1
$ git remote rm origin

Git Reset

回退某一个文件的修改

1
$ git reset HEAD^ yuzhouwan.txt

Git Revert

创建某一个 commit 相反的 patch

1
$ git revert <commit number>

Git Rm

清理缓存

描述

　某些已经被加到 .gitignore 的文件提示，ignored, tracked with git

解决

1
2
3
4
5
6
7
8
9
10
11
12
# 单个文件
$ git rm --cached <file>

# 整个项目
$ git rm -r --cached .

# add 变更内容，并切换到 tmp 分支，commit 后，再删除 tmp 分支
$ git add .
$ git checkout -b tmp
$ git commit -m 'Remove ignored files'
$ git checkout master
$ git branch -D tmp

Git Show

展示 commit 相关的信息

1
2
3
4
5
# 查看 Apache Druid 项目中最早的 commit 是什么时候创建的
$ git init
$ git remote add origin https://github.com/apache/druid.git
$ git pull origin master
$ git rev-list --max-parents=0 HEAD
1
70e993806e48fbd35ac597a4075d046a98c5b6ae
1
$ git show 70e993806e48fbd35ac597a4075d046a98c5b6ae
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
commit 70e993806e48fbd35ac597a4075d046a98c5b6ae
Author: cheddar <echeddar@gmail.com>
Date:   Tue Oct 23 12:08:07 2012 -0700

    Initial commit

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..ee3d794a1a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,4 @@
+druid
+=====
+
+Metamarkets Druid Data Store
\ No newline at end of file
1
2
# 只展示日期
$ git show 70e993806e48fbd35ac597a4075d046a98c5b6ae -s --format=%cI
1
2012-10-23T12:08:07-07:00

展示 tag 相关的信息

1
2
3
4
5
# 查看 Apache Druid 项目中最早的 tag 是什么时候创建的
$ git init
$ git remote add origin https://github.com/apache/druid.git
$ git fetch --tags
$ git tag -l | sort -V | head -1
1
druid-0.1.0
1
$ git show --format="%ai" druid-0.1.0 | head -5
1
2
3
4
5
tag druid-0.1.0
Tagger: Fangjin Yang <fangjin@metamarketsgroup.com>

[maven-release-plugin]  copy for tag druid-0.1.0
2012-11-09 09:32:57 -0800

Git Stash

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# 查看当前分支已经存在的改动
$ git status
  On branch exception_governance
  Your branch is up to date with 'origin/exception_governance'.

  Changes to be committed:
    (use "git reset HEAD <file>..." to unstage)

          new file:   a

# 临时保存当前分支的修改
$ git stash
  Saved working directory and index state WIP on exception_governance: d5062a04 Govern old error codes and their exceptions

# 查看已经临时保存的改动
$ git stash list
  stash@{0}: WIP on exception_governance: d5062a04 Govern old error codes and their exceptions

# 已经看到修改已经被隐藏了
$ git add .
$ git diff --staged

# 再次从 stash 中恢复出之前的修改
$ git stash pop
  On branch exception_governance
  Your branch is up to date with 'origin/exception_governance'.

  Changes to be committed:
    (use "git reset HEAD <file>..." to unstage)

          new file:   a

  Dropped refs/stash@{0} (a88e4f6d681eb59b9b22e800f2c00f4c9e22d529)

Git Tag

Create tag

1
2
3
4
5
6
7
8
9
10
11
# 创建简单的标签
$ git tag v0.0.1

# 创建带有附注的 tag
$ git tag -a v0.0.2 -m "v0.0.2"

# 展示 tag 信息
$ git show v0.0.2

# 给指定的 commit，打 tag
$ git tag -a v0.0.3 6d23400

Submit tag

1
2
3
4
$ git push origin v0.0.2

# push 本地所有标签
$ git push origin –tags

Pull with specific tag

1
2
3
4
5
6
7
8
$ git clone

# 列出 tag 列表，并 checkout 到指定的 tag
$ git tag -l
$ git checkout tags/<tag_name>

# checkout 到指定的 tag，并创建一个新的 branch
$ git checkout tags/<tag_name> -b <branch_name>

Delete tag

1
2
3
4
5
6
7
8
# 删除本地 Tag
$ git tag -d v3.4.6.0
  Deleted tag 'v3.4.6.0' (was 0e48a03a)

# 删除远程 Tag
$ git push origin :refs/tags/v3.4.6.0
  To http://github.com/asdf2014/zookeeper.git
   - [deleted]           v3.4.6.0

Git 代理

通过命令设置

1
2
3
4
$ git config --global http.proxy 'http://192.168.1.101:8888'
$ git config --global https.proxy 'https://192.168.1.101:8888'
$ git config --global http.proxy 'socks5://127.0.0.1:1080'
$ git config --global https.proxy 'socks5://127.0.0.1:1080'

通过配置文件设置

1
2
3
4
5
6
7
8
9
$ vim ~/.ssh/config
   [http]
     proxy = http://192.168.1.101:8888
   [https]
     proxy = https://192.168.1.101:8888
#  [http]
#    proxy = socks5://127.0.0.1:1080
#  [https]
#    proxy = socks5://127.0.0.1:1080

踩过的坑

SSL_ERROR_SYSCALL in connection to git.coding.net:443

描述
1
2
3
4
5
6
7
8
9
10
$ git push origin master
  Counting objects: 9, done.
  Delta compression using up to 4 threads.
  Compressing objects: 100% (9/9), done.
  Writing objects: 100% (9/9), 1.05 KiB | 1.05 MiB/s, done.
  Total 9 (delta 6), reused 0 (delta 0)
  error: RPC failed; curl 35 OpenSSL SSL_connect: SSL_ERROR_SYSCALL in connection to git.coding.net:443
  fatal: The remote end hung up unexpectedly
  fatal: The remote end hung up unexpectedly
  Everything up-to-date
解决
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 先确保 git 和 curl 版本不能过低，如果 git <2.60 或者 curl <7.29，则需要升级到最新版本
$ git --version
$ curl --version

# 打开 git 命令的 trace 日志
$ export GIT_CURL_VERBOSE=1
$ export GIT_TRACE_PACKET=2

# 再次执行出错命令
$ git push origin master
  // ...
  error: RPC failed; curl 7 Failed to connect to 127.0.0.1 port 1080: Connection refused
  fatal: The remote end hung up unexpectedly
  Everything up-to-date

# 通过日志分析，定位出是 proxy 的问题，关闭 proxy 即可

Git 中文乱码

1
2
3
4
5
6
7
8
9
10
$ git config --global core.quotepath false          # 显示 status 编码
$ git config --global gui.encoding utf-8            # 图形界面编码
$ git config --global i18n.commit.encoding utf-8    # 提交信息编码
$ git config --global i18n.logoutputencoding utf-8  # 输出 log 编码
$ export LESSCHARSET=utf-8                          # `git log` 默认使用 `less` 分页，所以需要 `bash` 对 `less` 命令进行 `utf-8` 编码

# 让 `ls` 命令可以显示中文名称
$ vim %GIT_HOME%\mingw64\share\git\completion\git-completion.bash
  # 在文件末尾处添加一行
  alias ls="ls --show-control-chars --color"

Github 加速

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Ctrl + R（管理员权限运行）
# notepad "%SystemRoot%\system32\drivers\etc\hosts"

# https://asm.ca.com/zh_cn/ping.php
192.30.253.112 github.com
151.101.56.133 assets-cdn.github.com
192.30.253.116 api.github.com
192.30.253.121 codeload.github.com

# 中国 - 香港特别行政区（hkhkg02）
192.30.253.112 github.com
151.101.100.133 assets-cdn.github.com
192.30.253.116 api.github.com
192.30.253.121 codeload.github.com

Patch

1
2
$ git diff > patch.diff
$ git apply patch.diff

SSH 免密

常规操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 如果没有 .ssh 隐藏文件，则需要先打开 `git bash`，并执行
$ mkdir ~/.ssh
$ chmod 700 ~/.ssh

$ cd ~/.ssh
$ ssh-keygen -t rsa -C "asdf2014@apache.org"

# 将 ~/.ssh/id_rsa.pub 中的公钥加入 github/gitlab
$ ssh -T git@github.com
  Hi asdf2014! You've successfully authenticated, but GitHub does not provide shell access.    '

# http -> ssh
$ git remote -v
  origin  https://github.com/asdf2014/yuzhouwan (fetch)
  origin  https://github.com/asdf2014/yuzhouwan (push)

$ git remote set-url origin git@github.com:asdf2014/yuzhouwan.git

$ git remote -v
  origin  git@github.com:asdf2014/yuzhouwan.git (fetch)
  origin  git@github.com:asdf2014/yuzhouwan.git (push)

如何在代理环境下，同时支持 github / gitlab / coding 的免密操作

场景介绍

  • github.com 和 coding.net 需要走代理访问
  • gitlab 是自建的私服

PAC 配置

　在任何 git 相关操作之前，需要先配置 PAC 文件，来保证本机网络的畅通

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
var domains = {
  "coding.net": 1,
  "git.coding.net": 1,
  "github.com": 1,
  "ssh.github.com": 1
};

var proxy = "__PROXY__";

var direct = 'DIRECT;';

var hasOwnProperty = Object.hasOwnProperty;

function FindProxyForURL(url, host) {
    var suffix;
    var pos = host.lastIndexOf('.');
    pos = host.lastIndexOf('.', pos - 1);
    while(1) {
        if (pos <= 0) {
            if (hasOwnProperty.call(domains, host)) {
                return proxy;
            } else {
                return direct;
            }
        }
        suffix = host.substring(pos + 1);
        if (hasOwnProperty.call(domains, suffix)) {
            return proxy;
        }
        pos = host.lastIndexOf('.', pos - 1);
    }
}

SSH 配置

　在配置 SSH 之前，同样需要保证 ssh 命令使用的网络代理是正确的

　首先，找到 connect 命令安装路径

1
2
3
4
5
$ which connect
  /mingw64/bin/connect

$ which connect.exe
  /mingw64/bin/connect.exe

　其次，修改 ~/.ssh/config 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Host github.com
  User git
  Port 22
  Hostname github.com
  IdentityFile ~/.ssh/id_rsa  # 这里也可以填写绝对路径
  TCPKeepAlive yes
  IdentitiesOnly yes
  ProxyCommand /mingw64/bin/connect.exe -H 127.0.0.1:1080 %h %p

Host ssh.github.com
  User git
  Port 443
  Hostname ssh.github.com
  IdentityFile ~/.ssh/id_rsa
  TCPKeepAlive yes
  IdentitiesOnly yes
  ProxyCommand /mingw64/bin/connect.exe -H 127.0.0.1:1080 %h %p

Host git.coding.net
  User <email>  # coding.net 这里比较特殊，需要填写注册的邮箱地址
  PreferredAuthentications publickey
  IdentityFile ~/.ssh/id_rsa
  TCPKeepAlive yes
  IdentitiesOnly yes
  ProxyCommand /mingw64/bin/connect.exe -H 127.0.0.1:1080 %h %p

Host yuzhouwan.gitlab.com
  User git
  Port 22
  Hostname yuzhouwan.gitlab.com
  IdentityFile ~/.ssh/id_rsa
  TCPKeepAlive yes
  IdentitiesOnly yes

　然后，生成私钥、公钥，并分别拷贝公钥到 github / gitlab / coding 服务器中，具体操作见上文描述

　最后，验证

1
2
3
4
5
6
7
8
9
$ ssh -T git@github.com
  Hi asdf2014! You've successfully authenticated, but GitHub does not provide shell access.

$ ssh -T git@yuzhouwan.gitlab.com
  Welcome to GitLab, BenedictJin!

$ ssh -T git@git.coding.net
  Coding 提示: Hello BenedictJin, You've connected to Coding.net via SSH. This is a personal key.
  BenedictJin，你好，你已经通过 SSH 协议认证 Coding.net 服务，这是一个个人公钥

保持从 fork 端更新代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 申明 fork 端的仓库地址
$ git remote add upstream git@gitlab.yuzhouwan.com:asdf2014/yuzhouwan.git

# check 是否添加正确
$ git remote -v
  origin  git@gitlab.yuzhouwan.com:asdf2018/yuzhouwan.git (fetch)
  origin  git@gitlab.yuzhouwan.com:asdf2018/yuzhouwan.git (push)
  upstream  git@gitlab.yuzhouwan.com:asdf2014/yuzhouwan.git (fetch)
  upstream  git@gitlab.yuzhouwan.com:asdf2014/yuzhouwan.git (push)

# 更新所有的分支
$ git fetch upstream

# 指定更新某一个分支，这里以 master 分支为例
$ git fetch upstream master

# 使用 fork 端的 master 分支进行 rebase
$ git rebase upstream/master

代码风格配置

1
2
3
4
5
6
7
8
9
10
11
Intellij Idea

# download: http://www.arminalter.com/public/img/attach/checkstyle/eclipse-java-google-style.xml
File - Settings - Editor - Code Style - Schema - Manage - Import - Eclipse XML Profile
File - Settings - Plugins - "CheckStyle-IDEA"

# download: http://www.arminalter.com/public/img/attach/checkstyle/google_checks.xml
File - Setting - Other Settings - Check Style(+)                        # 如果这里使用的是 带有变量的 xml 文件，需要正确指定对应的 value 值
File - Settings - Editor - Inspections - Checkstyle real-time scan(√)   # 开启实时 check code style

# 一般的，项目中都会给出 format.xml 文件，如 hadoop(hadoop-format.xml) / druid(druid_intellij_formatting.xml) etc.

换行符

Auto CRLF

1
2
3
4
5
6
7
8
# 提交时转换为 LF，检出时转换为 CRLF
$ git config --global core.autocrlf true

# 提交时转换为 LF，检出时不转换
$ git config --global core.autocrlf input

# 提交检出均不转换
$ git config --global core.autocrlf false

Safe CRLF

1
2
3
4
5
6
7
8
# 拒绝提交包含混合换行符的文件
$ git config --global core.safecrlf true

# 允许提交包含混合换行符的文件
$ git config --global core.safecrlf false

# 提交包含混合换行符的文件时给出警告
$ git config --global core.safecrlf warn

设置编辑器

在 Mac 下设置 sublime 作为编辑器

1
2
3
4
5
6
7
# 修改 git 配置文件
$ vim ~/.gitconfig
  [core]
    editor = /Applications/Sublime\\ Text.app/Contents/SharedSupport/bin/subl -n -w

# 或者通过命令行配置
$ git config --global core.editor "/Applications/Sublime\ Text.app/Contents/SharedSupport/bin/subl -n -w"

在 Windows 下设置 Notepad++ 作为编辑器

1
2
3
4
5
6
7
# 修改 git 配置文件
$ vim ~/.gitconfig
  [core]
    editor = 'D:/apps/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin

# 或者通过命令行配置
$ git config --global core.editor "'D:/apps/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin"

GitHub CLI

安装

1
2
$ brew install gh
$ gh version
1
2
gh version 1.4.0 (2020-12-15)
https://github.com/cli/cli/releases/latest

升级

1
2
$ brew update
$ brew upgrade gh

首次获取 issue 列表时需要进行赋权

1
$ gh issue list
1
2
HTTP 401: Bad credentials (https://api.github.com/graphql)
hint: try authenticating with `gh auth login`
1
$ gh auth login
1
2
3
4
5
6
7
8
9
10
11
12
13
? What account do you want to log into? GitHub.com
? What is your preferred protocol for Git operations? SSH
? Upload your SSH public key to your GitHub account? /Users/asdf2014/.ssh/id_rsa.pub
? How would you like to authenticate GitHub CLI? Login with a web browser

! First copy your one-time code: B666-0000
- Press Enter to open github.com in your browser...
✓ Authentication complete. Press Enter to continue...

- gh config set -h github.com git_protocol ssh
✓ Configured git protocol
✓ Uploaded the SSH key to your GitHub account: /Users/asdf2014/.ssh/id_rsa.pub
✓ Logged in as asdf2014

这里以 Apache Druid 为例

获取 issue 列表

1
$ gh issue list
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

Showing 30 of 925 open issues in apache/druid

#10525  Incorrect results (including nulls) when querying string column with ...  (Uncategorized problem report)     about 1 hour ago
#10523  Historical server fails to load segments in kubernetes                    (Helm Chart)                       about 1 hour ago
#10522  Ingesting to same Datasource from 2 different Kafka clusters with exa...  (Uncategorized problem report)     about 9 hours ago
#10521  Druid Lookups Auditing                                                                                       about 10 hours ago
#10520  Druid UI Load Data -> Edit Spec text area redundant reinsert              (Area - Web Console, Ease of Use)  about 23 hours ago
#10519  When I use topN query, the results are very different.                    (Uncategorized problem report)     about 1 day ago
#10516  Bad/outdated documentation on "S3 permissions settings"                                                      about 5 days ago
#10513  Averaging timestampdiff output yields MAX_INT                             (Uncategorized problem report)     about 5 days ago
#10512  A java.lang.ClassCastException Error in druid cluster 0.13.0              (Uncategorized problem report)     about 5 days ago
#10509  build from source with 0.19.0 failed                                      (Uncategorized problem report)     about 7 days ago
#10508  Kill task launched from web console is stuck                              (Uncategorized problem report)     about 8 days ago
#10501  Druid 0.18.1 DSQL                                                                                            about 11 days ago
#10498  Tasks fail without and there are no error logs for it                     (Uncategorized problem report)     about 9 days ago
#10497  [BUG] [Indexing Task 0.16.0] Update metadata failed after indexing ta...  (Uncategorized problem report)     about 7 days ago
#10494  Remove redundant `IncrementalIndex.Builder`                               (Design Review, Proposal)          about 12 days ago
#10493  Avro Union type support                                                   (Feature/Change Description)       about 12 days ago
#10477  When we choose to delete all the data of the specified datasource, de...  (Feature/Change Description)       about 15 days ago
#10468  Posible druid template for Openshift/Kubernetes                           (Design Review, Proposal)          about 18 days ago
#10462  [DRAFT] 0.20.0 Release Notes                                              (Release Notes)                    about 5 days ago
#10455  User Impersonation in Druid                                               (Feature/Change Description)       about 21 days ago
#10444  Better handling of different servers having different versions of bro...  (Area - Querying, Bug)             about 7 days ago
#10443  Druid middleManager jvm's InterpreterRuntime::throw_ClassCastException    (Uncategorized problem report)     about 23 days ago
#10442  Why druid expects data files to be available on all data servers                                             about 21 days ago
#10439  Druid Auth doesn't limit the permission                                                                      about 24 days ago
#10434  Show Unused segment count in Druid Console Summary page                   (Feature/Change Description)       about 26 days ago
#10423  Post metadata operation information to ingestion log for a Kill task      (Feature/Change Description)       about 27 days ago
#10415  Druid is on yarn ?                                                                                           about 29 days ago
#10411  StatsD emmiter just emit native queries count in druid/query/count me...  (Uncategorized problem report)     about 23 days ago
#10409  Documentation for SQL ARRAY to use [] instead of ()                                                          about 1 month ago
#10403  Kafka ingestion sometimes produces rows that aren't aggregated            (Uncategorized problem report)     about 1 month ago

获取 PR 列表

1
$ gh pr list
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

Showing 30 of 71 open pull requests in apache/druid

#10524  Kafka dynamic scale ingest tasks                                                           zhangyue19921010:kafka-dynamic-scale-ingest-tasks
#10518  Add grouping_id function                                                                   abhishekagarwal87:grouping_id
#10517  Fix compaction integration test CI timeout                                                 maytasm:IMPLY-4796
#10505  WIP: Avro union support                                                                    josephglanville:jpg/avro-union-support
#10502  0.20.0                                                                                     0.20.0
#10499  support for vectorizing expressions with non-existent inputs, more consistent type han...  clintropolis:vector-nil-expr
#10495  Added Request log updates for status change on cooridnator / overlord…                    senthilkv:requestlog
#10484  improve retention rule management with import rules                                        kroeders:ft-import-retention-rules
#10478  Refactor AppenderatorConfig to inherit from TuningConfig                                   liran-funaro:pr-tuning-config
#10467  Fix bug in TimedShutoffInputSourceReader where a timeout does not close all registered...  maytasm:REQ-1314
#10464  Improved exception handling in case of query timeouts                                      a2l007:timeout_status
#10458  Fix the config initialization on container restart                                         valdemar-giosg:feature-fix-docker-entrypoint-config-overwrite
#10448  Added CronScheduler support as a proof to clock drift while emitting metrics               miqdigital:cronScheduling
#10428  allow server selection to be aware of query                                                kroeders:ft-query-aware-selectors
#10427  ServerSelectorStrategy to filter servers with missing required lookups                     kroeders:ft-lookup-aware-server-selector-ext
#10421  Improve lookup state update to avoid query failures                                        yuanlihan:improve-lookup-state-update
#10420  Add ingestion merge count metric                                                           jon-wei:merge_metric
#10418  Support to show leader of coordinators in `Services` web console view                      FrankChen021:show_leader
#10414  Applying modification pattern in #10025 to DataSegmentPusher#getDefaultStorageDirWithE...  T45K:related_to_10025
#10412  prometheus metric exporter                                                                 adobe:feature/prometheus-metric-exporter
#10408  Web console: single instance of axios for all network requests                             AshishKapoor:axios-single-instance
#10407  emit processed bytes metric                                                                pjain1:processed_bytes
#10400  optimize_getPendingSegmentsForIntervalWithHandle                                           xiangqiao123:optimize_getPendingSegmentsForIntervalWithHandle
#10396  Update index.md                                                                            tlblessing:patch-1
#10383  Fix ingestion failure of pretty-formatted JSON message                                     FrankChen021:json_parse_bug
#10376  Live reporting system for parallel task                                                    jihoonson:live-metrics-system
#10365  Inject ObjectMapper instead of manually setting it for TaskReportFileWriter                jihoonson:inject-mapper-report-writer
#10363  fix injection failure of StorageLocationSelectorStrategy objects                           FrankChen021:bug_10348
#10339  Security overview documentation                                                            sthetland:security-doc-revamp
#10335  Configurable Index Type                                                                    liran-funaro:config-index

切换到某一个 PR 中

1
$ gh pr checkout 10524
1
2
3
4
5
6
7
8
remote: Enumerating objects: 44, done.
remote: Counting objects: 100% (44/44), done.
remote: Total 110 (delta 44), reused 44 (delta 44), pack-reused 66
Receiving objects: 100% (110/110), 43.63 KiB | 269.00 KiB/s, done.
Resolving deltas: 100% (45/45), completed with 27 local objects.
From https://github.com/apache/druid
 * [new ref]               refs/pull/10524/head -> kafka-dynamic-scale-ingest-tasks
Switched to branch 'kafka-dynamic-scale-ingest-tasks'
使用该命令后，会自动下载并切换到 PR 所对应的 branch 中

查看 PR 的 diff 内容

1
$ gh pr diff

合并 PR

1
$ gh pr merge
1
2
3
4
? What merge method would you like to use?  [Use arrows to move, type to filter]
> Create a merge commit
  Rebase and merge
  Squash and merge

GitPod

更新 JDK 版本

1
$ sdk list java | cat
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
We periodically need to update the local cache. Please run:

  $ sdk update

================================================================================
Available Java Versions for Linux 64bit
================================================================================
 Vendor        | Use | Version      | Dist    | Status     | Identifier
--------------------------------------------------------------------------------
 Corretto      |     | 20.0.2       | amzn    |            | 20.0.2-amzn         
               |     | 20.0.1       | amzn    |            | 20.0.1-amzn         
               |     | 17.0.8       | amzn    |            | 17.0.8-amzn         
               |     | 17.0.7       | amzn    |            | 17.0.7-amzn         
               |     | 11.0.20      | amzn    |            | 11.0.20-amzn        
               |     | 11.0.19      | amzn    |            | 11.0.19-amzn        
               |     | 8.0.382      | amzn    |            | 8.0.382-amzn        
               |     | 8.0.372      | amzn    |            | 8.0.372-amzn        
 Dragonwell    |     | 17.0.7       | albba   |            | 17.0.7-albba        
               |     | 11.0.19      | albba   |            | 11.0.19-albba       
               |     | 8.0.372      | albba   |            | 8.0.372-albba       
               |     | 8.0.275      | albba   |            | 8.0.275-albba       
 Gluon         |     | 22.1.0.1.r17 | gln     |            | 22.1.0.1.r17-gln    
               |     | 22.1.0.1.r11 | gln     |            | 22.1.0.1.r11-gln    
 GraalVM CE    |     | 20.0.2       | graalce |            | 20.0.2-graalce      
               |     | 20.0.1       | graalce |            | 20.0.1-graalce      
               |     | 17.0.8       | graalce |            | 17.0.8-graalce      
               |     | 17.0.7       | graalce |            | 17.0.7-graalce      
 GraalVM Oracle|     | 20.0.2       | graal   |            | 20.0.2-graal        
               |     | 20.0.1       | graal   |            | 20.0.1-graal        
               |     | 17.0.8       | graal   |            | 17.0.8-graal        
               |     | 17.0.7       | graal   |            | 17.0.7-graal        
 Java.net      |     | 22.ea.9      | open    |            | 22.ea.9-open        
               |     | 22.ea.8      | open    |            | 22.ea.8-open        
               |     | 22.ea.7      | open    |            | 22.ea.7-open        
               |     | 22.ea.6      | open    |            | 22.ea.6-open        
               |     | 22.ea.5      | open    |            | 22.ea.5-open        
               |     | 22.ea.4      | open    |            | 22.ea.4-open        
               |     | 22.ea.3      | open    |            | 22.ea.3-open        
               |     | 21.ea.34     | open    |            | 21.ea.34-open       
               |     | 21.ea.33     | open    |            | 21.ea.33-open       
               |     | 21.ea.32     | open    |            | 21.ea.32-open       
               |     | 21.ea.31     | open    |            | 21.ea.31-open       
               |     | 21.ea.30     | open    |            | 21.ea.30-open       
               |     | 21.ea.29     | open    |            | 21.ea.29-open       
               |     | 21.ea.28     | open    |            | 21.ea.28-open       
               |     | 20.0.2       | open    |            | 20.0.2-open         
               |     | 19.ea.1.pma  | open    |            | 19.ea.1.pma-open    
 JetBrains     |     | 17.0.8       | jbr     |            | 17.0.8-jbr          
               |     | 17.0.7       | jbr     |            | 17.0.7-jbr          
               |     | 11.0.14.1    | jbr     |            | 11.0.14.1-jbr       
 Liberica      |     | 20.0.2.fx    | librca  |            | 20.0.2.fx-librca    
               |     | 20.0.2       | librca  |            | 20.0.2-librca       
               |     | 20.0.1.fx    | librca  |            | 20.0.1.fx-librca    
               |     | 20.0.1       | librca  |            | 20.0.1-librca       
               |     | 17.0.8.fx    | librca  |            | 17.0.8.fx-librca    
               |     | 17.0.8       | librca  |            | 17.0.8-librca       
               |     | 17.0.7.fx    | librca  |            | 17.0.7.fx-librca    
               |     | 17.0.7       | librca  |            | 17.0.7-librca       
               |     | 11.0.20.fx   | librca  |            | 11.0.20.fx-librca   
               |     | 11.0.20      | librca  |            | 11.0.20-librca      
               |     | 11.0.19.fx   | librca  |            | 11.0.19.fx-librca   
               |     | 11.0.19      | librca  |            | 11.0.19-librca      
               |     | 8.0.382.fx   | librca  |            | 8.0.382.fx-librca   
               |     | 8.0.382      | librca  |            | 8.0.382-librca      
               |     | 8.0.372.fx   | librca  |            | 8.0.372.fx-librca   
               |     | 8.0.372      | librca  |            | 8.0.372-librca      
 Liberica NIK  |     | 23.r20       | nik     |            | 23.r20-nik          
               |     | 23.r17       | nik     |            | 23.r17-nik          
               |     | 23.0.1.r20   | nik     |            | 23.0.1.r20-nik      
               |     | 23.0.1.r17   | nik     |            | 23.0.1.r17-nik      
               |     | 22.3.3.r17   | nik     |            | 22.3.3.r17-nik      
               |     | 22.3.3.r11   | nik     |            | 22.3.3.r11-nik      
               |     | 22.3.2.r17   | nik     |            | 22.3.2.r17-nik      
               |     | 22.3.2.r11   | nik     |            | 22.3.2.r11-nik      
 Mandrel       |     | 23.r20       | mandrel |            | 23.r20-mandrel      
               |     | 23.r17       | mandrel |            | 23.r17-mandrel      
               |     | 23.0.1.2.r20 | mandrel |            | 23.0.1.2.r20-mandrel
               |     | 23.0.1.2.r17 | mandrel |            | 23.0.1.2.r17-mandrel
               |     | 22.3.3.1.r17 | mandrel |            | 22.3.3.1.r17-mandrel
               |     | 22.3.2.1.r17 | mandrel |            | 22.3.2.1.r17-mandrel
 Microsoft     |     | 17.0.8       | ms      |            | 17.0.8-ms           
               |     | 17.0.7       | ms      |            | 17.0.7-ms           
               |     | 11.0.20      | ms      |            | 11.0.20-ms          
               |     | 11.0.19      | ms      |            | 11.0.19-ms          
 Oracle        |     | 20.0.2       | oracle  |            | 20.0.2-oracle       
               |     | 20.0.1       | oracle  |            | 20.0.1-oracle       
               |     | 17.0.8       | oracle  |            | 17.0.8-oracle       
               |     | 17.0.7       | oracle  |            | 17.0.7-oracle       
 SapMachine    |     | 20.0.2       | sapmchn |            | 20.0.2-sapmchn      
               |     | 20.0.1       | sapmchn |            | 20.0.1-sapmchn      
               |     | 17.0.8       | sapmchn |            | 17.0.8-sapmchn      
               |     | 17.0.7       | sapmchn |            | 17.0.7-sapmchn      
               |     | 11.0.20      | sapmchn |            | 11.0.20-sapmchn     
               |     | 11.0.19      | sapmchn |            | 11.0.19-sapmchn     
 Semeru        |     | 20.0.1       | sem     |            | 20.0.1-sem          
               |     | 17.0.7       | sem     |            | 17.0.7-sem          
               |     | 11.0.19      | sem     |            | 11.0.19-sem         
               |     | 8.0.372      | sem     |            | 8.0.372-sem         
 Temurin       |     | 20.0.2       | tem     |            | 20.0.2-tem          
               |     | 20.0.1       | tem     |            | 20.0.1-tem          
               |     | 17.0.8       | tem     |            | 17.0.8-tem          
               |     | 17.0.7       | tem     |            | 17.0.7-tem          
               |     | 11.0.20      | tem     |            | 11.0.20-tem         
               |     | 11.0.19      | tem     |            | 11.0.19-tem         
               |     | 8.0.382      | tem     |            | 8.0.382-tem         
               |     | 8.0.372      | tem     |            | 8.0.372-tem         
 Tencent       |     | 17.0.8       | kona    |            | 17.0.8-kona         
               |     | 17.0.7       | kona    |            | 17.0.7-kona         
               |     | 11.0.20      | kona    |            | 11.0.20-kona        
               |     | 11.0.19      | kona    |            | 11.0.19-kona        
               |     | 8.0.382      | kona    |            | 8.0.382-kona        
               |     | 8.0.372      | kona    |            | 8.0.372-kona        
 Trava         |     | 11.0.15      | trava   |            | 11.0.15-trava       
               |     | 8.0.282      | trava   |            | 8.0.282-trava       
 Unclassified|     | 22.3.3.r17   | grl     |            | 22.3.3.r17-grl      
               |     | 22.3.3.r11   | grl     |            | 22.3.3.r11-grl      
 Zulu          |     | 20.0.2       | zulu    |            | 20.0.2-zulu         
               |     | 20.0.2.fx    | zulu    |            | 20.0.2.fx-zulu      
               |     | 20.0.1       | zulu    |            | 20.0.1-zulu         
               |     | 20.0.1.fx    | zulu    |            | 20.0.1.fx-zulu      
               |     | 17.0.8       | zulu    |            | 17.0.8-zulu         
               |     | 17.0.8.crac  | zulu    |            | 17.0.8.crac-zulu    
               |     | 17.0.8.fx    | zulu    |            | 17.0.8.fx-zulu      
               |     | 17.0.7       | zulu    |            | 17.0.7-zulu         
               |     | 17.0.7.crac  | zulu    |            | 17.0.7.crac-zulu    
               |     | 17.0.7.fx    | zulu    | installed  | 17.0.7.fx-zulu      
               |     | 11.0.20      | zulu    |            | 11.0.20-zulu        
               |     | 11.0.20.fx   | zulu    |            | 11.0.20.fx-zulu     
               |     | 11.0.19      | zulu    |            | 11.0.19-zulu        
               | >>> | 11.0.19.fx   | zulu    | installed  | 11.0.19.fx-zulu     
               |     | 8.0.382      | zulu    |            | 8.0.382-zulu        
               |     | 8.0.382.fx   | zulu    |            | 8.0.382.fx-zulu     
               |     | 8.0.372      | zulu    |            | 8.0.372-zulu        
               |     | 8.0.372.fx   | zulu    |            | 8.0.372.fx-zulu     
               |     | 7.0.352      | zulu    |            | 7.0.352-zulu        
               |     | 6.0.119      | zulu    |            | 6.0.119-zulu        
================================================================================
Omit Identifier to install default version 17.0.8-tem:
    $ sdk install java
Use TAB completion to discover available versions
    $ sdk install java [TAB]
Or install a specific version by Identifier:
    $ sdk install java 17.0.8-tem
Hit Q to exit this list view
================================================================================
1
$ sdk install java 20.0.2-oracle
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
We periodically need to update the local cache. Please run:

  $ sdk update


Downloading: java 20.0.2-oracle

In progress...

######################################################################################################### 100.0%

Repackaging Java 20.0.2-oracle...

Done repackaging...

Installing: java 20.0.2-oracle
Done installing!

Do you want java 20.0.2-oracle to be set as default? (Y/n): Y

Setting java 20.0.2-oracle as default.

卸载 JDK

1
2
3
4
5
6
7
8
# 查看 JDK 的版本，可以看到当前 Gitpod 项目中使用的是 11.0.19.fx-zulu 版本
$ java -version

# 查看 uninstall 命令的帮助手册
$ sdk help uninstall

# 卸载 JDK，如果当前 JDK 是唯一的版本，则需要增加 --force 参数进行强制卸载
$ sdk uninstall java 11.0.19.fx-zulu --force

英文缩写

缩写 全拼 含义
ACK Acknowledgement 同意（改变 / 概念）
AFAICT As Far As I Can Tell 据我所知
AFAIK As Far As I Know 据我所知
AKA Also Known As 也称作
ASAP As Soon As Possible 尽快
BTW By The Way 顺便一提
CC Carbon Copy 抄送
FWIW For What It´s Worth 无论如何
FWIAW For What It´s All Worth 不管有没有用（FWIW 含义一样，且 FWIW 更常用一些）
FYI ForYour Information 供你参考
IANAL I Am Not A Lawyer 我不是律师（但是我发现了一个问题）
IIRC If I Recall Correctly 如果我没有记错的话
IMHO In My Humble Opinion 以我浅见
IMO In My Opinion 我的想法是
LGTM Looks Good to Me 在我看来很好
NACK / NAK Negative Acknowledgement 不同意（改变 / 概念）
OTOH On The Other Hand 另一方面
PTAL Please Take a Look 请看一下
RC Release Candidate 正式发布前的候选版本
RFC Request For Comments 征求意见
SGTM Sounds Good to Me 听起来不错
TBD To Be Done 尚未完成
TBH To Be Honest 老实说
TBR To Be Reviewed 准备被审查
TL;DR Too Long; Didn’t Read 太长懒得看
WDYT What Do You Think? 你怎么看？
WIP Work in Processing 进行中
WTF Why The Face 你懂的

资料

Doc

Emoji

欢迎加入我们的技术群，一起交流学习

群名称 群号
人工智能（高级）
人工智能（进阶）
大数据
算法
数据库