Qeuroal's Blog

静幽正治

Anaconda创建的虚拟环境多用户共享访问使用

在服务器上的sudo用户安装了anaconda,假设现在配置了虚拟的环境pytorch,需要怎么设置配置文件,才能保证连接服务器的别的标准用户(不具有sudo权限)怎么可以用到这个环境.

软件下载

建议使用国内源,例如清华大学开源软件镜像站。下载对应架构的安装包,例如 Anaconda3-2022.05-Linux-x86_64.sh。注意下载的是 anaconda3。下面假定你在 root 用户中执行指令,并且之前没有安装过 anaconda。

软件安装

  1. 运行下载的文件

    通过 chmod +x 为它增加执行权限

  2. 回车开始安装

  3. 阅读并输入 yes

  4. 指定安装目录,例如 /opt/anaconda3. (不要放在 root 根目录(~)下。)

  5. 等待安装完成

用户组与目录权限

为了使 anaconda 的文件仍归 root 所有,我们将新建一个用户组来为其余用户提供访问权限

1
2
3
4
5
6
groupadd condagroup # 新建一个名为 condagroup 的组;可以使用其它名称
adduser <username> condagroup # 将需要的用户加入该组
chgrp -R condagroup /opt/anaconda3 # 将安装目录转给该组
chmod 770 -R /opt/anaconda3 # 设置 root 用户与 condagroup 组的读写权限
find /opt/anaconda3 -type d -exec chmod g+s {} + # 设置组继承,使以后新建的文件夹仍属于 condagroup 组
chmod g-w /opt/anaconda3/envs # 共享环境只能由 root 修改

新环境位置

接下来,为了确保其余用户可以正确地在自己的目录中使用 -n <name> 新建环境,还要创建系统级的 anaconda 配置文件。在安装目录下(/opt/anaconda3)新建.condarc文件并写入

1
2
3
envs_dirs:
- /opt/anaconda3/envs
- ~/.conda/envs

根据 Conda configuration,envs_dirs是搜索命名环境的目录列表。创建新的命名环境时将放置在第一个可写位置,因此 root 用户将默认创建在安装目录下,成为共享环境,而其余用户会创建在自己的主目录中。

关于更多的管理选项,参见 Administering a multi-user conda installation。

你可能会想把这个文件的权限设为 644来避免被其余用户改动。这也是默认行为,因为 root 用户的默认 umask 是 0022。我们接下来将介绍这个 umask 可能带来的问题。

关于 umask

umask 控制新建文件的权限,简单来说是对指定的权限位进行排除。详细信息参见它的维基百科。

前述文件共享的机制是通过组读写权限完成的,意味着 anaconda 的文件需要有用户组的读与写权限。普通用户的默认 umask 是 0002,提供了用户组写仅限,但 root 用户的0022并没有。因此在使用 root 用户创建共享环境前需要修改 umask。

1
2
3
umask 0002
conda create -n env_name python # 示例
umask 0022 # 你可能会想恢复原值

否则会导致其它用户无权访问某些新下载的包的缓存等问题。在这种情况下,可以找到相应的文件并为其附加用户组写权限chmod g+w。

新增用户

现在你已经安装好了想要的 anaconda。如果有新用户,只需将其加入condagroup用户组,即可使用共享环境或创建新环境。

conda 环境配置

方法1: 局部(用户)配置 (Recommend)

以普通用户执行如下操作, 但是需要在所有的权限设置完毕之后方可使用

  1. 运行命令 eval "$(/opt/anaconda3/bin/conda shell.<YOUR_SHELL_NAME> hook)"

    如: eval "$(/opt/anaconda3/bin/conda shell.zsh hook)"

  2. 运行命令 conda initconda init <YOUR_SHELL_NAME>

    注: conda init 好像只会修改 .bashrc 文件

  3. 设置关闭自启动base环境

    1
    conda config --set auto_activate_base false

    或者修改文件 ~/.condarc

    1
    auto_activate_base: false

方法2: 全局(root)配置 (Not recommend)

以root用户进行如下操作

  1. 使用vim打开 /etc/profile, 在末尾添加

    1
    export PATH=/opt/anaconda3/bin:$PATH

    目的是为了让各用户的终端都能找到conda并运行。如果你安装在其它位置,请对应地更改目录值(下同)

  2. 运行 source /etc/profile 应用这项更改

方法3: 直接配置.bashrc或.zshrc

  1. vim ~/.bashrc

  2. 在最后一行添加:

    1
    export PATH="/opt/anaconda3/bin:$PATH"
  3. 用来激活环境变量

    1
    source ~/.bashrc
  4. 激活:

    • source activate
    • conda activate
  5. 退出激活:

    • source deactivate
    • conda deactivate

常见问题

Q: conda create 创建的目录不在 ~/.conda/envs

A: 删除 /opt/anaconda3/envs/.conda_envs_dir_test 文件

参考:

激活环境时设置环境变量

假设环境名为 env_name, 在env_name环境目录中, 创建文件夹 etc/conda/activate.d。在该文件夹下,创建 *.sh (linux/macos) 或 *.bat (windows) 文件, 将需设置的环境变量或脚本写入其中, 并通过 chmod +x *.sh 添加可执行权限. 当激活虚拟环境时, 该脚本自动运行.

分步骤如下:

  1. 在你的虚拟环境的 etc/conda/activate.d/ 目录下创建一个脚本文件

    1
    2
    3
    conda activate env_name
    mkdir -p $CONDA_PREFIX/etc/conda/activate.d
    touch $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
  2. 编辑env_vars.sh文件,添加你需要的环境变量:

    1
    2
    3
    4
    #!/bin/sh

    export MY_VAR="my_value"
    export ANOTHER_VAR="another_value"
  3. env_vars.sh 添加可执行权限:

    1
    chmod +x $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh

