在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

技术文档

在现代开发中，远程开发已经成为一种常见的工作方式。借助 Visual Studio Code（VSCode）提供的 Remote Development 插件，您可以轻松地通过 SSH 连接到远程服务器，在远程环境中直接编辑和运行代码，而无需离开熟悉的编辑器环境。

本文将详细介绍如何在 VSCode 中配置远程开发环境，包括连接远程服务器、配置 SSH、选择远程 Python 解释器，以及在远程环境中进行调试。

前提条件

已安装最新版的 VSCode。
具有远程服务器的 SSH 访问权限。
在远程服务器上已设置好项目环境，包含 Python 虚拟环境等。

步骤概览

安装 Remote Development 插件。
配置 SSH 连接。
连接到远程服务器。
打开远程项目。
配置 Python 环境（可选）。
配置远程调试（可选）。

步骤 1：安装 Remote Development 插件

打开 VSCode。
安装插件：
- 点击左侧的插件图标（四个方块的图标）打开扩展市场。
- 在搜索栏中输入 Remote - SSH。
- 找到 Remote - SSH 插件并点击安装。该插件是 Remote Development 插件集的一部分。
- 可选： 您还可以安装以下插件以扩展功能：
  - Remote - SSH: Editing Configuration Files
  - Remote - SSH: Explorer

步骤 2：配置 SSH 连接

打开命令面板：
- 使用快捷键 Ctrl + Shift + P（Windows/Linux）或 Cmd + Shift + P（macOS）。
添加新的 SSH 主机：
- 在命令面板中输入 Remote-SSH: Add New SSH Host，然后回车。
- 输入 SSH 连接字符串，例如：
```
ssh username@101.132.142.17
```

在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

系统将提示您选择 SSH 配置文件的保存位置，通常为 ~/.ssh/config。

配置 SSH 配置文件（可选）：

您可以在 ~/.ssh/config 文件中添加以下配置，以简化后续连接：

Host my-remote-server HostName 101.132.142.17 User username Port 22 IdentityFile ~/.ssh/id_rsa # 如果使用密钥认证

在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

这样，您可以使用简短的主机名 my-remote-server 进行连接。

步骤 3：连接到远程服务器

打开命令面板：
- 使用快捷键 Ctrl + Shift + P 或 Cmd + Shift + P。
连接到主机：
- 输入 Remote-SSH: Connect to Host...，然后回车。
- 从列表中选择您配置的远程服务器（例如，username@101.132.142.17 或 my-remote-server）。
输入 SSH 密码或使用 SSH 密钥：
- 如果您使用密码认证，VSCode 会提示您输入密码。
- 如果使用密钥认证，请确保您的 SSH 密钥已正确配置。
连接成功：
- 连接成功后，VSCode 会在远程环境中重启，左下角会显示 SSH: 。

步骤 4：打开远程项目

浏览远程文件系统：
- 在 VSCode 的文件资源管理器中，您将看到远程服务器的文件系统。
- 导航到您的项目目录，例如：
```
/data/annotated-transformer-master
```
打开项目文件：
- 点击 Open Folder，选择项目目录。
- 您现在可以像在本地一样编辑远程服务器上的文件。
  
  再输入一次密码

步骤 5：配置 Python 环境（可选）

为了在远程环境中运行和调试 Python 代码，您可以选择远程虚拟环境中的 Python 解释器。

打开命令面板：
- 使用快捷键 Ctrl + Shift + P 或 Cmd + Shift + P。
选择 Python 解释器：
- 输入 Python: Select Interpreter，然后回车。
- 从列表中选择您的虚拟环境解释器，例如：
```
/data/annotated-transformer-master/venv/bin/python3
```

在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

步骤 6：配置远程调试（可选）

为了在 VSCode 中调试远程运行的代码，您需要进行以下配置。

1. 创建调试配置文件

创建 .vscode 目录：
- 在项目根目录下创建一个名为 .vscode 的文件夹（如果尚未存在）。
创建 launch.json 文件：
- 在 .vscode 目录下创建一个名为 launch.json 的文件。

添加调试配置：

{ \"version\": \"0.2.0\", \"configurations\": [ { \"name\": \"Python: Remote Attach\", \"type\": \"python\", \"request\": \"attach\", \"connect\": { \"host\": \"127.0.0.1\", // 或替换为您的服务器 IP \"port\": 5678 // 调试监听的端口 }, \"pathMappings\": [ {  \"localRoot\": \"${workspaceFolder}\", // 本地工作区路径  \"remoteRoot\": \"/data/annotated-transformer-master\" // 远程项目路径 } ], \"justMyCode\": true } ]}

在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

2. 在远程服务器上设置调试服务器

安装 debugpy 库：
- 在远程服务器上，激活您的虚拟环境，然后运行：
```
source /data/annotated-transformer-master/venv/bin/activatepip install debugpy
```
运行调试服务器：
- 使用 debugpy 模块启动您的 Python 脚本：
```
python -m debugpy --listen 0.0.0.0:5678 --wait-for-client the_annotated_transformer.py
```
  - 0.0.0.0:5678：调试服务器监听的地址和端口。
  - --wait-for-client：在客户端连接之前暂停执行。

3. 在 VSCode 中启动调试会话

启动调试：
- 在 VSCode 中，点击左侧的调试图标，进入调试面板。
- 在顶部的下拉菜单中选择 \"Python: Remote Attach\" 配置。
- 点击绿色的启动按钮。
开始调试：
- VSCode 将连接到远程调试服务器。
- 一旦连接成功，您的脚本将继续执行，您可以在 VSCode 中设置断点、查看变量等。

在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

注意事项

权限：确保您的用户在远程服务器上具有必要的读写权限。
网络连接：保证本地与远程服务器之间的网络连接稳定，必要时配置防火墙规则以允许调试端口的通信。
SSH 配置：使用 SSH 密钥认证可以提高安全性和连接效率。
防火墙设置：确保服务器的防火墙允许调试端口（如 5678）的访问。

结论

通过以上步骤，您可以在 VSCode 中高效地进行远程开发，直接编辑、运行和调试远程服务器上的代码。这种方式不仅提高了开发效率，还使您能够利用服务器的计算资源。

希望这篇文章能帮助您顺利配置和使用远程开发环境！如果您有任何问题或建议，欢迎在评论区留言。

在 VSCode 中配置远程开发环境查看和调试Python代码_vscode远程开发python

前提条件