HTTP 代码库规则

可以从 @bazel_tools//tools/build_defs/repo:http.bzl 加载以下函数。

通过 HTTP 下载文件和归档文件的规则。

设置

如需在模块扩展程序中使用这些规则，请将其加载到 .bzl 文件中，然后从扩展程序的实现函数中调用这些规则。例如，使用 http_archive：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

def _my_extension_impl(mctx):
  http_archive(name = "foo", urls = [...])

my_extension = module_extension(implementation = _my_extension_impl)

或者，您也可以使用 use_repo_rule 直接在 MODULE.bazel 文件中调用这些代码库规则：

http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(name = "foo", urls = [...])

http_archive

load("@bazel//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(name, add_prefix, auth_patterns, build_file, build_file_content, canonical_id,
             integrity, netrc, patch_args, patch_cmds, patch_cmds_win, patch_tool, patches,
             remote_file_integrity, remote_file_urls, remote_patch_strip, remote_patches,
             repo_mapping, sha256, strip_prefix, type, url, urls, workspace_file,
             workspace_file_content)

以压缩归档文件的形式下载 Bazel 代码库，对其进行解压缩，并使其目标可供绑定。

它支持以下文件扩展名："zip"、"jar"、"war"、"aar"、"tar"、"tar.gz"、"tgz"、"tar.xz"、"txz"、"tar.zst"、"tzst"、tar.bz2、"ar" 或 "deb"。

示例：假设当前代码库包含聊天程序的源代码，其根目录为 ~/chat-app。它需要依赖于 SSL 库，该库可从 http://example.com/openssl.zip 获取。此 .zip 文件包含以下目录结构：

  WORKSPACE
  src/
    openssl.cc
    openssl.h

在本地代码库中，用户创建一个包含以下目标定义的 openssl.BUILD 文件：

  cc_library(
      name = "openssl-lib",
      srcs = ["src/openssl.cc"],
      hdrs = ["src/openssl.h"],
  )

如果将以下行添加到 ~/chat-app/WORKSPACE，则 ~/chat-app 代码库中的目标可以依赖于此目标：

  load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

  http_archive(
      name = "my_ssl",
      url = "http://example.com/openssl.zip",
      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      build_file = "@//:openssl.BUILD",
  )

然后，目标会将 @my_ssl//:openssl-lib 指定为依赖项。

属性

name 名称；必需

此代码库的唯一名称。

add_prefix 字符串；可选

相对于代码库目录的目标目录。 对归档文件中的文件路径应用 `strip_prefix`（如果有）后，归档文件将解压缩到此目录中。例如，如果 `add_prefix = "bar"` 和 `strip_prefix = "foo-1.2.3"`，则文件 `foo-1.2.3/src/foo.h` 将解压缩到 `bar/src/foo.h`。

auth_patterns Dictionary: String -> String；可选

一个可选字典，用于将主机名映射到自定义授权模式。 如果此字典中存在网址的主机名，则在为 HTTP 请求生成授权标头时，该值将用作模式。这样一来，您就可以使用许多常见的云端存储空间服务中使用的自定义授权方案。该模式目前支持 2 个令牌：<login> 和 <password>，它们会替换为同一主机名的 netrc 文件中的等效值。格式化后，结果会设置为 HTTP 请求的 Authorization 字段的值。 使用不记名令牌将 HTTP 下载到启用了 oauth2 的 API 的属性和 netrc 示例：

auth_patterns = {
    "storage.cloudprovider.com": "Bearer <password>"
}
netrc： 
machine storage.cloudprovider.com
        password RANDOM-TOKEN
最终的 HTTP 请求将包含以下标头： 
Authorization: Bearer RANDOM-TOKEN

build_file 标签；可选

要用作此代码库的 BUILD 文件的文件。此属性是绝对标签（对于主代码库，请使用“@//”）。该文件不必命名为 BUILD，但可以这样命名（例如 BUILD.new-repo-name 可能很适合用于将其与代码库的实际 BUILD 文件区分开来。可以指定 build_file 或 build_file_content，但不能同时指定这两者。