QAs

  1. UnicodeEncodeError: ‘ascii’ codec can’t encode character ‘\xe4’ in position 89: ordinal not in range(128)

    • 原因: 字符编码问题

    • 解决方案:

      • 方法1: 临时生效

        1. 运行命令

          1
          2
          export LANG="en_US.UTF-8"
          export LC_ALL="en_US.UTF-8"
        2. 再执行你需要执行的命令即可

      • 方法2: 当前用户永久生效

        有时 Linux 系统中编码并不能统一使用,而是只针对某用户下才使用该编码,即当使用 FineBI 的时候,在该系统用户下才能使用该编码。因此编辑配置文件时需要在该用户下编辑。

        1. 打开 ~/.bash_profile

          1
          vim ~/.bash_profile
        2. 在最后一行后面追加:

          1
          2
          export LANG="en_US.UTF-8"
          export LC_ALL="en_US.UTF-8"
        3. 重启终端或运行 source ~/.bash_profile

        注:~/.bash_profile 是每个用户都可使用该文件输入专用于自己使用的 shell 信息。

      • 方法3: 系统级对所有用户永久有效

        对整个系统都有效的修改方式,使整个系统都适应于该系统编码。该方法是在系统配置文件中添加编码方式将默认的方式覆盖掉。执行的命令如下:

        1. 打开 profile

          1
          vim /etc/profile
        2. 打开文件后在最后一行后面追加:

          1
          2
          export LANG="en_US.UTF-8"
          export LC_ALL="en_US.UTF-8"
        3. 重启终端或运行 source /etc/profile

      • 方法4: 使用 locale-gen/etc/locale.conf

        当需要生成并设置系统的默认语言环境时使用。

        1. 编辑 /etc/locale.gen,去掉 en_US.UTF-8 UTF-8 以及 zh_CN.UTF-8 UTF-8 行前的注释符号(#):

          1
          vim /etc/locale.gen
        2. 然后使用如下命令生成 locale:

          1
          locale-gen
        3. /etc/locale.conf 输入内容:

          1
          echo 'LANG=en_US.UTF-8'  > /etc/locale.conf

重点

如果要改变变量的值就用指针,不改变就用变量本身;使用变量本身,那么相当于读取,对原来的数据没有任何影响。

代码

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
#include <iostream>

using namespace std;

typedef struct Node {
int data;
struct Node *next;
}Node;

typedef struct Node *LinkList;

void initLinkList(LinkList *L)
{
(*L) = new Node;
(*L)->data = 0;
(*L)->next = NULL;
}

bool insertLinkList(LinkList head, int pos, int value)
{
LinkList p = head, t;
int j = 1;

while (p && j < pos) {
p = p->next;
j++;
}

if (!(p) || j > pos) return false;

t = new Node;
t->data = value;
t->next = p->next;
p->next = t;
head->data++;

return true;
}


bool deleteLinkList(LinkList l, int pos, int *value)
{
LinkList p = l, q;
int j = 1;

while (p->next && j < pos) {
p = p->next;
j++;
}

if (!(p->next) || j > pos) return false;

q = p->next;
p->next = q->next;
delete(q);
l->data--;
return true;
}

void clearLinkList(LinkList l)
{
LinkList p = l->next, q;
l->next = NULL;
while (p) {
q = p->next;
delete (p);
p = q;
l->data--;
}
}

void showLinkList(LinkList l)
{
cout << "Length is " << l->data << endl;
l = l->next;
while (l) {
cout << l->data << "\t";
l = l->next;
}
cout << endl;

return ;
}

int main()
{
LinkList head = NULL;
initLinkList(&head);

int value_del;
deleteLinkList(head, 1, &value_del);

for (int i = 1; i <= 10; i++) {
insertLinkList(head, i, i);
}
insertLinkList(head, 4, 10);
showLinkList(head);

deleteLinkList(head, 4, &value_del);
showLinkList(head);

clearLinkList(head);
showLinkList(head);

return 0;
}

详解

  1. 该链表是有头结点的链表;
  2. 什么时候用 LinkList LLinkList *L
    1. 需要改变指针的值的时候用 LinkList *L,若对指针的值没有改变时,使用 LinkList L
  3. 链表注意事项:
    1. LinkList head;只是定义了一个 变量名为head的指针变量,是一个野指针,那么需要在定义的时候进行初始化,即:LinkList head = NULL
    2. 想要使用 head 指向头结点,需要自己 new 一个结构体,将这个结构体的地址赋给 head
  4. insertLinkListdeleteLinkList的异同:
    1. insertLinkListdeleteLinkList不论在位置 pos 处插入一个结点还是在pos处删除结点,都是对 pos-1 进行操作。
    2. 在使用 while 循环时,insertLinkList是以第j个位置为判断对象,而 deleteLinkList是以第j+1个位置为判断对象的(其中:头结点为第1个位置)。

字体下载

推荐使用 JetBrainsMono Nerd Font

网站

Nerd Fonts

单独字体

  • JetBrainsMono Nerd Font 下载方式(3选1):

  • Hack Nerd Font Github

  • Caskaydia Cove Nerd Font Github

  • MesloLGS NF Github(官网)

    1
    2
    3
    4
    5
    mkdir fonts
    curl -o ./fonts/MesloLGS\ NF\ Regular.ttf https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/MesloLGS%20NF%20Regular.ttf
    curl -o ./fonts/MesloLGS\ NF\ Bold.ttf https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/MesloLGS%20NF%20Bold.ttf
    curl -o ./fonts/MesloLGS\ NF\ Italic.ttf https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/MesloLGS%20NF%20Italic.ttf
    curl -o ./fonts/MesloLGS\ NF\ Bold\ Italic.ttf https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/MesloLGS%20NF%20Bold%20Italic.ttf

Ubuntu安装win10字体

  1. 进入windows : /media/qeuro/系统/Windows/Fonts

  2. sudo cp *.ttf ~/桌面/WinFonts

  3. sudo cp *.TTF ~/桌面/WinFonts

  4. cd ~/桌面

  5. sudo mv WinFonts /usr/share/fonts/

  6. sudo chmod -R 755 /usr/share/fonts/WinFonts

  7. sudo mkfontscale && sudo mkfontdir && sudo fc-cache -fv

  8. 字体名称对照:

    ttf 字体
    arial.ttf Arial
    couri.ttf Courier New
    times.ttf Times New Roman
    timesbd.ttf Times New Roman Bole
    FZSTK.TTF 方正舒体
    FZYTK.TTF 方正姚体
    msyh.ttf 微软雅黑
    msyhbd.ttf 微软雅黑Bold
    simfang.ttf 仿宋GB_2312
    simhei.ttf 黑体
    simkai.ttf 楷体GB_2312
    SIMLI.TTF 隶书
    simsun.ttc 宋体、宋体PUA、新宋体
    SIMYOU.TTF 幼圆
    STCAIYUN.TTF 华文彩云
    STFANGSO.TTF 华文仿宋
    STHUPO.TTF 华文琥珀
    STKAITI.TTF 华文楷体
    STLITI.TTF 华文隶书
    STSONG.TTF 华文宋体
    STXIHEI.TTF 华文细黑
    STXINGKA.TTF 华文行楷
    STXINWEI.TTF 华文新魏
    STZHONGS.TTF 华文中宋
    SURSONG.TTF 宋体-方正超大字符集

  1. Cupertino:图标 —— icons

  2. dash-to-dock-gnome:dash to dock

  3. grub2-themes-master:grub启动界面 —— sudo ./install.sh -v

  4. High_Ubunterra_CC : Ubuntu 锁屏启动界面(模糊的那个)

  5. Mojave-light: 主题 —— themes

  6. suadesplas: 启动动画

  7. 美化网址有去除启动时紫框的说明是:https://www.cnblogs.com/feipeng8848/p/8970556.html

    即:找到/boot/grub/grub.cfg文件,找到这样一行: if background_color 44,0,30,0;修改成 if background_color 0,0,0,0;就会去除grub在选中Ubuntu系统之后出现的短暂的紫色。

  8. 美化网址:

    1. https://www.cnblogs.com/feipeng8848/p/8970556.html
    2. https://blog.csdn.net/weixin_40389121/article/details/81703577
    3. https://www.cnblogs.com/lishanlei/p/9090404.html

清理

  • sudo apt-get purge -y --auto-remove

  1. grub启动界面:直接使用 sudo ./install.sh -v,而不是sudo ./install.sh -v -2
  2. 安装微软字体库时,使用Tab健选择确定
  3. 搜狗输入法 如果调到第一门语言就会乱码(可能有的电脑没问题)
  4. 安装好anaconda后是没有图标的
  5. 安装anaocnda直接 bash anaconda.sh
  6. 安装anaconda之前应该先安装 Vscode

代码如下:

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
import numpy as np
import matplotlib
import matplotlib.pyplot as plt
import matplotlib.font_manager as fm
from mpl_toolkits.mplot3d import Axes3D

# 解决中文乱码问题
# myfont = fm.FontProperties(fname='/home/zk/study/python_lessions/DataVisualiztion/Library/Fonts/simsun.ttc', size=14
myfont = 'kaiti'
matplotlib.rcParams["axes.unicode_minus"] = False

def simple_plot():
"""
simple plot
:return:
"""
#生成画布
plt.figure(figsize=(8,6), dpi=80)

#打开交互模式
plt.ion()

# 循环
for index in range(100):
#清除原有图像
plt.cla()
#设定标题等
plt.title("动态曲线图",fontproperties=myfont)
plt.grid(True)

#生成测试数据
x = np.linspace(-np.pi + index, np.pi+0.1*index, 256,endpoint=True)

y_cos, y_sin = np.cos(x),np.sin(x)

# 设置x轴
plt.xlabel("x轴", fontproperties= myfont)
plt.xlim(-4 + 0.1*index,4 + 0.1*index)
plt.xticks(np.linspace(-4 + 0.1 * index, 4 + 0.1 * index, 9, endpoint=True))
# 设置Y轴
plt.ylabel("Y轴", fontproperties=myfont)
plt.ylim(-1.0, 1.0)
plt.yticks(np.linspace(-1, 1, 9, endpoint=True))

# 画两条曲线
plt.plot(x, y_cos, "b--", linewidth=2.0, label="cos示例")
plt.plot(x, y_sin, "g-", linewidth=2.0, label="sin示例")


# 设置图例位置,loc可以为[upper, lower, left, right, center]
plt.legend(loc="upper left", prop={'family': "kaiti"}, shadow=True)

# 暂停
plt.pause(0.1)

# 关闭交互模式
plt.ioff()

# 图形显示
plt.show()
return


if __name__ == '__main__':
simple_plot()

注意:

  1. 如果没有交互模式 那么就不能动态绘图
  2. plt.figure是可以自己显示画板的

全部命令

1
2
3
4
5
6
ubuntu-drivers devices
sudo apt install nvidia-440
sudo apt install nvidia-driver-440
reboot
lshw -numeric -C display
lspci -vnn | grep VGA

具体步骤

方法一

  1. 禁用显卡的方法这里在记一下:在/etc/modprobe.d/blacklist.conf里添加,如下内容,并执行 sudo update-initramfs -u,

    1
    2
    blacklist nouveau
    options nouveau modeset=0
  2. 重启后用lsmod | grep nouveau,如果没有任何输出说明禁用成功。

    但是我并没有禁用显卡

  3. 直接输入: sudo ubuntu-drivers autoinstall

  4. 验证是否安装成功:nvidia-smi

方法二 (推荐)

  1. 如果需要安装新版本的驱动可以先添加源:
    1
    2
    sudo add-apt-repository ppa:graphics-drivers/ppa
    sudo apt update
  2. 执行 ubuntu-drivers devices,如下所示:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    == /sys/devices/pci0000:00/0000:00:01.0/0000:01:00.0 ==
    modalias : pci:v000010DEd00001C8Csv00001028sd00000798bc03sc00i00
    vendor : NVIDIA Corporation
    model : GP107M [GeForce GTX 1050 Ti Mobile]
    driver : nvidia-driver-390 - third-party free
    driver : nvidia-driver-430 - distro non-free
    driver : nvidia-driver-415 - third-party free
    driver : nvidia-driver-435 - distro non-free
    driver : nvidia-driver-440 - third-party free recommended
    driver : nvidia-driver-410 - third-party free
    driver : xserver-xorg-video-nouveau - distro free builtin
  3. 选择 recommended (推荐的) 安装: sudo apt install nvidia-driver-440
  4. 可使用下面命令,查看是否安装成功
    1
    2
    lshw -numeric -C display
    lspci -vnn | grep VGA
    显示结果:
    1. lshw -numeric -C display
      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
      WARNING: you should run this program as super-user.
      *-display
      description: VGA compatible controller
      product: GP107M [GeForce GTX 1050 Ti Mobile] [10DE:1C8C]
      vendor: NVIDIA Corporation [10DE]
      physical id: 0
      bus info: pci@0000:01:00.0
      version: a1
      width: 64 bits
      clock: 33MHz
      capabilities: vga_controller bus_master cap_list rom
      configuration: driver=nvidia latency=0
      resources: irq:128 memory:de000000-deffffff memory:c0000000-cfffffff memory:d0000000-d1ffffff ioport:e000(size=128) memory:df000000-df07ffff
      *-display
      description: VGA compatible controller
      product: Intel Corporation [8086:591B]
      vendor: Intel Corporation [8086]
      physical id: 2
      bus info: pci@0000:00:02.0
      version: 04
      width: 64 bits
      clock: 33MHz
      capabilities: vga_controller bus_master cap_list rom
      configuration: driver=i915 latency=0
      resources: irq:127 memory:dd000000-ddffffff memory:b0000000-bfffffff ioport:f000(size=64) memory:c0000-dffff
      WARNING: output may be incomplete or inaccurate, you should run this program as super-user.
    2. lspci -vnn | grep VGA
      1
      2
      00:02.0 VGA compatible controller [0300]: Intel Corporation Device [8086:591b] (rev 04) (prog-if 00 [VGA controller])
      01:00.0 VGA compatible controller [0300]: NVIDIA Corporation GP107M [GeForce GTX 1050 Ti Mobile] [10de:1c8c] (rev a1) (prog-if 00 [VGA controller])

参考网址

win10

  1. 下载地址:https://www.oracle.com/java/technologies/javase-downloads.html

  2. 选择 Java SE 8 - Oracle JDK - JDK Download

  3. 双击打开jdk,如: jdk-8u202-windows-x64.exe

  4. 安装完JDK后配置环境变量。右击“计算机”。点击“属性”

  5. 点击“高级系统设置”

  6. 点击“高级”,再点击“环境变量”。

  7. 点击“新建”。变量名输入JAVA_HOME,变量值输入安装路径。D:\Java\jdk1.8.0_202\

  8. 点击“新建”。变量名输入 CLASSPATH ,变量值输入 .;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar

    注意前面有一个 . 千万不要忘了。

  9. 在系统变量中找到“Path”,点击“编辑”

    • (Error): 变量值输入%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin; (这个是不行的,javac 用不了)
    • (Success): D:\Java\jdk1.8.0_202\bin;D:\Java\jdk1.8.0_202\bin\jre\bin; (分不分开都可以,只要是绝对路径即可,并且在前在后应该无关,如果 javac 用不了,那么就把这两个移到最前端即可)

macOS

下载

Java Downloads | Oracle

安装JDK1.8

下载的安装包jdk-8u281-macosx-x64.dmg、双击pkg,按提示流程安装:

确定jdk安装完整

按照完成以后、我们可以查看JDK的安装路径、在资源库/Library下面会出现一个Java的文件夹、目录层级如下:/Library/Java/JavaVirtualMachines/jdk1.8.0_281.jdk

  1. 打开终端

  2. 如果想要配置 jdk,那么我们需要知道 jdk 的安装目录,与 WIN 系统有很大的不同,我们在 MAC 中想要查看 jdk 的安装路径需要在终端执行以下的命令行:

    1
    /usr/libexec/java_home -V

    如图所示:带有 ==Java SE 8== 和 ==jdk1.8.jdk== 的这一行信息是最重要的,可以将这段信息复制下来,后面需要使用!

  3. 查看 Java 版本:java -version

配置JDK的系统环境变量

在配置环境变量之前,我本人遇到一种情况就是:安装了jdk安装包之后,就可以直接在终端里面使用java -version 和java以及javac的命令。也就是说不需要配置jdk的环境变量也可以直接使用。后面我查了一些资料,我本人的理解是:在MAC系统中,jdk会默认安装到“用户”的目录下,当我们打开终端的时候会直接扫描用户,所以可以直接执行上面的三个命令。

但是无论是否可以直接使用java命令,我个人都建议配置jdk,具体的流程如下:

  1. vim ~/.zshrc 在末尾添加如下代码:

    1
    2
    3
    export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-1.8.jdk/Contents/Home
    export CLASSpATH=${JAVA_HOME}/lib
    export PATH=${JAVA_HOME}/bin:${PATH}

    注意:java_HOME=后面填入的信息就是“之前我们复制的那段重要信息”(即jdk的安装目录),其余的配置信息不变与我相同就可以。(一定要注意保存文件)

  2. source ~/.zshrc

  3. 在终端输入 echo $JAVA_HOME,如果配置成功则会显示刚刚配置的 JAVA_HOME 路径信息。(echo后面有空格),也可以直接使用 vim ~/.zshrc 来查看环境变量的信息。如图:

  4. 查看java版本:java -version

  5. javac的命令来检验是否配置成功

    Note:系统会输出 javac 的帮助信息。如果成功,说明已经成功配置了JDK , 否则需要仔细检查上面的步骤的配置是否正确。

jdk 文档

jdk8

点击 Java 文档页面的“Tree”按钮,页面会显示 Java 中所有的类供你查询

连接Github

  1. terminal 输入 ssh-keygen
  2. 进入 ~/.ssh
  3. id_rsa 是 私钥
  4. id_rsa.pub 是 公钥
  5. 将公钥复制到 Github
    1. 点击头像,选择 Setting
    2. 选择 SSH and GPG keys
    3. 选择 New SSH key
    4. Title可以自己写; Key 中复制你的公钥
    5. 选择 Add SSH key
    6. 下面就可以访问了

git简单使用

  1. 将git下载到本地 git clone <你的仓库地址>

  2. cd 进入 对应的文件夹

  3. git pull 更新你的仓库

  4. git status 以查看在你上次提交之后是否有修改

    1. 该命令加了 -s 参数,以获得简短的结果输出。如果没加该参数会详细输出内容。
  5. git add 将该文件添加到缓存

    1. git add * 将所有更改的文件,添加进暂存
    2. git add <文件名> 将对应的文件添加进暂存
  6. git commit -m "备注" 使用 git add 命令将想要快照的内容写入缓存区, 而执行 git commit 将缓存区内容添加到仓库中。

  7. git push 将本地库中的最新信息发送给远程库。

Notes

  1. 若已经有文件:

    1. 创建完git连接之后,先 git pull 一下。
  2. commitpush 的区别

    1. git作为支持分布式版本管理的工具,它管理的库(repository)分为本地库、远程库。

    2. git commit操作的是本地库,git push操作的是远程库。

    3. git commit是将本地修改过的文件提交到本地库中。

    4. git push是将本地库中的最新信息发送给远程库。

    5. 那有人就会问,为什么要分本地commit和服务器的push呢?

    因为如果本地不commit的话,修改的纪录可能会丢失。而有些修改当前是不需要同步至服务器的,所以什么时候同步过去由用户自己选择。什么时候需要同步再push到服务器

设置vimdiff

1
2
3
git config --global diff.tool nvimdiff
git config --global difftool.prompt false
git config --global alias.vd difftool

gitdiff 在打开每一个文件的 diff 时都会进行输入确认, 设置 difftool.prompt 可以禁用这一行为.
给 difftool 起个别名 vd

此后使用 git difftool 时 Git 便会调用 vimdiff 逐一打开每个文件的 Diff. 查看完成一个文件的 diff 后使用 :qa 关闭该文件 diff.
这时 Git 会自动打开下一个文件的 diff. 如果中止本次 Diff 呢?首先需要让 Git 信任 difftool 的返回码:

1
2
git config --global difftool.trustExitCode true
git config --global mergetool.trustExitCode true

然后让 vimdiff 返回 1::cq (:help cquit) 退出 Vim.

创建版本库

init

git init 命令把这个目录变成Git可以管理的仓库

也不一定必须在空目录下创建Git仓库,选择一个已经有东西的目录也是可以的。

status

运行git status命令查看仓库当前状态

git status命令可以让我们时刻掌握仓库当前的状态

add

命令git add告诉Git,把文件添加到仓库

commit

命令git commit告诉Git,把文件提交到仓库

-m后面输入的是本次提交的说明,可以输入任意内容,当然最好是有意义的,这样你就能从历史记录里方便地找到改动记录。

diff

git diff顾名思义就是查看difference,显示的格式正是Unix通用的diff格式,看具体修改了什么内容

时光穿梭机

版本回退

你不断对文件进行修改,然后不断提交修改到版本库里,就好比玩RPG游戏时,每通过一关就会自动把游戏状态存盘,如果某一关没过去,你还可以选择读取前一关的状态。有些时候,在打Boss之前,你会手动存盘,以便万一打Boss失败了,可以从最近的地方重新开始。Git也是一样,每当你觉得文件修改到一定程度的时候,就可以“保存一个快照”,这个快照在Git中被称为commit。一旦你把文件改乱了,或者误删了文件,还可以从最近的一个commit恢复,然后继续工作,而不是把几个月的工作成果全部丢失。

查看历史记录

在实际工作中,我们脑子里怎么可能记得一个几千行的文件每次都改了什么内容,不然要版本控制系统干什么。版本控制系统肯定有某个命令可以告诉我们历史记录,在Git中,我们用git log命令查看

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$ git log
commit 1094adb7b9b3807259d8cb349e7df1d4d6477073 (HEAD -> master)
Author: Michael Liao <askxuefeng@gmail.com>
Date: Fri May 18 21:06:15 2018 +0800

append GPL

commit e475afc93c209a690c39c13a46716e8fa000c366
Author: Michael Liao <askxuefeng@gmail.com>
Date: Fri May 18 21:03:36 2018 +0800

add distributed

commit eaadf4e385e865d25c48e7ca9c8395c3f7dfaef0
Author: Michael Liao <askxuefeng@gmail.com>
Date: Fri May 18 20:59:18 2018 +0800

wrote a readme file

git log命令显示从最近到最远的提交日志,我们可以看到3次提交,最近的一次是append GPL,上一次是add distributed,最早的一次是wrote a readme file

如果嫌输出信息太多,看得眼花缭乱的,可以试试加上--pretty=oneline参数:

1
2
3
4
$ git log --pretty=oneline
1094adb7b9b3807259d8cb349e7df1d4d6477073 (HEAD -> master) append GPL
e475afc93c209a690c39c13a46716e8fa000c366 add distributed
eaadf4e385e865d25c48e7ca9c8395c3f7dfaef0 wrote a readme file

需要友情提示的是,你看到的一大串类似1094adb...的是commit id(版本号),和SVN不一样,Git的commit id不是1,2,3……递增的数字,而是一个SHA1计算出来的一个非常大的数字,用十六进制表示,而且你看到的commit id和我的肯定不一样,以你自己的为准。为什么commit id需要用这么一大串数字表示呢?因为Git是分布式的版本控制系统,后面我们还要研究多人在同一个版本库里工作,如果大家都用1,2,3……作为版本号,那肯定就冲突了。

每提交一个新版本,实际上Git就会把它们自动串成一条时间线。如果使用可视化工具查看Git历史,就可以更清楚地看到提交历史的时间线

版本回退

准备把readme.txt回退到上一个版本,也就是add distributed的那个版本

首先,Git必须知道当前版本是哪个版本,在Git中,用HEAD表示当前版本,也就是最新的提交1094adb...(注意我的提交ID和你的肯定不一样),上一个版本就是HEAD^,上上一个版本就是HEAD^^,当然往上100个版本写100个^比较容易数不过来,所以写成HEAD~100

现在,我们要把当前版本append GPL回退到上一个版本add distributed,就可以使用git reset命令:

1
2
$ git reset --hard HEAD^
HEAD is now at e475afc add distributed

--hard参数有啥意义?这个后面再讲,现在你先放心使用。

还可以继续回退到上一个版本wrote a readme file,不过且慢,让我们用git log再看看现在版本库的状态:

1
2
3
4
5
6
7
8
9
10
11
12
$ git log
commit e475afc93c209a690c39c13a46716e8fa000c366 (HEAD -> master)
Author: Michael Liao <askxuefeng@gmail.com>
Date: Fri May 18 21:03:36 2018 +0800

add distributed

commit eaadf4e385e865d25c48e7ca9c8395c3f7dfaef0
Author: Michael Liao <askxuefeng@gmail.com>
Date: Fri May 18 20:59:18 2018 +0800

wrote a readme file

最新的那个版本append GPL已经看不到了!好比你从21世纪坐时光穿梭机来到了19世纪,想再回去已经回不去了,肿么办?

办法其实还是有的,只要上面的命令行窗口还没有被关掉,你就可以顺着往上找啊找啊,找到那个append GPLcommit id1094adb...,于是就可以指定回到未来的某个版本:

1
2
$ git reset --hard 1094a
HEAD is now at 83b0afe append GPL

版本号没必要写全,前几位就可以了,Git会自动去找。当然也不能只写前一两位,因为Git可能会找到多个版本号,就无法确定是哪一个了。

再小心翼翼地看看readme.txt的内容:

1
2
3
$ cat readme.txt
Git is a distributed version control system.
Git is free software distributed under the GPL.

果然,我胡汉三又回来了。

Git的版本回退速度非常快,因为Git在内部有个指向当前版本的HEAD指针,当你回退版本的时候,Git仅仅是把HEAD从指向append GPL

1
2
3
4
5
6
7
8
9
┌────┐
│HEAD│
└────┘

└──▶ ○ append GPL

○ add distributed

○ wrote a readme file

改为指向add distributed

1
2
3
4
5
6
7
8
9
┌────┐
│HEAD│
└────┘

│ ○ append GPL
│ │
└──▶ ○ add distributed

○ wrote a readme file

然后顺便把工作区的文件更新了。所以你让HEAD指向哪个版本号,你就把当前版本定位在哪。

现在,你回退到了某个版本,关掉了电脑,第二天早上就后悔了,想恢复到新版本怎么办?找不到新版本的commit id怎么办?

在Git中,总是有后悔药可以吃的。当你用$ git reset --hard HEAD^回退到add distributed版本时,再想恢复到append GPL,就必须找到append GPL的commit id。Git提供了一个命令git reflog用来记录你的每一次命令:

1
2
3
4
5
$ git reflog
e475afc HEAD@{1}: reset: moving to HEAD^
1094adb (HEAD -> master) HEAD@{2}: commit: append GPL
e475afc HEAD@{3}: commit: add distributed
eaadf4e HEAD@{4}: commit (initial): wrote a readme file

终于舒了口气,从输出可知,append GPL的commit id是1094adb,现在,你又可以乘坐时光机回到未来了。

总结

  • HEAD指向的版本就是当前版本,因此,Git允许我们在版本的历史之间穿梭,使用命令git reset --hard commit_id
  • 穿梭前,用git log可以查看提交历史,以便确定要回退到哪个版本。
  • 要重返未来,用git reflog查看命令历史,以便确定要回到未来的哪个版本。

工作区与暂存区

工作区(Working Directory)

就是你在电脑里能看到的目录,比如我的learngit文件夹就是一个工作区:

版本库(Repository)

工作区有一个隐藏目录.git,这个不算工作区,而是Git的版本库。

Git的版本库里存了很多东西,其中最重要的就是称为stage(或者叫index)的暂存区,还有Git为我们自动创建的第一个分支master,以及指向master的一个指针叫HEAD

分支和HEAD的概念我们以后再讲。

前面讲了我们把文件往Git版本库里添加的时候,是分两步执行的:

第一步是用git add把文件添加进去,实际上就是把文件修改添加到暂存区;

第二步是用git commit提交更改,实际上就是把暂存区的所有内容提交到当前分支。

因为我们创建Git版本库时,Git自动为我们创建了唯一一个master分支,所以,现在,git commit就是往master分支上提交更改。

你可以简单理解为,需要提交的文件修改通通放到暂存区,然后,一次性提交暂存区的所有修改。

实例

现在,使用两次命令git add,把readme.txtLICENSE都添加后,用git status再查看一下:

1
2
3
4
5
6
7
$ git status
On branch master
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)

