了解 VS Code 和 PowerShell 中的文件编码

使用 VS Code 创建和编辑 PowerShell 脚本时，使用正确的字符编码格式保存文件非常重要。

什么是文件编码以及为什么它很重要？

VS Code 管理人类将字符串输入缓冲区与向文件系统读/写字节块之间的接口。当 VS Code 保存文件时，它使用文本编码来决定每个字符变成什么字节。有关详细信息，请参阅 about_Character_Encoding。

同样，当 PowerShell 运行脚本时，它必须将文件中的字节转换为字符，以将文件重建为 PowerShell 程序。由于 VS Code 写入文件而 PowerShell 读取文件，因此它们需要使用相同的编码系统。解析 PowerShell 脚本的过程如下：字节 -> 字符 -> 令牌 -> 抽象语法树 - > 执行。

VS Code 和 PowerShell 都使用合理的默认编码配置进行安装。但是，随着 PowerShell 6 的发布，PowerShell 使用的默认编码已发生变化。为了确保在 VS Code 中使用 PowerShell 或 PowerShell 扩展不会出现问题，您需要正确配置 VS Code 和 PowerShell 设置。

编码问题的常见原因

当 VS Code 或脚本文件的编码与 PowerShell 的预期编码不匹配时，就会出现编码问题。 PowerShell 无法自动确定文件编码。

当您使用不属于 7 位 ASCII 字符集中的字符时，更有可能出现编码问题。例如：