build_file_content 字符串；可选

此代码库的 BUILD 文件的内容。您可以指定 build_file 或 build_file_content，但不能同时指定这两者。

canonical_id 字符串；可选

已下载文件的规范 ID。 如果指定了非空值，则 Bazel 不会从缓存中获取文件，除非该文件是通过具有相同规范 ID 的请求添加到缓存中的。 如果未指定或为空，Bazel 默认将文件的网址用作规范 ID。这有助于发现更新网址但未更新哈希值的常见错误，从而导致构建在本地成功，但在缓存中没有文件的机器上失败。您可以使用 --repo_env=BAZEL_HTTP_RULES_网址S_AS_DEFAULT_CANONICAL_ID=0 停用此行为。

integrity 字符串；可选

下载的文件的预期子资源完整性格式校验和。 必须与所下载文件的校验和一致。_省略校验和会带来安全风险，因为远程文件可能会发生变化。_最好省略此字段会导致构建非封闭。此属性是可选的，可简化开发流程，但在发布之前应设置此属性或 `sha256`。

netrc 字符串；可选

用于身份验证的 .netrc 文件的位置

patch_args 字符串列表；可选

提供给修补工具的参数。默认为 -p0，但通常需要为 git 生成的补丁使用 -p1。如果指定了多个 -p 参数，则最后一个参数将生效。如果指定了 -p 以外的参数，Bazel 将回退使用 patch 命令行工具，而不是使用原生 Bazel 补丁实现。当回退到补丁命令行工具且未指定 patch_tool 属性时，系统将使用 `patch`。这只会影响 `patches` 属性中的补丁文件。

patch_cmds 字符串列表；可选

在应用补丁后，要在 Linux/Macos 上应用的 Bash 命令序列。

patch_cmds_win 字符串列表；可选

在应用补丁后，要在 Windows 上应用的一系列 PowerShell 命令。如果未设置此属性，patch_cmds 将在 Windows 上执行，这需要 Bash 二进制文件存在。

patch_tool 字符串；可选

要使用的 patch(1) 实用程序。如果指定了此参数，Bazel 将使用指定的补丁工具，而不是 Bazel 原生补丁实现。

patches 标签列表；可选

解压缩归档文件后要作为补丁应用的文件列表。默认情况下，它使用不支持模糊匹配和二进制补丁的 Bazel 原生补丁实现，但如果指定了 `patch_tool` 属性或 `patch_args` 属性中存在 `-p` 以外的参数，则 Bazel 会回退使用补丁命令行工具。

remote_file_integrity 字典：String -> String；可选

文件相对路径（键）与其完整性值（值）的映射。这些相对路径应映射到“remote_file_urls”属性中的文件（键）。

remote_file_urls 字典：字符串 -> 字符串列表；可选

相对路径（键）到网址（值）列表的映射，这些网址（值）将被下载并在代码库中作为叠加文件提供。如果您想在现有代码库上添加 WORKSPACE 或 BUILD.bazel 文件，这会非常有用。系统会先下载这些文件，然后再应用 `patches` 属性中的补丁，并且网址列表应均为同一文件的可能镜像。系统会按顺序尝试这些网址，直到其中一个网址成功。

remote_patch_strip 整数；可选

要从远程补丁的文件名中删除的前导斜杠的数量。

remote_patches 字典：String -> String；可选

补丁文件网址与其完整性值之间的映射，在解压缩归档文件后，在应用 `patches` 属性中的补丁文件之前应用这些映射。它使用 Bazel 原生补丁实现，您可以使用 `remote_patch_strip` 指定补丁条数

repo_mapping Dictionary: String -> String；可选

仅在“WORKSPACE”上下文中：从本地代码库名称到全局代码库名称的字典。这样，您就可以控制此代码库的依赖项的工作区依赖项解析。 例如，条目“@foo: @bar”声明，每当此仓库依赖于“@foo”（例如依赖于“@foo//some:target”）时，它实际上应在全局声明的“@bar”中解析该依赖项（“@bar//some:target”）。“MODULE.bazel”上下文（在模块扩展的实现函数内调用仓库规则时）_不支持_此属性。

