Objective-C 规则

规则

• j2objc_library
• objc_import
• objc_library
• available_xcodes
• xcode_config
• xcode_version

j2objc_library

j2objc_library(name, deps, compatible_with, deprecation, distribs, entry_classes, features, jre_deps, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

此规则使用 J2ObjC 将 Java 源文件转换为 Objective-C，后者可用作 objc_library 和 objc_binary 规则的依赖项。如需详细了解 J2ObjC 本身，请访问 J2ObjC 网站

您可以在命令行中使用 build 标志 --j2objc_translation_flags 指定自定义 J2ObjC 转译标志。

请注意，j2objc_library 目标中包含的已翻译文件将使用默认编译配置进行编译，该配置与 objc_library 规则的源代码相同，并且未在属性中指定编译选项。

此外，系统会在目标级别（而非源代码级别）对生成的代码进行去重。如果两个不同的 Java 目标包含相同的 Java 源文件，则可能会在链接时看到重复符号错误。解决此问题的正确方法是将共享的 Java 源文件移到可以依赖的单独通用目标中。

参数

属性
name	Name; required 此目标的唯一名称。
deps	List of labels; optional j2objc_library、java_library、java_import 和 java_proto_library 目标的列表，其中包含要转译为 Objective-C 的 Java 文件。 系统会转换和编译可通过 exports、deps 和 runtime_deps 传递的所有 java_library 和 java_import 目标。目前不支持由 Java 注解处理生成的文件，也不支持未指定 srcjar 的 java_import 目标。 J2ObjC 转换的运作方式因传递闭包中包含的 Java 源源文件的类型而异。对于 java_library 的 srcs 中包含的每个 .java 源文件，系统会生成一个相应的 .h 和 .m 源文件。对于 java_library 的 srcs 或 java_import 的 srcjar 中包含的每个源代码 jar，系统将生成相应的 .h 和 .m 源文件，其中包含该 jar 的所有代码。 用户可以在他们的代码中导入由 J2ObjC 生成的头文件。这些文件的导入路径是原始 Java 工件的相对根路径。例如，//some/package/foo.java 的导入路径为 some/package/foo.h，//some/package/bar.srcjar 的导入路径为 some/package/bar.h 如果 proto_library 规则位于此规则的传递闭包中，则还会在二进制文件级别生成、编译和链接 J2ObjC proto。对于 proto //some/proto/foo.proto，用户可以使用导入路径 some/proto/foo.j2objc.pb.h 引用生成的代码。
entry_classes	List of strings; optional 用户 ObjC 代码会直接引用其转换的 ObjC 对应项的 Java 类列表。如果已开启 --j2objc_dead_code_removal 标志，则必须提供此属性。Java 类应按照 Java 语言规范定义的规范名称指定。 指定 --j2objc_dead_code_removal 标志后，系统将以传递方式收集条目类的列表，并将其用作执行死代码分析的入口点。然后，未使用的类将从最终的 ObjC app bundle 中移除。
jre_deps	List of labels; optional 此 j2objc_library 规则转换的所有 Java 代码所需的其他 JRE 模拟库的列表。默认情况下，仅关联 JRE 核心功能。

objc_import

objc_import(name, hdrs, alwayslink, archives, compatible_with, deprecation, distribs, features, includes, licenses, restricted_to, sdk_dylibs, sdk_frameworks, sdk_includes, tags, target_compatible_with, testonly, textual_hdrs, visibility, weak_sdk_frameworks)

此规则以 .a 文件的形式封装已编译的静态库。它还允许使用 objc_library 支持的相同属性导出标头和资源。

参数

属性
name	Name; required 此目标的唯一名称。
hdrs	List of labels; optional 此库发布的 C、C++、Objective-C 和 Objective-C++ 头文件的列表，这些文件将由源文件包含在相关规则中。 这些标头用于描述库的公共接口，并且可供源包含在此规则或相关规则中。不应由此库的客户端包含的标头应改为在 srcs 属性中列出。 如果启用了模块，这些变量将与源代码分开编译。
alwayslink	Boolean; optional; default is False 如果为 1，则（直接或间接）依赖于此库的任何软件包或二进制文件都将链接到 srcs 和 non_arc_srcs 中列出的文件的所有对象文件，即使一些文件不包含任何二进制文件引用的符号也是如此。 如果二进制文件中的代码未明确调用您的代码（例如，您的代码注册以接收某个服务提供的某个回调），那么这会非常有用。
archives	List of labels; required 提供给依赖于此目标的 Objective-C 目标的 .a 文件列表。
includes	List of strings; optional 要添加到此目标及所有依赖目标的 #include/#import 搜索路径列表。 这是为了支持不在其 #import/#include 语句中指定整个工作区路径的第三方和开源库。 系统会相对于软件包目录解释路径，并且除了实际的客户端根目录之外，还包含 genfile 和 bin 根目录（例如 blaze-genfiles/pkg/includedir 和 blaze-out/pkg/includedir）。 与 COPTS 不同，这些标志是为此规则以及依赖于它的所有规则添加的。（注意：并非它所依赖的规则！）请务必小心，因为这可能会造成深远的影响。如果您有疑问，请改为向 COPTS 添加“-iquote”标志。
sdk_dylibs	List of strings; optional 要关联的 SDK .dylib 库的名称。例如，“libz”或“libarchive”。 如果二进制文件的依赖项树中包含任何 C++ 或 Objective-C++ 源代码，则会自动包含“libc++”。链接二进制文件时，系统会使用该二进制文件的传递依赖关系图中指定的所有库。
sdk_frameworks	List of strings; optional 要关联的 SDK 框架的名称（例如“AddressBook”“QuartzCore”）。针对 iOS、tvOS 和 watchOS 平台进行构建时始终包含“UIKit”和“Foundation”。对于 macOS，始终仅包含“Foundation”。 关联顶级 Apple 二进制文件时，会链接该二进制文件的传递依赖关系图中列出的所有 SDK 框架。
sdk_includes	List of strings; optional 要添加到此目标及所有依赖目标的 #include/#import 搜索路径列表，其中每个路径都相对于 $(SDKROOT)/usr/include。
textual_hdrs	List of labels; optional 由此规则中的源文件或此库的用户添加为标头的 C、C++、Objective-C 和 Objective-C++ 文件的列表。与 hdr 不同，此类文件不会与源代码分开编译。
weak_sdk_frameworks	List of strings; optional 需要建立弱关联的 SDK 框架的名称。例如，“MediaAccessibility”。 与定期关联的 SDK 框架不同，如果运行时不存在来自弱关联框架的符号，则不会导致错误。

objc_library

objc_library(name, deps, srcs, data, hdrs, alwayslink, compatible_with, copts, defines, deprecation, distribs, enable_modules, exec_compatible_with, exec_properties, features, includes, licenses, linkopts, module_map, module_name, non_arc_srcs, pch, restricted_to, runtime_deps, sdk_dylibs, sdk_frameworks, sdk_includes, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, weak_sdk_frameworks)

此规则从给定的 Objective-C 源文件生成静态库。

参数

属性
name	Name; required 此目标的唯一名称。
deps	List of labels; optional 链接在一起以形成最终 bundle 的目标列表。
srcs	List of labels; optional 为创建库目标而处理的 C、C++、Objective-C 和 Objective-C++ 源文件和头文件和/或（“.s”“.S”或“.asm”）汇编源文件的列表。 这些位置包括您已签到的文件以及所有生成的文件。 源文件使用 Clang 编译为 .o 文件。标头文件可由此目标的 srcs 属性中的任何来源或标头添加/导入，但不能由 hdrs 中的标头或依赖于此规则的任何目标添加/导入。 此外，预编译的 .o 文件可作为 src 提供。请注意确保所提供的 .o 文件的架构与 build 的架构保持一致，以免缺少符号链接器错误。
hdrs	List of labels; optional 此库发布的 C、C++、Objective-C 和 Objective-C++ 头文件的列表，这些文件将由源文件包含在相关规则中。 这些标头用于描述库的公共接口，并且可供源包含在此规则或相关规则中。不应由此库的客户端包含的标头应改为在 srcs 属性中列出。 如果启用了模块，这些变量将与源代码分开编译。
alwayslink	Boolean; optional; default is False 如果为 1，则（直接或间接）依赖于此库的任何软件包或二进制文件都将链接到 srcs 和 non_arc_srcs 中列出的文件的所有对象文件，即使一些文件不包含任何二进制文件引用的符号也是如此。 如果二进制文件中的代码未明确调用您的代码（例如，您的代码注册以接收某个服务提供的某个回调），那么这会非常有用。
copts	List of strings; optional 要传递给编译器的额外标记。 可以使用“Make 变量”替换和 Bourne shell 令牌化。这些标志仅适用于此目标，而不适用于该目标所依赖的那些目标。 请注意，对于生成的 Xcode 项目，系统会解析在 copt 中使用“-I”标志指定的目录路径，如果这些路径是相对路径，则会带有前缀“$(WORKSPACE_ROOT)/”，并添加到关联 Xcode 目标的标头搜索路径中。
defines	List of strings; optional 要传递给编译器的额外 -D 标记。它们应该采用 KEY=VALUE 或 KEY 格式，并且不仅要传递给此目标的编译器（就像 copts 一样），还要传递给此目标的所有 objc_ 依赖项。 受“创建变量”替换和 Bourne shell 令牌化的约束。
enable_modules	Boolean; optional; default is False 启用 clang 模块支持（通过 -fmodules）。 将此值设置为 1 将允许您 @import 系统头文件和其他目标： @import UIKit; @import path_to_package_target;
includes	List of strings; optional 要添加到此目标及所有依赖目标的 #include/#import 搜索路径列表。 这是为了支持不在其 #import/#include 语句中指定整个工作区路径的第三方和开源库。 系统会相对于软件包目录解释路径，并且除了实际的客户端根目录之外，还包含 genfile 和 bin 根目录（例如 blaze-genfiles/pkg/includedir 和 blaze-out/pkg/includedir）。 与 COPTS 不同，这些标志是为此规则以及依赖于它的所有规则添加的。（注意：并非它所依赖的规则！）请务必小心，因为这可能会造成深远的影响。如果您有疑问，请改为向 COPTS 添加“-iquote”标志。
linkopts	List of strings; optional 要传递给链接器的额外标记。
module_map	Label; optional 此目标的自定义 Clang 模块映射。不建议使用自定义模块映射。大多数用户应使用 Bazel 生成的模块映射。如果指定，Bazel 不会为此目标生成模块映射，但会将提供的模块映射传递给编译器。
module_name	String; optional 设置此目标的模块名称。默认情况下，模块名称是目标路径，并将所有特殊符号都替换为 _，例如 //foo/baz:bar 可以作为 foo_baz_bar 导入。
non_arc_srcs	List of labels; optional 为创建不使用 ARC 的库目标而处理的 Objective-C 文件列表。此属性中文件的处理方式与 srcs 属性中的文件非常相似，但会在未启用 ARC 的情况下进行编译。
pch	Label; optional 要附加到正在编译的每个源文件（包括 arc 和非 arc）前的头文件。 我们强烈建议不要在 BUILD 文件中使用 pch 文件，此类文件应被视为已废弃。由于 pch 文件实际上并非预编译，因此这并非构建速度的增强功能，而只是一个全局依赖项。从构建效率的角度来看，您实际上最好将所需内容直接包含到所需的源代码中。
runtime_deps	List of labels; optional 在运行时延迟加载的框架目标的列表。它们包含在 app bundle 中，但在构建时未与其关联。
sdk_dylibs	List of strings; optional 要关联的 SDK .dylib 库的名称。例如，“libz”或“libarchive”。 如果二进制文件的依赖项树中包含任何 C++ 或 Objective-C++ 源代码，则会自动包含“libc++”。链接二进制文件时，系统会使用该二进制文件的传递依赖关系图中指定的所有库。
sdk_frameworks	List of strings; optional 要关联的 SDK 框架的名称（例如“AddressBook”“QuartzCore”）。针对 iOS、tvOS 和 watchOS 平台进行构建时始终包含“UIKit”和“Foundation”。对于 macOS，始终仅包含“Foundation”。 关联顶级 Apple 二进制文件时，会链接该二进制文件的传递依赖关系图中列出的所有 SDK 框架。
sdk_includes	List of strings; optional 要添加到此目标及所有依赖目标的 #include/#import 搜索路径列表，其中每个路径都相对于 $(SDKROOT)/usr/include。
textual_hdrs	List of labels; optional 由此规则中的源文件或此库的用户添加为标头的 C、C++、Objective-C 和 Objective-C++ 文件的列表。与 hdr 不同，此类文件不会与源代码分开编译。
weak_sdk_frameworks	List of strings; optional 需要建立弱关联的 SDK 框架的名称。例如，“MediaAccessibility”。 与定期关联的 SDK 框架不同，如果运行时不存在来自弱关联框架的符号，则不会导致错误。

available_xcodes

available_xcodes(name, default, deprecation, distribs, features, licenses, tags, testonly, versions, visibility)

xcode_config 规则实例可以依赖此规则的两个目标来指示远程和本地可用的 Xcode 版本。这样，您就可以从共同可用的 Xcode 中选择官方 Xcode 版本。

参数

属性
name	Name; required 此目标的唯一名称。
default	Label; required; nonconfigurable 此平台的默认 Xcode 版本。
versions	List of labels; optional; nonconfigurable 此平台上提供的 Xcode 版本。

xcode_config

xcode_config(name, default, deprecation, distribs, features, licenses, local_versions, remote_versions, tags, testonly, versions, visibility)

--xcode_version_config build 标志可以引用此规则的单个目标，以将 --xcode_version 标志转换为可接受的官方 Xcode 版本。这样，您就可以从多个已注册别名中选择官方 Xcode 版本。

参数

属性
name	Name; required 此目标的唯一名称。
default	Label; optional; nonconfigurable 要使用的默认官方 Xcode 版本。 如果没有指定 xcode_version 构建标志，系统将使用提供的 xcode_version 目标指定的版本。如果设置了任何 versions，则必须执行此操作。如果设置了 remote_versions 或 local_versions，则不会设置此字段。
local_versions	Label; optional; nonconfigurable xcode_version targets that are available locally. These are used along with local_versions to select a mutually available version. This may not be set if versions is set.
remote_versions	Label; optional; nonconfigurable xcode_version targets that are available remotely. These are used along with remote_versions to select a mutually available version. This may not be set if versions is set.
versions	List of labels; optional; nonconfigurable xcode_version targets that may be used. If the value of the xcode_version build flag matches one of the aliases or version number of any of the given xcode_version targets, the matching target will be used. This may not be set if remote_versions or local_versions is set. 项已接受

xcode_version

xcode_version(name, default_ios_sdk_version, default_macos_sdk_version, default_tvos_sdk_version, default_watchos_sdk_version, deprecation, distribs, features, licenses, tags, testonly, version, visibility)

代表一个官方 Xcode 版本，并且该版本可接受该 Xcode 版本的别名。 请参阅 xcode_config 规则。

参数

属性
name	Name; required 此目标的唯一名称。
default_ios_sdk_version	String; optional; nonconfigurable 使用此 Xcode 版本时默认使用的 iOS SDK 版本。 ios_sdk_version 构建标志将替换此处指定的值。
default_macos_sdk_version	String; optional; nonconfigurable 使用此 Xcode 版本时默认使用的 macosx SDK 版本。 macos_sdk_version 构建标志将替换此处指定的值。
default_tvos_sdk_version	String; optional; nonconfigurable 使用此版本的 Xcode 时，默认使用的 tvos SDK 版本。 tvos_sdk_version 构建标志将替换此处指定的值。
default_watchos_sdk_version	String; optional; nonconfigurable 使用此版本的 Xcode 时，默认使用的 watchos SDK 版本。 watchos_sdk_version 构建标志将替换此处指定的值。
version	String; required; nonconfigurable Xcode 版本的官方版本号。