• 扩展非字母字符，如破折号 (—)、不间断空格 ( ) 或左双引号 (")
• 重音拉丁字符 (É, ü)
• 非拉丁字符，如西里尔字母 (Д, Ц)
• CJK 字符（本、화、が）

编码问题的常见原因有：

• VS Code 和 PowerShell 的默认编码未发生更改。对于 PowerShell 5.1 及更低版本，默认编码与 VS Code 不同。
• 另一个编辑器已使用新编码打开并覆盖该文件。 ISE 经常发生这种情况。
• 该文件以与 VS Code 或 PowerShell 期望的编码不同的编码签入源代码管理。当协作者使用具有不同编码配置的编辑器时，可能会发生这种情况。

如何判断何时出现编码问题

编码错误通常会在脚本中表现为解析错误。如果您在脚本中发现奇怪的字符序列，这可能就是问题所在。在下面的示例中，破折号 (-) 显示为字符 â€"：

Send-MailMessage : A positional parameter cannot be found that accepts argument 'Testing FuseMail SMTP...'.
At C:\Users\<User>\<OneDrive>\Development\PowerShell\Scripts\Send-EmailUsingSmtpRelay.ps1:6 char:1
+ Send-MailMessage â&euro;"From $from â&euro;"To $recipient1 â&euro;"Subject $subject  ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [Send-MailMessage], ParameterBindingException
    + FullyQualifiedErrorId : PositionalParameterNotFound,Microsoft.PowerShell.Commands.SendMailMessage

出现此问题的原因是 VS Code 将 UTF-8 中的字符 - 编码为字节 0xE2 0x80 0x93。当这些字节被解码为 Windows-1252 时，它们被解释为字符 -"。

您可能会看到一些奇怪的字符序列包括：

• â€" 而不是 -（破折号）
• â€" 而不是 —（破折号）
• à2 而不是 Ä
• · 代替 （不间断空格）
• à© 而不是 é

此方便的参考列出了指示 UTF-8/Windows-1252 编码问题的常见模式。

VS Code 中的 PowerShell 扩展如何与编码交互

PowerShell 扩展通过多种方式与脚本交互：

1. 在 VS Code 中编辑脚本时，内容会由 VS Code 发送到扩展。语言服务器协议要求该内容以 UTF-8 格式传输。因此，扩展程序不可能获得错误的编码。
2. 当直接在集成控制台中执行脚本时，PowerShell 直接从文件中读取它们。如果 PowerShell 的编码与 VS Code 的编码不同，则此处可能会出现问题。
3. 当 VS Code 中打开的脚本引用 VS Code 中未打开的另一个脚本时，扩展会回退到从文件系统加载该脚本的内容。 PowerShell 扩展默认使用 UTF-8 编码，但使用字节顺序标记或 BOM 检测来选择正确的编码。

当假设采用无 BOM 格式的编码（如无 BOM 的 UTF-8 和 Windows-1252）时，就会出现此问题。 PowerShell 扩展默认为 UTF-8。该扩展无法更改 VS Code 的编码设置。有关更多信息，请参阅问题 #824。

选择正确的编码

不同的系统和应用程序可以使用不同的编码：

• 在 .NET Standard、Web 和 Linux 世界中，UTF-8 现在是占主导地位的编码。
• 许多 .NET Framework 应用程序使用 UTF-16。由于历史原因，有时称为“Unicode”，该术语现在指的是包括 UTF-8 和 UTF-16 的广泛标准。
• 在 Windows 上，许多早于 Unicode 的本机应用程序默认继续使用 Windows-1252。

Unicode 编码还具有字节顺序标记 (BOM) 的概念。 BOM 出现在文本的开头，告诉解码器文本正在使用哪种编码。对于多字节编码，BOM 还指示编码的字节顺序。 BOM 被设计为在非 Unicode 文本中很少出现的字节，允许在存在 BOM 时合理猜测文本是 Unicode。

BOM 是可选的，并且它们的采用在 Linux 世界中并不流行，因为到处都使用可靠的 UTF-8 约定。大多数 Linux 应用程序假定文本输入采用 UTF-8 编码。虽然许多 Linux 应用程序能够识别并正确处理 BOM，但也有一些应用程序不能识别并正确处理 BOM，从而导致使用这些应用程序操作的文本中出现伪影。

因此：

• 如果您主要使用 Windows 应用程序和 Windows PowerShell，您应该更喜欢使用 UTF-8 with BOM 或 UTF-16 等编码。
• 如果您跨平台工作，您应该更喜欢带有 BOM 的 UTF-8。
• 如果您主要在与 Linux 相关的环境中工作，您应该更喜欢无 BOM 的 UTF-8。
• Windows-1252 和 latin-1 本质上是旧编码，您应该尽可能避免使用。但是，一些较旧的 Windows 应用程序可能依赖于它们。
• 还值得注意的是，脚本签名与编码相关，这意味着签名脚本上的编码更改将需要重新签名。

配置 VS 代码

VS Code 的默认编码是 UTF-8 without BOM。

要设置 VS Code 的编码，请转到 VS Code 设置 (Ctrl+,) 并设置 "files.encoding" 设置：

"files.encoding": "utf8bom"

一些可能的值是：

• utf8：[UTF-8] 无 BOM
• utf8bom：[UTF-8] 带 BOM
• utf16le：小端字节序 [UTF-16]
• utf16be：大端字节序 [UTF-16]
• windows1252：[Windows-1252]

您应该在 GUI 视图中得到一个下拉列表，或者在 JSON 视图中得到它的补全。

如果可能的话，您还可以添加以下内容来自动检测编码：

"files.autoGuessEncoding": true

如果您不希望这些设置影响所有文件类型，VS Code 还允许按语言进行配置。通过将设置放入 [] 字段来创建特定于语言的设置。例如：

"[powershell]": {
    "files.encoding": "utf8bom",
    "files.autoGuessEncoding": true
}

您可能还需要考虑安装 Visual Studio Code 的 Gremlins 跟踪器。此扩展揭示了某些容易损坏的 Unicode 字符，因为它们不可见或看起来像其他正常字符。

配置PowerShell

PowerShell 的默认编码因版本而异：

• 在 PowerShell 6+ 中，所有平台上的默认编码均为 UTF-8 without BOM。
• 在 Windows PowerShell 中，默认编码通常是 Windows-1252，它是 latin-1（也称为 ISO 8859-1）的扩展。

在 PowerShell 5+ 中，您可以使用以下命令找到默认编码：

[psobject].Assembly.GetTypes() | Where-Object { $_.Name -eq 'ClrFacade'} |
  ForEach-Object {
    $_.GetMethod('GetDefaultEncoding', [System.Reflection.BindingFlags]'nonpublic,static').Invoke($null, @())
  }

以下脚本可用于确定 PowerShell 会话为没有 BOM 的脚本推断的编码。

$badBytes = [byte[]]@(0xC3, 0x80)
$utf8Str = [System.Text.Encoding]::UTF8.GetString($badBytes)
$bytes = [System.Text.Encoding]::ASCII.GetBytes('Write-Output "') + [byte[]]@(0xC3, 0x80) + [byte[]]@(0x22)
$path = Join-Path ([System.IO.Path]::GetTempPath()) 'encodingtest.ps1'

try
{
    [System.IO.File]::WriteAllBytes($path, $bytes)

    switch (& $path)
    {
        $utf8Str
        {
            return 'UTF-8'
            break
        }

        default
        {
            return 'Windows-1252'
            break
        }
    }
}
finally
{
    Remove-Item $path
}

可以使用配置文件设置将 PowerShell 配置为更普遍地使用给定编码。请参阅以下文章：

• @mklement0 在 StackOverflow 上关于 PowerShell 编码的回答。
• @rkeithhill 关于在 PowerShell 中处理无 BOM UTF-8 输入的博客文章。

无法强制 PowerShell 使用特定的输入编码。在区域设置设置为 en-US 的 Windows 上运行的 PowerShell 5.1 及更低版本，在没有 BOM 时默认为 Windows-1252 编码。其他区域设置可能使用不同的编码。为了确保互操作性，最好将脚本保存为带有 BOM 的 Unicode 格式。

这很重要

您拥有的任何其他接触 PowerShell 脚本的工具可能会受到您的编码选择的影响，或者将您的脚本重新编码为另一种编码。

现有脚本

文件系统上已有的脚本可能需要重新编码为您新选择的编码。在 VS Code 的底部栏中，您将看到标签 UTF-8。单击它打开操作栏并选择使用编码保存。您现在可以为该文件选择新的编码。有关完整说明，请参阅 VS Code 的编码。

如果需要对多个文件重新编码，可以使用以下脚本：

Get-ChildItem *.ps1 -Recurse | ForEach-Object {
    $content = Get-Content -Path $_
    Set-Content -Path $_.Fullname -Value $content -Encoding UTF8 -PassThru -Force
}

PowerShell 集成脚本环境 (ISE)

如果您还使用 PowerShell ISE 编辑脚本，则需要在那里同步编码设置。

ISE 应遵循 BOM，但也可以使用反射来设置编码。请注意，这不会在初创公司之间持续存在。

源控制软件

一些源代码管理工具，例如 git，会忽略编码； git 仅跟踪字节。其他产品（例如 Azure DevOps 或 Mercurial）可能不会。甚至一些基于 git 的工具也依赖于解码文本。

出现这种情况时，请确保：

• 在源代码管理中配置文本编码以匹配 VS Code 配置。
• 确保所有文件都以相关编码签入源代码管理。
• 请警惕通过源代码管理接收到的编码的更改。一个关键标志是差异表明发生了变化，但似乎没有任何变化（因为字节有变化，但字符没有变化）。

协作者的环境

除了配置源代码管理之外，请确保您共享的任何文件上的协作者没有通过重新编码 PowerShell 文件来覆盖您的编码的设置。

其他节目

任何其他读取或写入 PowerShell 脚本的程序都可能对其进行重新编码。

一些例子是：

• 使用剪贴板复制并粘贴脚本。这在以下场景中很常见：

  • 将脚本复制到 VM 中
• 从电子邮件或网页复制脚本
• 将脚本复制到 Microsoft Word 或 PowerPoint 文档中或从 Microsoft Word 或 PowerPoint 文档中复制出脚本

其中一些工具处理字节而不是文本，但其他工具提供编码配置。在需要配置编码的情况下，您需要将其设置为与编辑器编码相同以防止出现问题。

有关 PowerShell 中编码的其他资源

还有其他一些关于在 PowerShell 中编码和配置编码的好文章值得一读：

• about_Character_Encoding
• @mklement0 在 StackOverflow 上对 PowerShell 编码的总结

• 之前在 VS Code-PowerShell 上打开的编码问题问题：

  • 第1308章
• 第1628章
• 第1680章
• 第1744章
• 第1751章