Xmake项目中get_config函数在描述域的行为分析

问题现象

在Xmake构建系统中，用户在使用描述域(description scope)时发现了一个有趣的现象：当调用set_config设置配置值后，立即使用get_config获取该值时，前两次调用会返回nil，而后两次调用才能正确获取到设置的值。具体表现为：

set_config("cc", "gcc")
print("111", get_config("cc"))

输出结果为：

111     nil
111     nil
111     gcc
111     gcc

技术背景

Xmake是一个基于Lua的现代化构建工具，它采用多阶段加载机制来处理项目配置。描述域是Xmake中一个特殊的执行环境，用于定义项目的构建规则和配置。在这个环境中，Xmake会对脚本进行多次解析和执行，以实现不同的功能阶段。

原因分析

1. 多阶段加载机制：Xmake在初始化过程中会对项目脚本进行多次加载，第一次用于解析基本配置，第二次用于应用用户配置，后续阶段才真正执行构建逻辑。这种设计使得前两次调用get_config时配置尚未完全生效。

2. 配置传播延迟：set_config设置的配置值需要经过Xmake内部的处理流程才能完全生效，这导致了在描述域中立即获取配置值可能出现不一致的情况。

3. 设计考量：这种行为实际上是Xmake的预期设计，因为描述域主要用于定义构建规则而非即时执行逻辑操作。Xmake建议用户不要在描述域中进行调试打印或依赖即时配置获取。

解决方案

1. 避免在描述域调试：遵循Xmake的最佳实践，不要在描述域中使用print进行调试，也不要在该阶段依赖配置值的即时获取。

2. 使用默认值处理：如果确实需要在描述域中获取配置值，可以采用Lua的or运算符提供默认值：

   local cc = get_config("cc") or "gcc"
   

3. 理解执行阶段：认识到Xmake脚本会被多次执行，不同阶段有不同的目的，避免编写依赖于执行次数的代码。

深入理解

Xmake的这种设计实际上反映了构建系统的复杂性。现代构建工具通常需要处理多种场景：

• 配置探测阶段
• 规则定义阶段
• 实际构建阶段

每个阶段对配置信息的需求不同，因此Xmake采用了这种分阶段加载的机制。理解这一点有助于开发者编写更健壮的构建脚本。

最佳实践建议

1. 将配置设置和获取逻辑放在适当的Xmake阶段中
2. 避免在描述域中编写有副作用的代码
3. 使用Xmake提供的专门调试工具而非print语句
4. 对于关键配置，考虑使用更稳定的获取方式，如通过option或target定义

通过理解Xmake的内部工作机制，开发者可以更好地利用这个强大的构建工具，编写出更可靠、更高效的构建脚本。