new file: LICENSE
modified: readme.txt

所以, git add命令实际上就是把要提交的所有修改放到暂存区(Stage),然后,执行git commit就可以一次性把暂存区的所有修改提交到分支。

一旦提交后,如果你又没有对工作区做任何修改,那么工作区就是“干净”的:

1
2
3
$ git status
On branch master
nothing to commit, working tree clean

现在版本库变成了这样,暂存区就没有任何内容了:

管理修改

什么是修改?比如你新增了一行,这就是一个修改,删除了一行,也是一个修改,更改了某些字符,也是一个修改,删了一些又加了一些,也是一个修改,甚至创建一个新文件,也算一个修改。

现有操作过程:

第一次修改 -> git add -> 第二次修改 -> git commit

Git管理的是修改,当你用git add命令后,在工作区的第一次修改被放入暂存区,准备提交,但是,在工作区的第二次修改并没有放入暂存区,所以,git commit只负责把暂存区的修改提交了,也就是第一次的修改被提交了,第二次的修改不会被提交。

git diff HEAD -- readme.txt命令可以查看工作区和版本库里面最新版本的区别

你可以继续git addgit commit,也可以别着急提交第一次修改,先git add第二次修改,再git commit,就相当于把两次修改合并后一块提交了:

第一次修改 -> git add -> 第二次修改 -> git add -> git commit

