WSL 中的远程开发
本教程将引导你完成启用 Windows Subsystem for Linux (WSL) 以及使用 WSL 扩展在 WSL 中运行 Visual Studio Code 的过程。
先决条件
你需要安装 Visual Studio Code。
安装扩展
WSL 扩展使你能够在 Windows Subsystem for Linux (WSL) 中运行 Visual Studio Code。
先决条件检查
安装 WSL 扩展后,你将在最左侧看到一个新的状态栏项。
远程状态栏项可以快速显示 VS Code 当前运行的上下文(本地或远程),单击该项将显示 WSL 扩展命令。
启用 WSL
Windows Subsystem for Linux (WSL) 是 Windows 10 上的可选功能。你可以通过“Windows 功能”对话框或 PowerShell 启用它。
“Windows 功能”对话框
在 Windows 搜索栏中,键入“功能”以打开“启用或关闭 Windows 功能”对话框。向下滚动并选中“Windows Subsystem for Linux”。
选择“确定”,系统将提示你重启 Windows。
PowerShell
如果你愿意,可以以管理员身份打开 PowerShell 并键入
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
命令运行后,系统将提示你重启 Windows。
检查 WSL
重启 Windows 后,你可以通过打开命令提示符并键入“wsl”来检查是否已启用 WSL。
WSL 已启用,但你尚未安装 Linux 发行版。
安装 Linux 发行版
你可以从 Microsoft Store 为 WSL 安装 Linux 发行版。你可以使用应用商店应用,或者在 Windows 搜索栏中搜索 Linux 发行版。选择你要安装的 Linux 发行版(例如 Ubuntu),然后按照提示操作。
选择“安装”。
完成后,选择“启动”以开始使用。这将打开 Linux 终端并完成安装。你需要创建用户 ID 和密码,因为你正在设置完整的 Linux 实例。你现在正在 Windows 上运行 Linux。
Python 开发
如果尚未安装 Python,请运行以下命令将 Python3 和 pip(Python 的包管理器)安装到你的 Linux 安装中。
sudo apt update
sudo apt install python3 python3-pip
要验证,请运行
python3 --version
从规范的“Hello World”应用开始。创建一个名为“helloWorld”的新文件夹,然后添加一个 Python 文件,该文件在运行时将打印一条消息
mkdir helloWorld && cd helloWorld
echo 'print("hello from python on ubuntu on windows!")' >> hello.py
python3 hello.py
在远程 Linux 环境中(此 WSL 发行版在技术上是另一台没有 UI 的计算机,它恰好在你的计算机本地运行),你的开发工具和体验非常有限。你可以在终端中运行 Vim 来编辑你的文件,或者你可以通过 \\wsl$
挂载在 Windows 端编辑源文件
此模型的问题在于 Python 运行时、pip 或任何 conda 包都未安装在 Windows 上。
请记住,Python 安装在 Linux 发行版中,这意味着如果你在 Windows 端编辑 Python 文件,则除非你在 Windows 上安装相同的 Python 开发堆栈,否则你无法运行或调试它们。这会破坏设置具有所有 Python 工具和运行时的隔离 Linux 实例的目的!
在 WSL 中运行
在 WSL 终端中,确保你位于 helloWorld 文件夹中,然后键入 'code .'
以启动 Visual Studio Code。'.'
参数告诉 VS Code 打开当前文件夹。如果你使用 VS Code 的 Insiders 版本,则必须运行 'code-insiders .'
。
注意: 如果此命令不起作用,你可能需要重启终端,或者你可能在安装 VS Code 时未将其添加到你的路径中。
你首先会看到一条关于“正在安装 VS Code Server”的消息(c7d83e57… 数字是 VS Code Server 的版本,它与你刚刚安装的客户端工具匹配)。VS Code 正在 Linux 端安装一个小服务器,桌面 VS Code 将与之通信。然后,该服务器将在 WSL 中安装和托管扩展,以便它们在 WSL 中安装的工具和框架的上下文中运行。换句话说,你的语言扩展将针对 WSL 中安装的工具和框架运行,而不是针对 Windows 端安装的工具和框架运行,这对于正确的开发体验至关重要。
接下来发生的事情是 VS Code 将启动并打开 helloWorld
文件夹。你可能会看到一个快速通知,告诉你 VS Code 正在连接到 WSL,并且可能会提示你允许访问基于 Node.js 的服务器。
现在,当你将鼠标悬停在 hello.py
上时,你将获得正确的 Linux 路径。
集成终端
运行“终端”>“新建终端”(⌃` (Windows, Linux Ctrl+`)) 以打开新的终端实例。
你将从 Windows 上运行的 VS Code 再次在 WSL 中启动 bash shell 的新实例。
提示:在状态栏的左下角,你可以看到你已连接到你的 WSL: Ubuntu 实例。
编辑和调试
安装 Python 扩展(和其他工具)
单击 hello.py
以打开它进行编辑。系统将提示你扩展建议,在本例中是安装 Microsoft Python 扩展,这将为你提供丰富的编辑和调试体验。继续并选择“安装”,并在提示时重新加载。
为了证明扩展已安装在 WSL 中,请再次打开“扩展”视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X))。你将看到一个标题为“WSL: Ubuntu – 已安装”的部分,你可以看到 WSL 端安装的任何扩展。
重新加载后,你还会收到提示,告诉你 pylint linter 未安装。Linter 用于显示源代码中的错误和警告。继续并选择“安装”。
现在,当你编辑代码时,你将获得丰富的着色和补全。
当你保存文件时 (⌘S (Windows, Linux Ctrl+S)),你将在文件上获得 linting 错误和警告。
调试
设置好工具后,让我们更进一步。通过单击行号左侧的装订线或将光标放在该行上并按 F9,在 hello.py 的第 1 行设置一个断点。
现在,按 F5 运行你的应用程序。系统将询问你如何运行应用程序,由于这是一个简单的文件,只需选择“Python 文件”。
应用将启动,你将命中该断点。你可以检查变量、创建监视并导航调用堆栈。
按 F10 进行单步跳过,你将在调试控制台中看到 print 语句的输出。
你获得了 Visual Studio Code 的完整开发体验,使用了 WSL 中安装的 Linux 实例。
如果要在 WSL 中打开另一个文件夹,请打开“文件”菜单并选择“打开文件夹”。你将获得 Linux 文件系统的最小文件和文件夹导航器,而不是 Windows 文件系统。
如果要切换回 Windows,请选择“显示本地”选项,你将获得标准的 Windows 文件打开对话框。
结束你的 WSL 连接
你可以结束你在 WSL 中的会话,并通过“文件”>“关闭远程连接”返回到本地运行 VS Code。
恭喜
恭喜,你已成功完成本教程!
接下来,查看其他远程开发扩展。
或者通过安装 Remote Development Extension Pack 来获取所有这些扩展。