VS Code 远程开发插件使用：开启便捷开发新体验

01-18 3261阅读

一、引言

在软件开发过程中，我们常常会遇到需要在不同环境下进行开发的情况。例如，在本地环境开发完成后，需要将代码部署到远程服务器进行测试和生产。VS Code 远程开发插件为我们提供了一种便捷的方式，让我们可以在本地的 VS Code 编辑器中直接连接到远程服务器，进行代码编辑、调试等操作，无需在本地和远程环境之间频繁切换。本文将详细介绍 VS Code 远程开发插件的使用方法，帮助读者开启便捷开发新体验。

二、安装远程开发插件

首先，打开 VS Code 编辑器，在左侧的扩展栏中搜索“Remote Development”。找到并安装“Remote - SSH”、“Remote - Containers”等相关插件。这些插件将为我们提供连接远程服务器和容器的功能。

三、连接远程服务器

配置 SSH 连接

安装完“Remote - SSH”插件后，点击状态栏中的 SSH 图标（或使用快捷键 Ctrl + Shift + P，输入“Remote - SSH: Connect to Host”），选择“Configure SSH Hosts”。这将打开一个名为“config”的文件，用于配置 SSH 连接。

在“config”文件中，添加远程服务器的连接信息，例如：

Host myserver
    HostName 192.168.1.100
    User username
    IdentityFile ~/.ssh/id_rsa

这里的“HostName”是远程服务器的 IP 地址或域名，“User”是登录远程服务器的用户名，“IdentityFile”是 SSH 密钥文件的路径。

连接远程服务器

配置好 SSH 连接后，再次点击状态栏中的 SSH 图标，选择刚才配置的远程服务器（如“myserver”）。VS Code 将尝试连接到远程服务器，并在底部的状态栏显示连接状态。连接成功后，我们就可以在本地的 VS Code 编辑器中访问远程服务器的文件系统，并进行代码编辑了。

四、在远程服务器上开发

打开远程文件夹

连接到远程服务器后，点击 VS Code 编辑器中的“File” -> “Open Folder”，在弹出的文件选择框中，选择远程服务器上的项目文件夹路径。VS Code 将自动加载该文件夹下的所有文件，并在编辑器中显示。

安装扩展

我们可以像在本地开发一样，在远程服务器上安装所需的扩展。在 VS Code 编辑器中，点击左侧的扩展栏，搜索并安装需要的扩展。安装完成后，这些扩展将在远程服务器上生效。

代码编辑与调试

在远程服务器上打开项目文件夹后，我们就可以像在本地一样进行代码编辑了。VS Code 提供了丰富的代码编辑功能，如语法高亮、智能感知、代码导航等。

如果需要在远程服务器上进行调试，我们可以在本地的 VS Code 编辑器中配置调试环境。例如，对于 Python 项目，我们可以在项目根目录下创建一个“launch.json”文件，配置调试参数：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Remote Debug",
            "type": "python",
            "request": "attach",
            "connect": {
                "host": "192.168.1.100",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}",
                    "remoteRoot": "/path/to/remote/project"
                }
            ]
        }
    ]
}

这里的“host”是远程服务器的 IP 地址，“port”是调试端口，“pathMappings”用于映射本地和远程的项目路径。配置好调试参数后，在远程服务器上启动调试服务器，并在本地的 VS Code 编辑器中点击调试按钮，即可开始调试。

五、使用 Remote - Containers 插件

创建容器

“Remote - Containers”插件允许我们在容器中进行开发。首先，在项目根目录下创建一个“Dockerfile”文件，定义容器的构建规则。例如：

FROM python:3.8
WORKDIR /app
COPY. /app
RUN pip install -r requirements.txt
CMD ["python", "app.py"]

这个“Dockerfile”文件定义了一个基于 Python 3.8 的容器，将当前项目目录复制到容器中，并安装项目所需的依赖，最后启动应用程序。

打开容器

创建好“Dockerfile”文件后，点击状态栏中的容器图标（或使用快捷键 Ctrl + Shift + P，输入“Remote - Containers: Open Folder in Container”），选择项目文件夹路径。VS Code 将根据“Dockerfile”文件构建容器，并在容器中打开项目。