撤销修改

add前撤销

在准备提交前,发现了错误。既然错误发现得很及时,就可以很容易地纠正它。你可以删掉最后一行,手动把文件恢复到上一个版本的状态。如果用git status查看一下:

1
2
3
4
5
6
7
8
9
$ git status
On branch master
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)

modified: readme.txt

no changes added to commit (use "git add" and/or "git commit -a")

你可以发现,Git会告诉你,git checkout -- file可以丢弃工作区的修改:

1
$ git checkout -- readme.txt

命令git checkout -- readme.txt意思就是,把readme.txt文件在工作区的修改全部撤销,这里有两种情况:

一种是readme.txt自修改后还没有被放到暂存区,现在,撤销修改就回到和版本库一模一样的状态;

一种是readme.txt已经添加到暂存区后,又作了修改,现在,撤销修改就回到添加到暂存区后的状态。

总之,就是让这个文件回到最近一次git commitgit add时的状态。

git checkout -- file命令中的--很重要,没有--,就变成了“切换到另一个分支”的命令,我们在后面的分支管理中会再次遇到git checkout命令。

add后撤销

将文件git add到暂存区了

庆幸的是,在commit之前,你发现了这个问题。用git status查看一下,修改只是添加到了暂存区,还没有提交:

1
2
3
4
5
6
$ git status
On branch master
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)

