注意点:VScode进行远程开发的步骤

好的,我来帮你把这些内容整合成一份逻辑清晰、适合新人阅读的完整指南。去掉重复内容,按"是什么→为什么→怎么做"的逻辑重新组织。


VSCode 远程开发完整指南(新人版)

第一部分:先搞懂原理(是什么 & 为什么)

Q1:远程开发机上有没有 VSCode?

答:没有完整的 VSCode 图形界面,但有一个叫 vscode-server 的后台服务。

原理是这样的:

复制代码
你的本地电脑(Windows/Mac)
└── VSCode 图形界面(你看到的窗口)
└── Remote-SSH 插件(负责通信)
          ↓ SSH 连接受
远程开发机(Linux服务器)
└── vscode-server(自动下载的后台服务)
    ├── 帮你打开/保存文件
    ├── 执行终端命令
    ├── 运行代码补全、跳转等功能
    └── 管理远程插件
└── 你的项目代码
└── 各种工具(git、docker、python等)

简单说:你本地电脑负责显示界面,远程机负责执行代码。所有操作感觉就像在本地一样流畅。

Q2:为什么能直接使用 git 和 docker?

答:因为这些工具直接安装在远程开发机上,你通过远程终端就能使用它们。

  • Git:用来管理代码版本(提交、推送、拉取)
  • Docker:用来创建隔离的开发环境(容器)
  • Python/Node.js/Java:用来运行你的代码

这些工具都在远程机上,你用 VSCode 的终端操作它们,就像在本地电脑上操作一样。


第二部分:实际操作步骤(怎么做)

步骤 0:确认你已拿到以下信息

