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，选中对应的操作即可