modified: readme.txt

Git同样告诉我们,用命令git reset HEAD <file>可以把暂存区的修改撤销掉(unstage),重新放回工作区:

1
2
3
$ git reset HEAD readme.txt
Unstaged changes after reset:
M readme.txt

git reset命令既可以回退版本,也可以把暂存区的修改回退到工作区。当我们用HEAD时,表示最新的版本。

再用git status查看一下,现在暂存区是干净的,工作区有修改:

1
2
3
4
5
6
7
$ git status
On branch master
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)

modified: readme.txt

comit后撤销

假设你不但改错了东西,还从暂存区提交到了版本库,怎么办呢?还记得版本回退一节吗?可以回退到上一个版本。不过,这是有条件的,就是你还没有把自己的本地版本库推送到远程。还记得Git是分布式版本控制系统吗?我们后面会讲到远程版本库,一旦你把stupid boss提交推送到远程版本库,你就真的惨了……

小结

  • 场景1:当你改乱了工作区某个文件的内容,想直接丢弃工作区的修改时,用命令git checkout -- file
  • 场景2:当你不但改乱了工作区某个文件的内容,还添加到了暂存区时,想丢弃修改,分两步,第一步用命令git reset HEAD <file>,就回到了场景1,第二步按场景1操作。
  • 场景3:已经提交了不合适的修改到版本库时,想要撤销本次提交,参考版本回退一节,不过前提是没有推送到远程库。

删除文件

case1: 删除文件

确实要从版本库中删除该文件,那就用命令git rm删掉,并且git commit

1
2
3
4
5
6
7
$ git rm test.txt
rm 'test.txt'

$ git commit -m "remove test.txt"
[master d46f35e] remove test.txt
1 file changed, 1 deletion(-)
delete mode 100644 test.txt

case2: 误删文件

另一种情况是删错了,因为版本库里还有呢,所以可以很轻松地把误删的文件恢复到最新版本

1
$ git checkout -- test.txt

git checkout其实是用版本库里的版本替换工作区的版本,无论工作区是修改还是删除,都可以“一键还原”。

远程仓库

添加远程仓库

创建GitHub仓库

create a new repo

连接仓库

1
$ git remote add origin git@github.com:<github账户名>/<仓库名>.git

添加后,远程库的名字就是origin,这是Git默认的叫法,也可以改成别的,但是origin这个名字一看就知道是远程库。

关联一个远程库时必须给远程库指定一个名字,origin是默认习惯命名。

推送内容

就可以把本地库的所有内容推送到远程库上

1
2
3
4
5
6
7
8
9
10
$ git push -u origin master
Counting objects: 20, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (15/15), done.
Writing objects: 100% (20/20), 1.64 KiB | 560.00 KiB/s, done.
Total 20 (delta 5), reused 0 (delta 0)
remote: Resolving deltas: 100% (5/5), done.
To github.com:michaelliao/learngit.git
* [new branch] master -> master
Branch 'master' set up to track remote branch 'master' from 'origin'.

把本地库的内容推送到远程,用git push命令,实际上是把当前分支master推送到远程。

由于远程库是空的,我们第一次推送master分支时,加上了-u参数,Git不但会把本地的master分支内容推送的远程新的master分支,还会把本地的master分支和远程的master分支关联起来,在以后的推送或者拉取时就可以简化命令。

推送成功后,可以立刻在GitHub页面中看到远程库的内容已经和本地一模一样

从现在起,只要本地作了提交,就可以通过命令:

1
$ git push origin master

