在 Windows 上使用 Bazel

回報問題 查看來源 Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

本頁面說明在 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 (MSYS2) 的 Bazel

在沒有 Bash 的情況下使用 bazel build

在 1.0 之前的 Bazel 版本中，建構某些規則需要使用 Bash。

從 Bazel 1.0 開始，您可以建構任何規則，不必使用 Bash，但下列情況除外：

  • genrule，因為 genrule 會執行 Bash 指令
  • sh_binary 或 sh_test 規則，因為這些規則本質上需要 Bash
  • 使用 ctx.actions.run_shell() 或 ctx.resolve_command() 的 Starlark 規則

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

使用 bazel test，但不使用 Bash

1.0 之前的 Bazel 版本需要 Bash 才能執行任何作業。bazel test

從 Bazel 1.0 開始，您可以測試任何規則，不必使用 Bash，但下列情況除外：

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

使用 bazel run (不含 Bash)

1.0 之前的 Bazel 版本需要 Bash 才能執行任何作業。bazel run

從 Bazel 1.0 開始，您可以執行任何規則，不必使用 Bash，但以下情況除外：

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

使用 sh二進位檔和 sh* 規則，以及 ctx.actions.run_shell() (不含 Bash)

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

日後或許可以選擇使用適用於 Linux 的 Windows 子系統 (WSL) 建構這些規則，但目前 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。

    需求條件：支援 VC 2017 和 2019。獨立的 VC 2015 建構工具不支援選取 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++ 建構工具，因為即使使用 clang-cl.exe 做為編譯器，您仍需連結至 Visual C++ 程式庫。

Bazel 可以自動偵測系統上的 LLVM 安裝位置，您也可以透過 BAZEL_LLVM 明確告知 Bazel 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
    • 在 WORKSPACE 檔案中註冊平台和工具鍊：
    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 檔案
  • 可設定 JVM 環境並執行二進位檔的 .exe 檔案

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

  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 檔案
  • 可啟動 Python 解譯器的可執行檔，並以自解壓縮 zip 檔案做為引數

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

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

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

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