sha256 字符串；可选

下载的文件的预期 SHA-256。 此值必须与下载的文件的 SHA-256 值一致。_省略 SHA-256 会带来安全风险，因为远程文件可能会发生变化。_最起码，省略此字段会使 build 不具有密封性。为了简化开发，这是可选操作，但应在发布前设置此属性或 `integrity`。

strip_prefix 字符串；可选

要从解压缩的文件中删除的目录前缀。 许多归档文件都包含一个顶级目录，其中包含归档文件中的所有实用文件。您无需在 `build_file` 中反复指定此前缀，只需使用此字段即可从所有提取的文件中剥离此前缀。 例如，假设您使用的是 `foo-lib-latest.zip`，其中包含目录 `foo-lib-1.2.3/`，该目录下包含 `WORKSPACE` 文件，并且 `src/`、`lib/` 和 `test/` 目录包含您要构建的实际代码。指定 `strip_prefix = "foo-lib-1.2.3"` 以将 `foo-lib-1.2.3` 目录用作顶级目录。 请注意，如果此目录外存在文件，这些文件将被舍弃且无法访问（例如顶级许可文件）。这包括以该前缀开头但不在该目录中的文件/目录（例如`foo-lib-1.2.3.release-notes`)。如果指定的前缀与归档中的目录不匹配，Bazel 将返回错误。

type 字符串；可选

下载文件的归档类型。 默认情况下，归档类型根据网址的文件扩展名确定。如果文件没有扩展名，您可以明确指定以下扩展名之一：`"zip"`、`"jar"`、`"war"`、`"aar"`、`"tar"`、`"tar.gz"`、`"tgz"`、`"tar.xz"`、`"txz"`、`"tar.zst"`、`"tzst"`、`"tar.bz2"`、`"ar"` 或 `"deb"`。

url 字符串；可选

指向可供 Bazel 使用的文件的网址。 此字段必须是文件、http 或 https 网址。遵循重定向。 不支持身份验证。 使用 urls 参数可以指定从中获取的备用网址，从而实现更高的灵活性。

urls 字符串列表；可选

指向可供 Bazel 使用的文件的网址列表。 每个条目都必须是文件、http 或 https 网址。会跟踪重定向。 不支持身份验证。 系统会按顺序尝试网址，直到某个网址成功为止，因此您应先列出本地镜像。如果所有下载均失败，则规则将会失败。

workspace_file Label（标签）；选填

要用作此代码库的“WORKSPACE”文件的文件。可以指定 `workspace_file` 或 `workspace_file_content`，也可以不指定这两者，但不能同时指定这两者。

workspace_file_content 字符串；可选

此代码库的 WORKSPACE 文件的内容。可以指定 `workspace_file` 或 `workspace_file_content`，也可以不指定这两者，但不能同时指定这两者。

环境变量

此代码库规则依赖于以下环境变量：

  • BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID

http_file

load("@bazel//tools/build_defs/repo:http.bzl", "http_file")

http_file(name, auth_patterns, canonical_id, downloaded_file_path, executable, integrity, netrc,
          repo_mapping, sha256, url, urls)

从网址下载文件，并将其作为文件组使用。

示例：假设您需要为自定义规则创建一个 Debian 软件包。此软件包可从 http://example.com/package.deb 获取。然后，您可以将以下内容添加到 WORKSPACE 文件中：

  load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")

  http_file(
      name = "my_deb",
      url = "http://example.com/package.deb",
      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  )

目标会将 @my_deb//file 指定为依赖于此文件的依赖项。

属性

name 名称；必需

此代码库的唯一名称。

auth_patterns Dictionary: String -> String；可选

将主机名映射到自定义授权格式的可选字典。 如果此字典中存在网址的主机名，则在为 HTTP 请求生成授权标头时，该值将用作模式。这样，您就可以使用许多常见云存储服务提供商使用的自定义授权方案。 该模式目前支持 2 个令牌：<login> 和 <password>，它们会在 netrc 文件中替换为同一主机名的等效值。格式化后，结果会设置为 HTTP 请求的 Authorization 字段的值。 使用不记名令牌向启用了 OAuth2 的 API 进行 HTTP 下载的属性和 netrc 示例： 