把本地master分支的最新修改推送至GitHub,现在,你就拥有了真正的分布式版本库!

删除远程库

如果添加的时候地址写错了,或者就是想删除远程库,可以用git remote rm <name>命令。使用前,建议先用git remote -v查看远程库信息:

1
2
3
$ git remote -v
origin git@github.com:michaelliao/learn-git.git (fetch)
origin git@github.com:michaelliao/learn-git.git (push)

然后,根据名字删除,比如删除origin

1
$ git remote rm origin

此处的“删除”其实是解除了本地和远程的绑定关系,并不是物理上删除了远程库。远程库本身并没有任何改动。要真正删除远程库,需要登录到GitHub,在后台页面找到删除按钮再删除。

分支管理

分支就是科幻电影里面的平行宇宙,当你正在电脑前努力学习Git的时候,另一个你正在另一个平行宇宙里努力学习SVN。

如果两个平行宇宙互不干扰,那对现在的你也没啥影响。不过,在某个时间点,两个平行宇宙合并了,结果,你既学会了Git又学会了SVN!

创建与合并分支

形象化描述

版本回退里,你已经知道,每次提交,Git都把它们串成一条时间线,这条时间线就是一个分支。截止到目前,只有一条时间线,在Git里,这个分支叫主分支,即master分支。HEAD严格来说不是指向提交,而是指向mastermaster才是指向提交的,所以,HEAD指向的就是当前分支。

一开始的时候,master分支是一条线,Git用master指向最新的提交,再用HEAD指向master,就能确定当前分支,以及当前分支的提交点:

1
2
3
4
5
6
7
8
9
10
11
                  HEAD



master



┌───┐ ┌───┐ ┌───┐
│ │───▶│ │───▶│ │
└───┘ └───┘ └───┘

每次提交,master分支都会向前移动一步,这样,随着你不断提交,master分支的线也越来越长。

当我们创建新的分支,例如dev时,Git新建了一个指针叫dev,指向master相同的提交,再把HEAD指向dev,就表示当前分支在dev上:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
                 master



┌───┐ ┌───┐ ┌───┐
│ │───▶│ │───▶│ │
└───┘ └───┘ └───┘



dev



HEAD

你看,Git创建一个分支很快,因为除了增加一个dev指针,改改HEAD的指向,工作区的文件都没有任何变化!

不过,从现在开始,对工作区的修改和提交就是针对dev分支了,比如新提交一次后,dev指针往前移动一步,而master指针不变:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
                 master



┌───┐ ┌───┐ ┌───┐ ┌───┐
│ │───▶│ │───▶│ │───▶│ │
└───┘ └───┘ └───┘ └───┘



dev



HEAD

假如我们在dev上的工作完成了,就可以把dev合并到master上。Git怎么合并呢?最简单的方法,就是直接把master指向dev的当前提交,就完成了合并:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
                           HEAD



master



┌───┐ ┌───┐ ┌───┐ ┌───┐
│ │───▶│ │───▶│ │───▶│ │
└───┘ └───┘ └───┘ └───┘



dev

所以Git合并分支也很快!就改改指针,工作区内容也不变!

合并完分支后,甚至可以删除dev分支。删除dev分支就是把dev指针给删掉,删掉后,我们就剩下了一条master分支:

1
2
3
4
5
6
7
8
9
10
11
                           HEAD



master



┌───┐ ┌───┐ ┌───┐ ┌───┐
│ │───▶│ │───▶│ │───▶│ │
└───┘ └───┘ └───┘ └───┘

实战

创建并切换到dev分支

创建dev分支,然后切换到dev分支:

1
2
$ git checkout -b dev
Switched to a new branch 'dev'

git checkout命令加上-b参数表示创建并切换,相当于以下两条命令:

1
2
3
$ git branch dev
$ git checkout dev
Switched to branch 'dev'

然后,用git branch命令查看当前分支:

1
2
3
$ git branch
* dev
master

git branch命令会列出所有分支,当前分支前面会标一个*号。

然后,我们就可以在dev分支上正常提交,比如对readme.txt做个修改,加上一行:

1
Creating a new branch is quick.

然后提交:

1
2
3
4
$ git add readme.txt 
$ git commit -m "branch test"
[dev b17d20e] branch test
1 file changed, 1 insertion(+)

现在,dev分支的工作完成,我们就可以切换回master分支:

1
2
$ git checkout master
Switched to branch 'master'

切换回master分支后,再查看一个readme.txt文件,刚才添加的内容不见了!因为那个提交是在dev分支上,而master分支此刻的提交点并没有变:

现在,我们把dev分支的工作成果合并到master分支上:

1
2
3
4
5
$ git merge dev
Updating d46f35e..b17d20e
Fast-forward
readme.txt | 1 +
1 file changed, 1 insertion(+)

git merge命令用于合并指定分支到当前分支。合并后,再查看readme.txt的内容,就可以看到,和dev分支的最新提交是完全一样的。

注意到上面的Fast-forward信息,Git告诉我们,这次合并是“快进模式”,也就是直接把master指向dev的当前提交,所以合并速度非常快。

当然,也不是每次合并都能Fast-forward,我们后面会讲其他方式的合并。

合并完成后,就可以放心地删除dev分支了:

1
2
$ git branch -d dev
Deleted branch dev (was b17d20e).

删除后,查看branch,就只剩下master分支了:

1
2
$ git branch
* master

因为创建、合并和删除分支非常快,所以Git鼓励你使用分支完成某个任务,合并后再删掉分支,这和直接在master分支上工作效果是一样的,但过程更安全。

switch

我们注意到切换分支使用git checkout <branch>,而前面讲过的撤销修改则是git checkout -- <file>,同一个命令,有两种作用,确实有点令人迷惑。

实际上,切换分支这个动作,用switch更科学。因此,最新版本的Git提供了新的git switch命令来切换分支:

创建并切换到新的dev分支,可以使用:

1
$ git switch -c dev

直接切换到已有的master分支,可以使用:

1
$ git switch master

使用新的git switch命令,比git checkout要更容易理解。

小结

  • 查看分支:git branch
  • 创建分支:git branch <name>
  • 切换分支:git checkout <name>或者git switch <name>
  • 创建+切换分支:git checkout -b <name>或者git switch -c <name>
  • 合并某分支到当前分支:git merge <name>
  • 删除分支:git branch -d <name>

解决冲突

准备新的feature1分支,继续我们的新分支开发:

1
2
$ git switch -c feature1
Switched to a new branch 'feature1'

修改readme.txt最后一行,改为:

1
Creating a new branch is quick AND simple.

feature1分支上提交:

1
2
3
4
5
$ git add readme.txt

$ git commit -m "AND simple"
[feature1 14096d0] AND simple
1 file changed, 1 insertion(+), 1 deletion(-)

切换到master分支:

1
2
3
4
$ git switch master
Switched to branch 'master'
Your branch is ahead of 'origin/master' by 1 commit.
(use "git push" to publish your local commits)

Git还会自动提示我们当前master分支比远程的master分支要超前1个提交。

master分支上把readme.txt文件的最后一行改为:

1
Creating a new branch is quick & simple.

提交:

1
2
3
4
$ git add readme.txt 
$ git commit -m "& simple"
[master 5dc6824] & simple
1 file changed, 1 insertion(+), 1 deletion(-)

现在,master分支和feature1分支各自都分别有新的提交,变成了这样:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
                            HEAD



master



┌───┐
┌─▶│ │
┌───┐ ┌───┐ ┌───┐ │ └───┘
│ │───▶│ │───▶│ │──┤
└───┘ └───┘ └───┘ │ ┌───┐
└─▶│ │
└───┘



feature1

这种情况下,Git无法执行“快速合并”,只能试图把各自的修改合并起来,但这种合并就可能会有冲突,我们试试看:

1
2
3
4
$ git merge feature1
Auto-merging readme.txt
CONFLICT (content): Merge conflict in readme.txt
Automatic merge failed; fix conflicts and then commit the result.

果然冲突了!Git告诉我们,readme.txt文件存在冲突,必须手动解决冲突后再提交。git status也可以告诉我们冲突的文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
$ git status
On branch master
Your branch is ahead of 'origin/master' by 2 commits.
(use "git push" to publish your local commits)

