UBT · PlatformSDK

一. PlatformSDK 的定位与用途

当我们需要为某个平台实现它的PlatformSDK时，我们需要先了解UEBuildPlatformSDK。

​UEBuildPlatformSDK 在 Unreal Build Tool (UBT) 架构中充当平台开发工具包（SDK）配置管理器的角色。它的核心功能是管理特定平台的 SDK、NDK 和工具链的安装路径、版本信息以及环境配置。它负责定位系统上的开发工具。

该模块的主要用途包括：

• SDK/NDK 检测：
  核心职责是定位 SDK/NDK 的根目录，并验证其存在性和有效性。
• 版本检测：
  检查并返回 SDK/NDK 的版本号，确保符合构建要求。
• 环境自检：
  提供接口来快速判断是否有可用的 SDK 配置，确保构建的前提条件已满足。

简而言之，UEBuildPlatformSDK 专注于解决“构建所需的工具在哪里”的问题，确保在启动实际编译流程之前，所有的路径和环境变量都已准确无误地设置好。

---

二. 添加新平台支持时需要关注的信息

为新平台（例如 OpenHarmony）实现一个派生自 UEBuildPlatformSDK 的类时，需要重点关注以下几个实现点：

实现 HasAnySDK() 方法：

最基础的检查接口，判断当前系统是否有可用且配置正确的 SDK 安装路径。它是后续所有构建流程的开关。

• 不同平台检查SDK实现的方法略有不同，根据平台特点按需封装。

• Nintendo类似的接口是HasRefactoredSDK，Xbox是Json配置。

实现 SDK 定位逻辑：

在你的派生类中，需要编写 robust（健壮） 的逻辑来定位 SDK 根目录。这通常涉及：

• 检查特定的环境变量（例如 MYPLATFORM_SDK_PATH）。

• 读取特定操作系统的注册表键值。

• 检查标准的安装路径。

实现 CheckEnvironmentVariables() 方法：

• 核心配置入口： 当 UBT 需要配置环境时会调用此方法。在这里实现环境变量的优先级逻辑。
• INI 优先/回退逻辑： 实现从 INI 文件读取配置作为首选参考，如果 INI 无效，则执行系统扫描。
• 更新当前环境： 使用 Environment.SetEnvironmentVariable() 设置关键路径到当前构建会话的进程环境中。
• 提供诊断信息：
  确保在 SDK 找不到或路径配置有误时，提供清晰、具有指导性的错误日志输出，帮助开发者快速定位和解决环境配置问题。

---

三. 潜在风险与注意事项

在实现或修改 UEBuildPlatformSDK 扩展时，需要特别警惕以下常见陷阱：

硬编码 SDK 版本号：

• 情况： 将引擎要求的最低 API Level 或 SDK 版本硬编码在 C# 代码中。

• 问题： 目标平台供应商（如 Google、Apple）发布新的强制要求时，你的构建系统会立即失效，需要修改代码并重新编译 UBT。

• 建议： 应从可外部修改的配置文件（如 BuildConfiguration.xml 或 INI 文件）中动态读取兼容版本范围。

依赖不可靠的环境变量：

• 情况： 过度依赖用户手动设置的环境变量，而不是提供强大的自动检测逻辑。

• 问题： 不同的开发机器环境不一致，导致“在我的机器上可以编译，在你的机器上不行”的问题。

• 建议： 提供多种查找机制（注册表、标准路径、环境变量回退），并确保 CheckEnvironmentVariables 能够稳健地将找到的路径写入 INI 进行标准化。

遗漏跨平台路径格式处理：

• 情况： 在 C# 中构建路径字符串时使用 Windows 的 \ 或 Linux 的 /，而没有考虑当前的主机操作系统。
• 问题： 在不同的主机平台上生成错误的 INI 配置或环境变量，导致构建失败。
• 建议： 始终使用 UBT 提供的 FileReference 和 DirectoryReference 辅助类，或 Path.Combine 等标准 .NET/C# 方法来处理跨平台路径。

‍