auth_patterns = {
    "storage.cloudprovider.com": "Bearer <password>"
}
netrc： 
machine storage.cloudprovider.com
        password RANDOM-TOKEN
最终的 HTTP 请求将包含以下标头： 
Authorization: Bearer RANDOM-TOKEN

canonical_id 字符串；可选

已下载文件的规范 ID。 如果指定了非空值，则 Bazel 不会从缓存中获取文件，除非该文件是通过具有相同规范 ID 的请求添加到缓存中的。 如果未指定或为空，Bazel 默认将文件的网址用作规范 ID。这有助于发现更新网址但未更新哈希值的常见错误，从而导致构建在本地成功，但在缓存中没有文件的机器上失败。您可以使用 --repo_env=BAZEL_HTTP_RULES_网址S_AS_DEFAULT_CANONICAL_ID=0 停用此行为。

downloaded_file_path 字符串；可选

分配给所下载文件的路径

executable 布尔值；可选

是否应将下载的文件设为可执行文件。

integrity 字符串；可选

下载的文件的预期子资源完整性格式校验和。 必须与所下载文件的校验和一致。_省略校验和会带来安全风险，因为远程文件可能会发生变化。_最好省略此字段会导致构建非封闭。此属性是可选的，可简化开发流程，但在发布之前应设置此属性或 `sha256`。

netrc 字符串；可选

用于身份验证的 .netrc 文件的位置

repo_mapping 字典：String -> String；可选

仅在 `WORKSPACE` 上下文中：一个字典，用于将本地代码库名称转换为全局代码库名称。这样，您就可以控制此代码库的依赖项的工作区依赖项解析。 例如，条目“@foo: @bar”声明，每当此仓库依赖于“@foo”（例如依赖于“@foo//some:target”）时，它实际上应在全局声明的“@bar”中解析该依赖项（“@bar//some:target”）。“MODULE.bazel”上下文（在模块扩展的实现函数内调用仓库规则时）_不支持_此属性。

sha256 字符串；可选

下载的文件的预期 SHA-256。 此值必须与下载的文件的 SHA-256 值一致。_省略 SHA-256 会带来安全风险，因为远程文件可能会发生变化。_最起码，省略此字段会使 build 不具有密封性。这项设置可选，可简化开发流程，但应在发布前进行设置。

url 字符串；可选

指向可供 Bazel 使用的文件的网址。 此字段必须是文件、http 或 https 网址。遵循重定向。 不支持身份验证。 使用 urls 参数可以指定从中获取的备用网址，从而实现更高的灵活性。

urls 字符串列表；可选

要提供给 Bazel 的文件的网址列表。 每个条目都必须是文件、http 或 https 网址。会跟踪重定向。 不支持身份验证。 系统会按顺序尝试网址，直到某个网址成功为止，因此您应先列出本地镜像。如果所有下载均失败，则规则将会失败。

环境变量

此代码库规则依赖于以下环境变量：

  • BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID

http_jar

load("@bazel//tools/build_defs/repo:http.bzl", "http_jar")

http_jar(name, auth_patterns, canonical_id, downloaded_file_name, integrity, netrc, repo_mapping,
         sha256, url, urls)

从网址下载 jar 文件，并将其作为 java_import 提供

下载的文件必须具有 .jar 扩展名。

示例：假设当前代码库包含聊天程序的源代码，其根目录为 ~/chat-app。它需要依赖于 http://example.com/openssl-0.2.jar 提供的 SSL 库。

如果将以下代码行添加到 ~/chat-app/WORKSPACE，~/chat-app 仓库中的目标便可以依赖于此目标：

  load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar")

  http_jar(
      name = "my_ssl",
      url = "http://example.com/openssl-0.2.jar",
      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  )