You have unmerged paths.
(fix conflicts and run "git commit")
(use "git merge --abort" to abort the merge)

Unmerged paths:
(use "git add <file>..." to mark resolution)

both modified: readme.txt

no changes added to commit (use "git add" and/or "git commit -a")

我们可以直接查看readme.txt的内容:

1
2
3
4
5
6
7
8
9
Git is a distributed version control system.
Git is free software distributed under the GPL.
Git has a mutable index called stage.
Git tracks changes of files.
<<<<<<< HEAD
Creating a new branch is quick & simple.
=======
Creating a new branch is quick AND simple.
>>>>>>> feature1

Git用<<<<<<<=======>>>>>>>标记出不同分支的内容,我们修改如下后保存:

1
Creating a new branch is quick and simple.

再提交:

1
2
3
$ git add readme.txt 
$ git commit -m "conflict fixed"
[master cf810e4] conflict fixed

现在,master分支和feature1分支变成了下图所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
                                     HEAD



master



┌───┐ ┌───┐
┌─▶│ │───▶│ │
┌───┐ ┌───┐ ┌───┐ │ └───┘ └───┘
│ │───▶│ │───▶│ │──┤ ▲
└───┘ └───┘ └───┘ │ ┌───┐ │
└─▶│ │──────┘
└───┘



feature1

用带参数的git log也可以看到分支的合并情况:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
$ git log --graph --pretty=oneline --abbrev-commit
* cf810e4 (HEAD -> master) conflict fixed
|\
| * 14096d0 (feature1) AND simple
* | 5dc6824 & simple
|/
* b17d20e branch test
* d46f35e (origin/master) remove test.txt
* b84166e add test.txt
* 519219b git tracks changes
* e43a48b understand how stage works
* 1094adb append GPL
* e475afc add distributed
* eaadf4e wrote a readme file

最后,删除feature1分支:

1
2
$ git branch -d feature1
Deleted branch feature1 (was 14096d0).

小结

当Git无法自动合并分支时,就必须首先解决冲突。解决冲突后,再提交,合并完成。

解决冲突就是把Git合并失败的文件手动编辑为我们希望的内容,再提交。

git log --graph 命令可以看到分支合并图。

分支管理策略

通常,合并分支时,如果可能,Git会用Fast forward模式,但这种模式下,删除分支后,会丢掉分支信息。

如果要强制禁用Fast forward模式,Git就会在merge时生成一个新的commit,这样,从分支历史上就可以看出分支信息。

下面我们实战一下--no-ff方式的git merge

首先,仍然创建并切换dev分支:

1
2
$ git switch -c dev
Switched to a new branch 'dev'

修改readme.txt文件,并提交一个新的commit:

1
2
3
4
$ git add readme.txt 
$ git commit -m "add merge"
[dev f52c633] add merge
1 file changed, 1 insertion(+)

现在,我们切换回master

1
2
$ git switch master
Switched to branch 'master'

准备合并dev分支,请注意--no-ff参数,表示禁用Fast forward

1
2
3
4
$ git merge --no-ff -m "merge with no-ff" dev
Merge made by the 'recursive' strategy.
readme.txt | 1 +
1 file changed, 1 insertion(+)

因为本次合并要创建一个新的commit,所以加上-m参数,把commit描述写进去。

合并后,我们用git log看看分支历史:

1
2
3
4
5
6
7
$ git log --graph --pretty=oneline --abbrev-commit
* e1e9c68 (HEAD -> master) merge with no-ff
|\
| * f52c633 (dev) add merge
|/
* cf810e4 conflict fixed
...

可以看到,不使用Fast forward模式,merge后就像这样:

分支策略

在实际开发中,我们应该按照几个基本原则进行分支管理:

首先,master分支应该是非常稳定的,也就是仅用来发布新版本,平时不能在上面干活;

那在哪干活呢?干活都在dev分支上,也就是说,dev分支是不稳定的,到某个时候,比如1.0版本发布时,再把dev分支合并到master上,在master分支发布1.0版本;

你和你的小伙伴们每个人都在dev分支上干活,每个人都有自己的分支,时不时地往dev分支上合并就可以了。

所以,团队合作的分支看起来就像这样:

小结

Git分支十分强大,在团队开发中应该充分应用。

合并分支时,加上--no-ff参数就可以用普通模式合并,合并后的历史有分支,能看出来曾经做过合并,而fast forward合并就看不出来曾经做过合并。

API的使用

获取最新Releases的版本号

代码

1
wget -qO- -t1 -T2 "https://api.github.com/repos/ryanoasis/nerd-fonts/releases/latest" | grep "tag_name" | head -n 1 | awk -F ":" '{print $2}' | sed 's/\"//g;s/,//g;s/ //g'

可以搭配 xargs 进行自定义命令

代码解释

  • 主字段

    https://api.github.com/repos/ryanoasis/nerd-fonts/releases/latest 这里用的是 GitHub 的官方 API,格式为 https://api.github.com/repos/{项目名}/releases/latest

    打开上述链接后,可见包含下述字段的内容:

    1
    2
    3
    4
    5
    6
    "html_url": "https://github.com/ryanoasis/nerd-fonts/releases/tag/v3.1.1",
    "id": 131468221,
    "node_id": "RE_kwDOAaTAks4H1gu9",
    "tag_name": "v3.1.1",
    "target_commitish": "master",
    "name": "v3.1.1",

    那么这里的tag_name就是我们所需要的东西啦

  • wget 参数

    1
    wget -qO- -t1 -T2`,在这里,我们使用了 4 个参数,分别是`q,O-,t1,T2
    • -q: q 就是 quiet 的意思了,没有该参数将会显示从请求到输出全过程的所有内容,这肯定不是我们想要的。
    • -O-: -O是指把文档写入文件中,而-O-是将内容写入标准输出,而不保存为文件。(注:这里是大写英文字母 O (Out),不是数字 0)
    • -t1,-T2: 前者是设定最大尝试链接次数为 1 次,后者是设定响应超时的秒数为 2 秒,两者可以防止失败后反复获取,导致后续脚本无法执行。
  • 筛选参数

    • grep "tag_name": grep 是 Linux 一个强大的文本搜索工具,在本代码中输出 tag_name 所在行,即输出"tag_name": "v3.1.1",
    • head -n 1: head -n用于显示输出的行数,考虑到某些项目可能存在多个不同版本的 tag_name,这里我们只要第一个。
    • awk -F ":" '{print $2}': awk 主要用于文本分析,在这里指定:为分隔符,将该行切分成多列,并输出第二列。于是我们得到了(空格)"v3.1.1",
    • sed 's/\"//g;s/,//g;s/ //g': 在这里 sed 用于数据查找替换,如sed 's/要被取代的字串/新的字串/g' ,因此本段命令可分为 3 个,以分号分隔。s/\"//g即将引号删除(反斜杠是为了防止引号被转义),以此类推,最终留下我们需要的内容:v3.1.1

忽略特殊文件

有些时候,你必须把某些文件放到Git工作目录中,但又不能提交它们,比如保存了数据库密码的配置文件啦,等等,每次git status都会显示Untracked files ...,有强迫症的童鞋心里肯定不爽。

好在Git考虑到了大家的感受,这个问题解决起来也很简单,在Git工作区的根目录下创建一个特殊的.gitignore文件,然后把要忽略的文件名填进去,Git就会自动忽略这些文件。

[!NOTE]

.gitignore文件本身应该提交给Git管理,这样可以确保所有人在同一项目下都使用相同的.gitignore文件。

不需要从头写.gitignore文件,GitHub已经为我们准备了各种配置文件,只需要组合一下就可以使用了。所有配置文件可以直接在线浏览:GitHub/gitignore

忽略文件的原则是:

  1. 忽略操作系统自动生成的文件,比如缩略图等;
  2. 忽略编译生成的中间文件、可执行文件等,也就是如果一个文件是通过另一个文件自动生成的,那自动生成的文件就没必要放进版本库,比如Java编译产生的.class文件;
  3. 忽略你自己的带有敏感信息的配置文件,比如存放口令的配置文件。

举个例子:

