如何在Bazel的http_archive中添加已有文件至解压源码？

为什么之前的方案失败 #

• filegroup只是逻辑上的文件分组，不会将文件复制到http_archive解压后的外部仓库目录中，无法让外部库的构建逻辑访问到该文件。
• 直接在patch_cmds中执行cp include/additional_features.h ...会失败，因为Bazel的沙箱机制会隔离外部仓库的构建环境，本地文件默认不在沙箱内，导致找不到源文件。

可行解决方案 #

方案1：通过http_archive的srcs参数传入文件，配合patch_cmds复制 #

将本地头文件加入http_archive的srcs列表，让Bazel把文件带入沙箱，再用$(location)引用沙箱内的文件路径执行复制：

# WORKSPACE文件中
http_archive(
    name = "external_lib",
    urls = ["https://example.com/external_lib.tar.gz"],
    sha256 = "替换为实际的sha256校验值",
    srcs = ["//include:additional_features.h"],
    patch_cmds = [
        # 将沙箱内的头文件复制到外部库的include目录
        "cp $(location //include:additional_features.h) include/",
    ],
)

注意：//include:additional_features.h是本地文件的label，确保该路径在你的项目中存在，且对应的BUILD文件中有filegroup或直接暴露该文件。

方案2：自定义repository规则（更灵活） #

如果需要更复杂的定制逻辑，可以编写自定义的repository规则，手动控制下载、解压和文件复制流程：

# 在WORKSPACE或单独的.bzl文件中
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_download")

def _custom_external_lib_impl(ctx):
    # 下载并解压外部库
    http_download(
        ctx,
        url = "https://example.com/external_lib.tar.gz",
        sha256 = "替换为实际的sha256校验值",
        output = "external_lib.tar.gz",
    )
    ctx.execute(["tar", "xf", "external_lib.tar.gz"])
    
    # 读取本地头文件并写入外部仓库的目标目录
    ctx.file(
        "include/additional_features.h",
        ctx.read(ctx.attr.additional_header)
    )

# 定义repository规则
custom_external_lib = repository_rule(
    implementation = _custom_external_lib_impl,
    attrs = {
        "additional_header": attr.label(
            mandatory = True,
            allow_single_file = True
        ),
    },
)

# 调用规则引入外部库
custom_external_lib(
    name = "external_lib",
    additional_header = "//include:additional_features.h",
)

方案3：不修改外部仓库，通过组合target实现依赖 #

如果不需要将头文件物理复制到外部仓库目录，更符合Bazel规范的做法是创建一个新的cc_library，将外部库和本地头文件组合在一起：

# 项目中的BUILD文件
cc_library(
    name = "external_lib_with_features",
    # 依赖外部库的原有target
    deps = ["@external_lib//:lib"],
    # 引入本地头文件
    hdrs = ["//include:additional_features.h"],
    # 让依赖该target的代码能直接通过#include "additional_features.h"引用
    includes = ["include"],
)

后续项目中的target直接依赖//:external_lib_with_features即可同时使用外部库和本地新增的头文件，这种方式无需修改外部仓库的内容，更符合Bazel的依赖隔离原则。

内容的提问来源于stack exchange，提问作者frans