VS Code 远程开发配置指南

本文介绍如何使用 VS Code 的 Remote - SSH 扩展进行远程开发，让你能够在本地编辑远程服务器上的代码。

准备工作

1. 生成 SSH 密钥

ssh-keygen -t rsa

按提示操作，建议使用默认路径和空密码。

2. 复制公钥到远程服务器

ssh-copy-id -i ~/.ssh/id_rsa.pub root@192.168.1.1

输入远程服务器的密码，完成密钥配置。

配置 SSH 连接

1. 编辑 SSH 配置文件

vim ~/.ssh/config

2. 添加服务器配置

# 远程服务器配置
Host ali  # 自定义主机别名
  HostName 192.168.1.1  # 服务器 IP 地址
  User root  # 登录用户名
  IdentityFile ~/.ssh/id_rsa  # 私钥文件路径
  Port 22  # SSH 端口号

3. 测试连接

ssh ali

如果配置正确，应该可以直接登录，无需输入密码。

安装 VS Code 扩展

方法一：通过扩展市场安装

打开 VS Code
点击左侧扩展图标（或按 Ctrl+Shift+X）
搜索 “Remote - SSH”
点击安装

方法二：使用命令行安装

code --install-extension ms-vscode-remote.remote-ssh

方法三：通过界面安装

点击 VS Code 左下角的远程连接图标（形如 “><” 的图标），按照提示安装 Remote - SSH 扩展。

连接远程服务器

1. 打开远程资源管理器

点击左侧活动栏的远程资源管理器图标
或者按 F1 打开命令面板，输入 “Remote-SSH: Connect to Host”

2. 选择主机

从列表中选择配置好的主机（如 “ali”）

3. 选择打开方式

在当前窗口打开：关闭当前窗口，打开远程连接
在新窗口打开：保留当前窗口，新建窗口连接远程

远程开发功能

1. 文件管理

浏览远程服务器的文件系统
直接在远程服务器上创建、编辑、删除文件
支持拖放操作

2. 终端访问

集成终端直接连接到远程服务器
支持多个终端会话
完整的 shell 功能

3. 扩展安装

部分扩展可以在远程服务器上运行
扩展会根据连接环境自动调整
支持扩展的远程开发模式

4. 调试功能

在远程服务器上调试代码
支持多种编程语言的调试器
断点、变量查看等完整功能

高级配置

1. 多服务器配置

# ~/.ssh/config
Host server1
  HostName 192.168.1.100
  User developer
  IdentityFile ~/.ssh/id_rsa

Host server2
  HostName 192.168.1.101
  User admin
  IdentityFile ~/.ssh/id_rsa_2
  Port 2222

2. 跳板机配置

Host jump-server
  HostName 10.0.0.1
  User jumpuser

Host target-server
  HostName 192.168.100.100
  User targetuser
  ProxyJump jump-server

3. VS Code 设置同步

{
  "remote.SSH.configFile": "~/.ssh/config",
  "remote.SSH.defaultExtensions": [
    "ms-python.python",
    "ms-vscode.cpptools"
  ]
}

常见问题

问题 1：连接超时

# 检查网络连接
ping 192.168.1.1

# 检查 SSH 服务状态
ssh -v root@192.168.1.1

问题 2：权限被拒绝

# 检查密钥文件权限
chmod 600 ~/.ssh/id_rsa
chmod 644 ~/.ssh/id_rsa.pub

# 检查远程服务器 authorized_keys 权限
ssh root@192.168.1.1 "chmod 600 ~/.ssh/authorized_keys"

问题 3：扩展无法安装

确保有网络连接
检查 VS Code 版本是否支持
尝试重新安装扩展

性能优化

1. 连接参数优化

Host optimized-server
  HostName example.com
  User user
  Compression yes
  ServerAliveInterval 60
  ServerAliveCountMax 3

2. 文件同步设置

{
  "remote.SSH.useLocalServer": true,
  "remote.SSH.enableDynamicForwarding": true
}

3. 资源限制

对于资源有限的服务器，可以调整：

{
  "remote.SSH.maxReconnectionAttempts": 5,
  "remote.SSH.connectTimeout": 30
}

安全建议

1. 使用非 root 用户

# 创建专用开发用户
adduser developer
usermod -aG sudo developer

2. 密钥管理

定期更换 SSH 密钥
使用密码保护私钥
限制密钥的使用范围

3. 防火墙配置

# 只允许特定 IP 访问 SSH
sudo ufw allow from 192.168.1.0/24 to any port 22

替代方案

1. VS Code Remote - Containers

在 Docker 容器中开发，确保环境一致性。

2. VS Code Remote - WSL

在 Windows Subsystem for Linux 中开发。

3. 其他远程开发工具

JetBrains Gateway: JetBrains IDE 的远程开发方案
Eclipse Theia: 基于 Web 的 IDE，支持远程开发
code-server: 将 VS Code 作为 Web 服务运行

VS Code 远程开发功能极大地简化了远程开发的工作流程，让开发者可以在熟悉的编辑环境中处理远程项目，提高开发效率。

Keyboard shortcuts

TOPAZ LEAF