假设你在Windows下进行Python开发,Windows会自动在有图片的目录下生成隐藏的缩略图文件,如果有自定义目录,目录下就会有Desktop.ini文件,因此你需要忽略Windows自动生成的垃圾文件:

1
2
3
4
# Windows:
Thumbs.db
ehthumbs.db
Desktop.ini

然后,继续忽略Python编译产生的.pyc.pyodist等文件或目录:

1
2
3
4
5
6
7
# Python:
*.py[cod]
*.so
*.egg
*.egg-info
dist
build

加上你自己定义的文件,最终得到一个完整的.gitignore文件,内容如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Windows:
Thumbs.db
ehthumbs.db
Desktop.ini

# Python:
*.py[cod]
*.so
*.egg
*.egg-info
dist
build

# My configurations:
db.ini
deploy_key_rsa

最后一步就是把.gitignore也提交到Git,就完成了!当然检验.gitignore的标准是git status命令是不是说working directory clean

使用Windows的童鞋注意了,如果你在资源管理器里新建一个.gitignore文件,它会非常弱智地提示你必须输入文件名,但是在文本编辑器里“保存”或者“另存为”就可以把文件保存为.gitignore了。

有些时候,你想添加一个文件到Git,但发现添加不了,原因是这个文件被.gitignore忽略了:

1
2
3
4
$ git add App.class
The following paths are ignored by one of your .gitignore files:
App.class
Use -f if you really want to add them.

如果你确实想添加该文件,可以用-f强制添加到Git:

1
$ git add -f App.class

或者你发现,可能是.gitignore写得有问题,需要找出来到底哪个规则写错了,可以用git check-ignore命令检查:

1
2
$ git check-ignore -v App.class
.gitignore:3:*.class App.class

Git会告诉我们,.gitignore的第3行规则忽略了该文件,于是我们就可以知道应该修订哪个规则。

还有些时候,当我们编写了规则排除了部分文件时:

1
2
3
4
# 排除所有.开头的隐藏文件:
.*
# 排除所有.class文件:
*.class

但是我们发现.*这个规则把.gitignore也排除了,并且App.class需要被添加到版本库,但是被*.class规则排除了。

虽然可以用git add -f强制添加进去,但有强迫症的童鞋还是希望不要破坏.gitignore规则,这个时候,可以添加两条例外规则:

1
2
3
4
5
6
7
8
# 排除所有.开头的隐藏文件:
.*
# 排除所有.class文件:
*.class

# 不排除.gitignore和App.class:
!.gitignore
!App.class

把指定文件排除在.gitignore规则外的写法就是!+文件名,所以,只需把例外文件添加进去即可。

可以通过GitIgnore Online Generator在线生成.gitignore文件并直接下载。

最后一个问题:.gitignore文件放哪?答案是放Git仓库根目录下,但其实一个Git仓库也可以有多个.gitignore文件,.gitignore文件放在哪个目录下,就对哪个目录(包括子目录)起作用。

1
2
3
4
5
6
7
myproject          <- Git仓库根目录
├── .gitigore <- 针对整个仓库生效的.gitignore
├── LICENSE
├── README.md
├── docs
│ └── .gitigore <- 仅针对docs目录生效的.gitignore
└── source

配置多个 SSH Key

背景

同时使用两个 GitHub 帐号,需要为两个帐号配置不同的 SSH Key:

  • 帐号 A 用于公司;
  • 帐号 B 用于个人。

创建ssh-key

生成帐号 A 的 SSH Key,并在帐号 A 的 GitHub 设置页面添加 SSH 公钥:

1
ssh-keygen -t ed25519 -C "GitHub User A" -f ~/.ssh/github_user_a_ed25519

生成帐号 B 的 SSH-Key,并在帐号 B 的 GitHub 设置页面添加 SSH 公钥:

1
ssh-keygen -t ed25519 -C "GitHub User B" -f ~/.ssh/github_user_b_ed25519

配置ssh代理

创建好了上面的多个ssh key就可以开始管理他们了。 在终端中输入如下命令,查询系统ssh key的代理:

1
$ ssh-add -l

如果系统已经设置了代理,需要删除:

1
2
$ ssh-add -D
All identities removed.

如果提示:

1
Could not open a connection to your authentication agent.

执行:

1
$ exec ssh-agent bash

接下来添加刚才创建的ssh key的私钥:

1
2
3
4
5
6
7
8
9
# 第一个
$ ssh-add ~/.ssh/github_user_a_ed25519
Enter passphrase for /Users/XXX/.ssh/github_user_a_ed25519:
Identity added: /Users/XXX/.ssh/github_user_a_ed25519 (/Users/XXX/.ssh/github_user_a_ed25519)

# 第二个
$ ssh-add ~/.ssh/github_user_b_ed25519
Enter passphrase for /Users/XXX/.ssh/github_user_b_ed25519:
Identity added: /Users/XXX/.ssh/github_user_b_ed25519 (/Users/XXX/.ssh/github_user_b_ed25519)

添加公钥

其实就是将对应的.pub中的内容,复制到对应平台的ssh key管理栏目中,不同的平台,位置不同,可以去对应的个人中心的设置中查看,很容易找到。

配置config

创建或者修改文件 ~/.ssh/config,添加如下内容:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Host gt_a
User git
Hostname github.com
Port 22
IdentityFile ~/.ssh/github_user_a_ed25519
PreferredAuthentications publickey
IdentitiesOnly yes

Host gt_b
User git
Hostname github.com
Port 22
IdentityFile ~/.ssh/github_user_b_ed25519
PreferredAuthentications publickey
IdentitiesOnly yes

验证ssh-key

用 ssh 命令分别测试两个 SSH Key:

1
2
3
4
5
$ ssh -T gt_a
Hi Qeuroal! You've successfully authenticated, but GitHub does not provide shell access.

$ ssh -T gt_b
Hi Qeuroal! You've successfully authenticated, but GitHub does not provide shell access.

使用

拉取代码:

git@github.com 替换为 SSH 配置文件中对应的 Host,如原仓库 SSH 链接为:

1
git@github.com:owner/repo.git

使用帐号 A 推拉仓库时,需要将连接修改为:

1
gt_a:owner/repo.git

多个git账户的提交问题

我们大多数人都会使用第三方工具进行git提交,比如source tree之类的,这些工具在提交时,如果不对对应的git仓库进行专门的配置,会默认走git的全局配置,也就是会用默认的全局配置的账户进行git提交。一不小心,就会用我们私人的账户,进行了公司项目的git提交,生成了对应的提交记录,也有可能因为权限问题,导致直接提交失败。
这时,我们需要对不同的仓库,进行对应的配置。

  1. 检查全局配置

    在终端中,分别输入如下命令,可以检查目前电脑中的git的全局配置信息,如果没有返回,说明没有全局配置,如果有,就可以看到对应的默认的账户是那个了。

    1
    2
    $ git config --global user.name
    $ git config --global user.email

    为了避免麻烦,我们可以取消全局配置:

    1
    2
    $ git config --global --unset user.name
    $ git config --global --unset user.email
  2. 全局配置和局部配置

    此时已经取消了电脑中默认的git全局配置信息,此时进行git提交,会报对应的找不到账户信息的错误。
    我们可以cd到对应的git仓库的根目录下,执行局部git配置命令。比如 ~/github/DemoProject 是一个在github平台托管的本地git仓库的根目录,我们可以执行如下命令:

    1
    2
    3
    $ cd ~/github/DemoProject
    $ git config user.name
    $ git config user.email

    如果返回均为空,说明没有进行过局部配置,可以分别配置github的账户名和邮箱:

    1
    2
    $ git config user.name "github账户名"
    $ git config user.email "github@example.com"

    同理,在不同的git仓库下,可以分别配置不同平台的git账户名和git邮箱。这虽然看起来麻烦,不过,只要设置完成,之后只要不再更改对应的git仓库的路径,就不需要再更换配置了。
    而且,即便我们没有取消默认的全局git配置,在进行了局部配置后,后者的优先级会更高。 执行:

    1
    $ git config --list

    可以查看查看当前仓库的具体配置信息,在当前仓库目录下查看的配置是全局配置+当前项目的局部配置,使用的时候会优先使用当前仓库的局部配置,如果没有,才会去读取全局配置。

0%