概述
vscode 支持遠程開發,也就是源代碼在遠程服務器上,開發者在本地進行開發調試,遠程服務器可以是 linux,而本地可以使用 windows 環境,圖示如下

請注意:本地是沒有代碼的
這樣的方便性毋庸置疑
- 不會因為開發和生產環境不一致導致各種奇怪的問題,比如依賴庫找不到,路徑問題等等
- 使用多臺電腦開發時,不需要在各個電腦之間保持代碼的同步
更吸引人的是,搭建 vscode 的遠程開發環境是非常簡單的,就以下幾個步驟
- 配置遠程環境的登錄驗證,本文以 SSH 密鑰登錄為例介紹,最多執行 4 條命令即可完成配置
- vscode 安裝遠程登錄擴展
- 將 vscode 連接到遠程環境
- 為遠程環境安裝相應開發語言的擴展
- 和本地一樣進行開發調試
環境說明
- 本地環境:windows 10
- 遠程環境:運行在 VirtualBox 里的 Linux 虛擬機
- OS 版本:centos Linux release 8.2.2004 (Core)
- 用戶賬號:root
為了方便,編輯本地的 hosts 文件,為遠程服務器設置域名為 virtualbox
127.0.0.1 virtualbox
SSH 密鑰驗證
從 windows 遠程登錄到 Linux,一般都是采用 SSH,客戶端可以選用 putty,XShell 等工具。vscode 也支持 SSH 登錄到遠程服務器上,需先配置 SSH 密鑰登錄
注意:如果你的 windows 未安裝兼容 OpenSSH 的客戶端(putty 不兼容 OpenSSH),請先 安裝 OpenSSH(https://docs.microsoft.com/zh-cn/windows-server/administration/openssh/openssh_install_firstuse)
打開 windows 10 的 powershell(請勿使用 cmd,必須使用 powershell),執行如下命令,創建密鑰
ssh-keygen -t rsa -b 4096
注意:如果你以前用 ssh-keygen 創建過密鑰,那么這一步可以跳過。
如果不確定是否曾經創建過密鑰,可以輸入以下指令查看
ls $HOME/.ssh
如果目錄不存在則可以放心創建密鑰,如果列出了如下文件,則說明密鑰已經存在
id_rsa
id_rsa.pub
密鑰創建后,執行以下命令即可完成 SSH 密鑰登錄的配置
# 帳號@ip(或域名)
$USER_AT_HOST="root@virtualbox"
# 指定公鑰位置
$PUBKEYPATH="$HOME.sshid_rsa.pub"
$pubKey=(Get-Content "$PUBKEYPATH" | Out-String); ssh "$USER_AT_HOST" "mkdir -p ~/.ssh && chmod 700 ~/.ssh && echo '${pubKey}' >> ~/.ssh/authorized_keys && chmod 600 ~/.ssh/authorized_keys"
執行到第三條命令,會出現交互提示
The authenticity of host 'virtualbox (127.0.0.1)' can't be established.
ECDSA key fingerprint is SHA256:R7+lcN8z/RBrH0i3OMUvfZtEt4lxdbGQrEV/ydcq8Vc.
Are you sure you want to continue connecting (yes/no)?
輸入 yes 繼續,接下來會要求輸入登錄密碼
Warning: Permanently added 'virtualbox' (ECDSA) to the list of known hosts.
root@virtualbox's password:
輸入 root 用戶 在 virtualbox 服務器上的密碼完成設置
此時使用密鑰登錄已完成配置,輸入如下命令即可連接到遠程服務器
ssh root@virtualbox
可以看到命令提示符已經是遠程服務器的啦
Last login: Wed Dec 16 01:51:17 2020 from 10.0.2.2
[root@localhost ~]#
vscode 安裝遠程擴展
在 vscode 里搜索 remote-ssh,點擊安裝即可

使用 vscode 連接到遠程服務器
remote-ssh 擴展安裝完成后,可以看到 vscode 左邊欄增加了 Remote Explorer 按鈕,

狀態欄增加了 Open a Remote Window 按鈕

點擊 Open a Remote Window 按鈕,會打開命令面板,并顯示常用的 remote-ssh 命令,如圖

選擇 Remote-SSH: Connect to Host... 并輸入 root@virtualbox 來連接到遠程服務器

此時 vscode 會打開一個新窗口,連接遠程服務器,并且界面上方的命令面板會有遠程服務器的平臺選項,分別是
- Linux
- Windows
- macOS
選擇 Linux 即可,如果不選擇的話,vscode 在等待一段時間后會提示連接失敗,如下圖

如果看到這個連接失敗的界面,也不要慌,Retry 并在命令面板選擇 Linux 即可;連接成功后,可以看到狀態欄圖標上顯示的主機名

編寫程序
我們用 Python 寫個 hello world 吧
- 點擊 File 菜單,選擇 Open Folder...,打開 /data/python 目錄,如果目錄不存在請先創建
- 新建一個 test.py 的文件
- 輸入代碼
如圖

這時會發現找不到運行的按鈕,這是因為服務器上沒有安裝 python 擴展,我們打開擴展視圖

可以看到遠程服務器上沒有安裝任何擴展,點擊 Install in SSH: virtualbox 安裝 python 擴展到服務器上,安裝完成后,右下角會彈出對話框,要求選擇 python 解釋器

指定 python 安裝路徑后,還會彈出一些安裝 python 擴展的對話框,全部完成后,就可以運行 hello world 了

斷開遠程連接
如果要斷開遠程服務器,可以從 File 菜單選擇 Close Remote Connection,否則的話下次打開 vscode 會自動連接到遠程服務器

保存遠程服務器信息
也許有的同學需要在多個不同的遠程服務器上進行開發,可以通過遠程瀏覽器來管理這些服務器
點擊左邊欄的 Remote Explorer 按鈕,打開遠程瀏覽器,點擊 SSH TARGETS 視圖右側的加號,添加服務器

在彈出的對話框里輸入 root@virtualbox,并在隨后的對話框里指定配置文件,即可完成遠程服務器的保存,此時 SSH TARGETS 視圖會出現該服務器

可以很方便的通過該視圖連接到遠程服務器