在 Windows 上使用 Bazel

回報問題 查看原始碼

本頁面說明在 Windows 上使用 Bazel 的最佳做法。如需安裝操作說明，請參閱在 Windows 上安裝 Bazel。

已知問題

在 GitHub 上，與 Windows 相關的 Bazel 問題會加上「team-Windows」標籤。您可以在這裡查看待解決的問題。

最佳做法

避免長路徑問題

有些工具在 Windows 上設有路徑長度上限限制，包括 MSVC 編譯器。 如要避免發生這個問題，您可以透過 --output_user_root 標記為 Bazel 指定短的輸出目錄。

例如，在 bazelrc 檔案中新增以下這一行：

startup --output_user_root=C:/tmp

啟用 8.3 檔案名稱支援功能

Bazel 會嘗試為較長的檔案路徑建立簡稱版本。但為瞭解決這個問題，必須為含有長路徑的檔案啟用 8.3 檔案名稱支援功能。您可以在所有磁碟區中執行下列指令，以便在所有磁碟區中建立 8.3 名稱：

fsutil 8dot3name set 0

部分功能需要 Bazel 才能在 Windows 上建立檔案符號連結，方法是啟用開發人員模式 (在 Windows 10 1703 以上版本中)，或是以管理員身分執行 Bazel。這可以啟用下列功能：

如要簡化，請在 bazelrc 檔案中加入以下幾行程式碼：

startup --windows_enable_symlinks
build --enable_runfiles

注意：在 Windows 上建立符號連結是一項耗費資源的作業。--enable_runfiles 旗標可能會建立大量檔案符號連結。請只在需要時才啟用這項功能。

執行 Bazel：MSYS2 shell 與命令提示字元與 PowerShell

建議：透過命令提示字元 (cmd.exe) 或 PowerShell 執行 Bazel。

