Xmake 中 add_requires 的 configs 参数传递问题解析

问题背景

在使用 Xmake 构建系统时，开发者经常需要通过 add_requires 命令添加依赖包，并通过 configs 参数传递配置信息。然而，有些开发者发现通过这种方式传递的配置参数无法在包内部通过 package:config() 方法获取，只能通过 package:requireinfo().configs 访问。

问题现象

开发者尝试通过以下方式添加依赖包：

add_requires("TTKWidgetTools 3.0.0.0", {
    configs = {
        shared = true,
        debug = is_mode("debug"),
        qt_sdkver = get_config("qt_sdkver"),
        qt = get_config("qt")
    }
})

在包定义中使用两种方式打印配置信息：

package("TTKWidgetTools") do
    on_load(function (package)
        -- 方式一：通过 requireinfo 获取
        for key, value in pairs(package:requireinfo().configs) do
            print(key .. ": " .. tostring(value))
        end
        
        -- 方式二：通过 config() 获取
        for key, value in pairs(package:configs()) do
            print(key .. ":: " .. tostring(value))
        end
    end)
end

输出结果显示，package:configs() 方法获取的配置信息比 package:requireinfo().configs 少，导致无法通过 package:config("key") 获取所有传递的参数。

问题原因

经过深入分析，发现问题的根源在于包定义中缺少对配置参数的声明。Xmake 要求包定义中必须使用 add_configs 明确声明可以接受的配置参数，否则这些参数不会被自动注册到包的配置系统中。

解决方案

正确的做法是在包定义中预先声明所有可能的配置参数：

package("TTKWidgetTools") do
    -- 声明配置参数
    add_configs("qt_sdkver", {description = "Qt SDK 版本"})
    add_configs("qt", {description = "Qt 安装路径"})
    add_configs("shared", {description = "是否构建共享库"})
    add_configs("debug", {description = "是否调试模式"})
    
    on_load(function (package)
        -- 现在可以通过 config() 方法获取所有声明的配置
        print("qt_sdkver:", package:config("qt_sdkver"))
        print("qt:", package:config("qt"))
        print("shared:", package:config("shared"))
        print("debug:", package:config("debug"))
    end)
end

最佳实践

1. 完整声明配置参数：在包定义中使用 add_configs 声明所有可能用到的配置参数
2. 提供描述信息：为每个配置参数添加描述信息，方便其他开发者理解参数用途
3. 设置默认值：对于可选参数，可以设置默认值
4. 参数验证：在 on_load 回调中对参数进行验证，确保参数值合法

技术原理

Xmake 的这种设计有以下优点：

1. 显式声明优于隐式：明确声明配置参数可以提高代码的可读性和可维护性
2. 参数验证：在声明时可以添加参数验证逻辑
3. 文档生成：声明的配置参数可以用于自动生成文档
4. IDE 支持：IDE 可以根据声明提供代码补全和提示功能

总结

在 Xmake 中使用 add_requires 传递配置参数时，必须在包定义中通过 add_configs 明确声明这些参数，才能在包内部通过 package:config() 方法访问。这种设计虽然增加了一些声明工作，但带来了更好的可维护性和工具支持。开发者应该养成在包定义中完整声明所有配置参数的习惯，以确保构建系统的稳定性和可扩展性。