找你的 Mentor 或 IT 确认:

  • ✅ 远程开发机的 IP地址 (例如 10.0.0.100
  • SSH端口 (通常是 22
  • 用户名 (例如 zhangsan
  • 登录方式(密码 or SSH密钥)
  • ✅ 是否已预装 gitdocker

步骤 1:本地电脑安装 VSCode

  1. 到官网下载:https://code.visualstudio.com/
  2. 安装完成后打开 VSCode
  3. 点击左侧 扩展图标 (或按 Ctrl+Shift+X
  4. 搜索 Remote - SSH,点击 安装

步骤 2:配置 SSH 连接(二选一)

方式A:使用密码登录(简单,适合首次)
  1. 在 VSCode 中按 F1Ctrl+Shift+P

  2. 输入 Remote-SSH: Connect to Host...

  3. 选择 Add New SSH Host...

  4. 输入:

    复制代码
    ssh 用户名@IP地址 -p 端口号

    例如:

    复制代码
    ssh zhangsan@10.0.0.100 -p 22
  5. 按回车,选择第一个配置文件(默认路径即可)

  6. 每次连接时会提示输入密码

方式B:使用 SSH 密钥登录(推荐,更安全,免密码)
  1. 生成密钥(本地电脑上操作):

    bash 复制代码
    ssh-keygen -t ed25519 -C "你的公司邮箱"

    一路按回车,默认保存在 ~/.ssh/id_ed25519

  2. 把公钥添加到远程机

    • 用密码先登录远程机
    • 编辑文件 ~/.ssh/authorized_keys
    • 把你本地 ~/.ssh/id_ed25519.pub 的内容复制进去(一行一个)
    • 如果没有权限,找 IT 或 Mentor 帮忙
  3. 配置 VSCode 使用密钥

    • 编辑本地 ~/.ssh/config(Windows在 C:\Users\你的用户名\.ssh\config

    • 添加以下内容:

      复制代码
      Host dev-server
          HostName 10.0.0.100
          User zhangsan
          Port 22
          IdentityFile ~/.ssh/id_ed25519
    • 保存后,VSCode 会自动用密钥登录,不再需要输入密码


步骤 3:连接远程开发机

  1. 打开 VSCode
  2. 点击左下角 >< 图标
  3. 选择 Connect to Host...
  4. 选择你配置的主机(例如 dev-server 或 IP地址)
  5. 等待第一次连接(约10-30秒,vscode-server会自动下载)
  6. 连接成功后,左下角显示 SSH: dev-server

步骤 4:打开项目并配置环境

  1. 点击左侧 资源管理器 图标
  2. 点击 打开文件夹
  3. 选择你的项目路径(例如 /home/zhangsan/projects/myapp
  4. 按 `Ctrl+`` 打开终端(现在你的终端已经连接到远程机)

步骤 5:检查开发工具是否可用

在终端中输入以下命令,检查工具是否就绪:

bash 复制代码
# 检查 Git
git --version

# 检查 Docker
docker --version

# 检查 Python(如果项目需要)
python --version

如果显示版本号,说明已安装,可以直接使用。

如果提示"command not found"

  • 找 IT 或 Mentor 帮忙安装

  • 或者自己安装(需要有 sudo 权限):

    bash 复制代码
    # 安装 Git
    sudo apt-get install git        # Ubuntu/Debian
    sudo yum install git            # CentOS/RHEL
    
    # 安装 Docker
    sudo apt-get install docker.io  # Ubuntu/Debian
    sudo yum install docker         # CentOS/RHEL

步骤 6:配置 Git(第一次必须做)

在远程终端中执行:

bash 复制代码
git config --global user.name "你的中文姓名"
git config --global user.email "你的公司邮箱"

步骤 7:开始使用 Git 和 Docker

使用 Git(管理代码)

方式一:使用 VSCode 图形界面

  1. 点击左侧 源代码管理 图标(第三个图标)
  2. 你可以看到修改的文件、提交按钮、分支切换等
  3. 所有操作都在远程机上执行,界面在本地显示

方式二:使用终端命令

bash 复制代码
git status               # 查看当前状态
git add .                # 添加所有修改
git commit -m "提交说明" # 提交代码
git push origin main     # 推送到远程仓库
使用 Docker(管理开发环境)

方式一:使用终端命令

bash 复制代码
docker ps                # 查看运行中的容器
docker images            # 查看镜像
docker-compose up -d     # 启动项目环境
docker-compose logs -f   # 查看日志

方式二:安装 VSCode 的 Docker 插件

  1. 在远程连接状态下,搜索安装 Docker 插件
  2. 安装后左侧会出现 Docker 图标
  3. 可以直接查看容器、镜像、启动/停止等

步骤 8:配置端口转发(如果需要访问 Web 服务)

如果远程机上运行了 Web 服务(例如 Flask 在 5000 端口):

  1. 在 VSCode 左下角点击 端口 图标
  2. 点击 添加端口
  3. 输入端口号(如 5000)
  4. 本地浏览器访问 http://localhost:5000 即可看到远程服务

第三部分:常见问题排查

问题 可能原因 解决方法
连不上:Connection refused 端口不对或防火墙拦截 确认端口号,联系IT检查防火墙
连不上:Permission denied 用户名/密码错误,或密钥不对 确认登录信息,检查公钥是否添加
连不上:Host key verification failed 远程机指纹变了 删除 ~/.ssh/known_hosts 中对应行
连上但很慢 DNS解析问题 直接使用IP地址
终端命令找不到 环境变量未加载 执行 source ~/.bashrc 或重启终端
docker 命令提示无权限 用户不在docker组 执行 sudo usermod -aG docker $USER 后重登

第四部分:每日工作流程(快速参考)

复制代码
1. 打开 VSCode
2. 点击左下角 >< → 选择你配置的主机
3. 等待连接成功(左下角显示 SSH: dev-server)
4. 按 Ctrl+` 打开终端
5. cd 到项目目录
6. 开始写代码、用 git、用 docker
7. 下班时直接关闭 VSCode(会自动断开连接)

一句话总结

你不需要在远程机上装VSCode,只需确保远程机有git和docker等工具。VSCode会自动在远程机安装一个后台服务,让你的操作感觉像在本地一样流畅。