自 2020 年 1 月 15 日起，請不要從 bash 執行 Bazel，包括 MSYS2 shell、Git Bash、Cygwin 或任何其他 Bash 變體。雖然 Bazel 可能適用於大部分用途，但有些事情會毀損，例如使用 MSYS2 的 Ctrl+C 中斷建構作業。此外，如果您選擇在 MSYS2 之下執行，必須停用 MSYS2 的自動路徑轉換，否則 MSYS 會將「看起來像」 Unix 路徑 (例如 //foo:bar) 的指令列引數轉換為 Windows 路徑。詳情請參閱這個 StackOverflow 解答。

在不使用 Bash 的情況下使用 Bazel (MSYS2)

在不使用 Bash 的情況下使用 bazel 版本

使用 1.0 以下版本的 Bazel 版本，要求 Bash 建構部分規則。

從 Bazel 1.0 開始，在沒有 Bash 的情況下可以建構任何規則：

  • genrule，因為 Genrules 會執行 Bash 指令
  • sh_binary 或 sh_test 規則，因為它們本身需要 Bash
  • 使用 ctx.actions.run_shell() 或 ctx.resolve_command() 的 Starlark 規則

不過，genrule 通常用於簡單的工作，例如複製檔案或寫入文字檔案。您可以不使用 genrule (並視 Bash)，而在 bazel-skylib 存放區中找到適當的規則。在 Windows 上建構時，這些規則不需要 Bash。

在不使用 Bash 的情況下使用 Bazel 測試

使用 1.0 以下版本的 Bazel 版本，需要 Bash 才能bazel test有任何內容。

從 Bazel 1.0 開始，在沒有 Bash 的情況下測試任何規則，除了以下情況以外：

  • 你使用 --run_under
  • 測試規則本身需要 Bash (因為其可執行檔是殼層指令碼)

在不使用 Bash 的情況下使用 bazel run

使用 1.0 以下版本的 Bazel 版本，需要 Bash 才能bazel run有任何內容。

從 Bazel 1.0 開始，即可在沒有 Bash 的情況下執行任何規則，但下列情況除外：

  • 你使用 --run_under 或 --script_path
  • 測試規則本身需要 Bash (因為其可執行檔是殼層指令碼)

使用 sh_binary 和 sh_* 規則，以及不使用 Bash 的 ctx.actions.run_shell()

您需要 Bash 才能建構並測試 sh_* 規則，以及建構及測試使用 ctx.actions.run_shell() 和 ctx.resolve_command() 的 Starlark 規則。這不僅適用於專案中的規則，也適用於專案依附任何外部存放區的規則 (甚至是間接)。

未來，您可以選擇使用適用於 Linux (WSL) 的 Windows 子系統來建構這些規則，但目前並不是 Bazel-on Windows 子團隊的優先要務。

設定環境變數

您在 Windows 命令提示字元 (cmd.exe) 中設定的環境變數，只會在命令提示字元工作階段中設定。如果要啟動新的 cmd.exe，就必須再次設定變數。如要一律在 cmd.exe 啟動時設定變數，可將變數新增至 Control Panel > System Properties > Advanced > Environment Variables... 對話方塊中的「使用者變數」或「系統變數」。

在 Windows 上建構

使用 MSVC 建構 C++

如要使用 MSVC 建構 C++ 目標，您需要：

  • Visual C++ 編譯器。

  • (選用) BAZEL_VC 和 BAZEL_VC_FULL_VERSION 環境變數。

    Bazel 會自動偵測您系統中的 Visual C++ 編譯器。如要指示 Bazel 使用特定的 VC 安裝，您可以設定下列環境變數：

    如果是 Visual Studio 2017 和 2019，請設定其中一個 BAZEL_VC。此外，您也可以設定 BAZEL_VC_FULL_VERSION。

    • BAZEL_VC Visual C++ Build Tools 安裝目錄

      set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC

    • BAZEL_VC_FULL_VERSION (選用) 僅適用於 Visual Studio 2017 和 2019，是 Visual C++ Build Tools 完整版本號碼。如果安裝多個版本，您可以透過 BAZEL_VC_FULL_VERSION 選擇正確的 Visual C++ Build Tools 版本，否則 Bazel 就會選擇最新版本。

      set BAZEL_VC_FULL_VERSION=14.16.27023

    如果是 Visual Studio 2015 以下版本，請設定 BAZEL_VC。(不支援 BAZEL_VC_FULL_VERSION)。

    • BAZEL_VC Visual C++ Build Tools 安裝目錄

      set BAZEL_VC=C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC

  • Windows SDK。

    Windows SDK 包含建構 Windows 應用程式時所需的標頭檔案和程式庫，包括 Bazel 本身。根據預設，系統會使用最新安裝的 Windows SDK。您也可以設定 BAZEL_WINSDK_FULL_VERSION 來指定 Windows SDK 版本。您可以使用完整的 Windows 10 SDK 編號 (例如 10.0.10240.0)，也可以指定 8.1 來使用 Windows 8.1 SDK (只提供一個版本的 Windows 8.1 SDK)。請確認您已安裝指定的 Windows SDK。

    需求：創投 2017 和 2019 支援此功能。獨立的 VC 2015 Build Tools 不支援選取 Windows SDK，您必須完整安裝 Visual Studio 2015，否則系統會忽略 BAZEL_WINSDK_FULL_VERSION。

    set BAZEL_WINSDK_FULL_VERSION=10.0.10240.0

如果一切都設定妥當，您現在可以立即建構 C++ 目標！

請嘗試從我們的其中一個範例專案建構目標：

bazel build //examples/cpp:hello-world
bazel-bin\examples\cpp\hello-world.exe

根據預設，建構的二進位檔會鎖定 x64 架構。如要指定不同的目標架構，請為目標架構設定 --cpu 建構選項： * x64 (預設)：--cpu=x64_windows 或無選項 * x86：--cpu=x64_x86_windows * ARM：--cpu=x64_arm_windows * ARM64：--cpu=arm64_windows

舉例來說，如要建構 ARM 架構的目標，請執行以下指令：

bazel build //examples/cpp:hello-world --cpu=x64_arm_windows

如要建構並使用動態連結程式庫 (DLL 檔案)，請參閱此範例。

指令列長度限制：為避免發生 Windows 指令列長度限制問題，請透過 --features=compiler_param_file 啟用編譯器參數檔案功能。

使用 Clang 建構 C++

自 0.29.0 版起，Bazel 支援使用 LLVM 與 MSVC 相容的編譯器驅動程式 (clang-cl.exe) 進行建構。

需求條件：如要使用 Clang 進行建構，必須同時安裝 LLVM 和 Visual C++ Build 工具，因為雖然使用 clang-cl.exe 做為編譯器，仍需連結至 Visual C++ 程式庫。

Bazel 可自動偵測系統上的 LLVM 安裝項目，您也可以明確告知 Bazel 將 BAZEL_LLVM 安裝 LLVM。

  • BAZEL_LLVM：LLVM 安裝目錄

    set BAZEL_LLVM=C:\Program Files\LLVM

如要啟用 Clang 工具鍊以建構 C++，有幾個情境。

  • bazel 0.28 以下版本：不支援 Clang。

  • 如未使用 --incompatible_enable_cc_toolchain_resolution：您可以透過建構旗標 --compiler=clang-cl 啟用 Clang 工具鍊。

  • 使用 --incompatible_enable_cc_toolchain_resolution： 您必須在 BUILD file 中加入平台目標 (例如頂層 BUILD 檔案)：

    platform(
    name = "x64_windows-clang-cl",
    constraint_values = [
        "@platforms//cpu:x86_64",
        "@platforms//os:windows",
        "@bazel_tools//tools/cpp:clang-cl",
    ],
)

    然後，您可以透過下列其中一種方式啟用 Clang 工具鍊：

    • 指定下列建構旗標：
    --extra_toolchains=@local_config_cc//:cc-toolchain-x64_windows-clang-cl --extra_execution_platforms=//:x64_windows-clang-cl
    • 在 MODULE.bazel 檔案中註冊平台和工具鍊：
    register_execution_platforms(
    ":x64_windows-clang-cl"
)

register_toolchains(
    "@local_config_cc//:cc-toolchain-x64_windows-clang-cl",
)

    我們計劃在未來的 Bazel 版本中預設啟用 --incompatible_enable_cc_toolchain_resolution 標記。因此，建議您透過第二種方法啟用 Clang 支援。

建構 Java

如要建構 Java 目標，您需要：

在 Windows 中，Bazel 會為 java_binary 規則建構兩個輸出檔案：

  • 一個 .jar 檔案
  • .exe 檔案，可以設定 JVM 環境並執行二進位檔

請嘗試從我們的其中一個範例專案建構目標：

  bazel build //examples/java-native/src/main/java/com/example/myproject:hello-world
  bazel-bin\examples\java-native\src\main\java\com\example\myproject\hello-world.exe

建構 Python

如要建構 Python 目標，您需要：

在 Windows 中，Bazel 會為 py_binary 規則建構兩個輸出檔案：

  • 自我解壓縮 ZIP 檔案
  • 可執行檔，能夠以自我解壓縮 ZIP 檔案做為引數來啟動 Python 解譯器

您可以執行可執行檔 (副檔名為 .exe)，或以自我解壓縮 ZIP 檔案做為引數執行 Python。

請嘗試從我們的其中一個範例專案建構目標：

  bazel build //examples/py_native:bin
  bazel-bin\examples\py_native\bin.exe
  python bazel-bin\examples\py_native\bin.zip

如要進一步瞭解 Bazel 在 Windows 上建構 Python 的目標，請參閱這份設計文件。