VS Code 同步代碼到到服務器 -- sftp 插件

背景

在日常開發工作中，在遠程服務器上執行代碼的編譯、測試工作；在本地個人筆記本上進行代碼的編輯、修改工作。那麼，如何把筆記本上的代碼便捷的上傳到服務器就是需要解決的問題。
所幸，VS Code 中的 sftp 插件可以幫助我們便捷的完成這一工作。

安裝 sftp 插件

• 在 vs code 中使用 cmd + shift + x 命令打開插件管理器
• 在插件管理器的搜索欄中搜索 “sftp”
  
• 點擊 “install” 安裝即可

配置 sftp 插件

• 在 vs code 中使用 cmd + shift + p 命令打開命令輸入窗口
• 在命令輸入窗口中鍵入 sftp: config 打開 sftp 插件的配置文件
• 修改 sftp 插件的配置文件如下（註釋是我自己加的）

{
    "protocol": "sftp",  // 使用 sftp 協議
    "host": "10.8.118.139", // 服務器 ip
    "port": 22,  // 訪問端口號
    "username": "user_name",  // 用來登錄服務器的用戶名
    "remotePath": "abs path of remote file",  // 被同步文件在服務器上的絕對路徑
    "uploadOnSave": true,  // 在本地執行保存操作後，自動同步到服務器
    "passive": false,
    "debug": false,
    "privateKeyPath": "abs path of the ssh key",  // 本地保存的可以用來登錄服務器的 ssh key
    "watcher": {
        "files": "**/*",
        "autoUpload": false,
        "autoDelete": false
    },
    "ignore": [  // 設置不被同步的文件和路徑
        "\\.vscode",  // .vscode 路徑
        "\\.idea",
        "*.pyc",  // 拓展名爲 .pyc 的文件
        "\\output",
        "\\.git"
    ]
}

使用

• case 1: 正常情況下，文件在保存後會被自動同步到服務器
• case 2: 在 explore (文件瀏覽樹) 中右鍵要進行同步的文件或文件夾，選中對應的操作即可
  
• case 3: 通過 cmd + shift + p 命令打開命令輸入窗口，輸入 sftp，選中對應的操作即可