目标将指定 @my_ssl//jar 作为依赖项，以依赖于此 jar。

如果您使用的是基于 Unix 的系统，还可以使用“file:///path/to/file”来引用当前系统（localhost）上的文件。如果您使用的是 Windows，请使用“file:///c:/path/to/file”。在这两个示例中，请注意三个斜杠 (/)，前两个斜杠属于 file://，第三个斜杠属于文件的绝对路径。

属性

name 名称（必需）

此代码库的唯一名称。

auth_patterns 字典：String -> String；可选

将主机名映射到自定义授权格式的可选字典。 如果此字典中存在网址的主机名，则在为 HTTP 请求生成授权标头时，该值将用作模式。这样，您就可以使用许多常见云存储服务提供商使用的自定义授权方案。 该模式目前支持 2 个令牌：<login> 和 <password>，它们会在 netrc 文件中替换为同一主机名的等效值。格式化后，结果会设置为 HTTP 请求的 Authorization 字段的值。 使用不记名令牌将 HTTP 下载到启用了 oauth2 的 API 的属性和 netrc 示例：

auth_patterns = {
    "storage.cloudprovider.com": "Bearer <password>"
}
netrc： 
machine storage.cloudprovider.com
        password RANDOM-TOKEN
最终的 HTTP 请求将包含以下标头： 
Authorization: Bearer RANDOM-TOKEN

canonical_id 字符串；可选

已下载文件的规范 ID。 如果指定了非空值，则 Bazel 不会从缓存中获取文件，除非该文件是通过具有相同规范 ID 的请求添加到缓存中的。 如果未指定或为空，Bazel 默认将文件的网址用作规范 ID。这有助于发现更新网址但未更新哈希值的常见错误，从而导致构建在本地成功，但在缓存中没有文件的机器上失败。您可以使用 --repo_env=BAZEL_HTTP_RULES_网址S_AS_DEFAULT_CANONICAL_ID=0 停用此行为。

downloaded_file_name 字符串；可选

为下载的 jar 分配的文件名

integrity 字符串；可选

下载的文件的预期子资源完整性格式校验和。 必须与所下载文件的校验和一致。_省略校验和会带来安全风险，因为远程文件可能会发生变化。_最好省略此字段会导致构建非封闭。此属性是可选的，可简化开发流程，但在发布之前应设置此属性或 `sha256`。

netrc 字符串；可选

用于身份验证的 .netrc 文件的位置

repo_mapping 字典：String -> String；可选

仅在 `WORKSPACE` 上下文中：一个字典，用于将本地代码库名称转换为全局代码库名称。这样，您就可以控制此代码库的依赖项的工作区依赖项解析。 例如，条目“@foo: @bar”声明，每当此仓库依赖于“@foo”（例如依赖于“@foo//some:target”）时，它实际上应在全局声明的“@bar”中解析该依赖项（“@bar//some:target”）。“MODULE.bazel”上下文（在模块扩展的实现函数内调用仓库规则时）_不支持_此属性。

sha256 字符串；可选

下载的文件的预期 SHA-256。 此值必须与下载的文件的 SHA-256 值一致。_省略 SHA-256 会带来安全风险，因为远程文件可能会发生变化。_最起码，省略此字段会使 build 不具有密封性。为了简化开发，这是可选操作，但应在发布前设置此属性或 `integrity`。

url 字符串；可选

要提供给 Bazel 的文件的网址。 此字段必须是文件、http 或 https 网址。会跟踪重定向。 不支持身份验证。 通过 urls 参数，您可以指定要从中提取数据的备用网址，从而实现更大的灵活性。 网址必须以 `.jar` 结尾。

urls 字符串列表；可选

要提供给 Bazel 的文件的网址列表。 每个条目都必须是文件、http 或 https 网址。会跟踪重定向。 不支持身份验证。 系统会按顺序尝试网址，直到某个网址成功为止，因此您应先列出本地镜像。如果所有下载都失败，则规则将失败。 所有网址都必须以 `.jar` 结尾。

环境变量

此代码库规则依赖于以下环境变量：

  • BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID