Xmake 中实现全局脚本只执行一次的技巧

背景介绍

在使用 Xmake 构建系统进行项目开发时，特别是涉及多目标测试的场景下，开发者经常会遇到需要在多个测试目标执行前进行一些预处理操作的情况。例如，准备测试数据、拷贝配置文件等。这些操作如果处理不当，可能会导致并发执行时的冲突问题。

问题分析

传统做法是为每个测试目标添加一个规则(rule)，在每个目标执行前都执行相同的预处理脚本。这种方法虽然简单直接，但存在两个明显问题：

1. 性能问题：每个目标都会重复执行相同的预处理操作，当目标数量较多时，会造成不必要的性能损耗。
2. 并发冲突：在多线程并行执行测试时，多个目标同时操作相同的文件可能导致冲突，出现文件访问错误。

解决方案

Xmake 提供了全局变量 _g，可以用于在构建过程中存储全局状态。利用这一特性，我们可以实现脚本的"单例"执行模式：

rule("prepare_test_data")
    before_run(function(target)
        if not _g.test_data_prepared then
            _g.test_data_prepared = true
            -- 这里放置只需要执行一次的预处理代码
            os.trycp("localization/loc_archon/*.conf", target:rundir(), {rootdir = "."})
            os.trycp("localization/loc_archon/*.yaml", target:rundir(), {rootdir = "."})
            -- 其他文件拷贝操作...
        end
    end)

实现原理

1. 全局变量检查：通过检查 _g.test_data_prepared 是否存在来判断是否是第一次执行
2. 状态标记：第一次执行时设置 _g.test_data_prepared = true 标记已执行
3. 条件执行：后续执行会跳过预处理代码块

优势分析

1. 性能提升：避免了重复的文件操作，显著减少构建时间
2. 并发安全：确保预处理操作只执行一次，消除多线程冲突风险
3. 代码简洁：不需要复杂的锁机制或文件存在检查
4. 维护方便：预处理逻辑集中在一处，便于统一修改

实际应用建议

1. 对于文件拷贝操作，建议使用 os.trycp 而非 os.cp，避免因文件已存在而报错
2. 复杂预处理逻辑可以封装为独立函数，保持代码清晰
3. 考虑添加日志输出，便于调试和验证执行情况
4. 对于需要清理的场景，可以在 after_run 或 after_test 中添加清理逻辑

总结

通过利用 Xmake 的全局变量特性，开发者可以优雅地解决多目标预处理时的重复执行问题。这种方法不仅提高了构建效率，还增强了构建过程的可靠性，特别适合大型项目中需要处理大量测试目标的场景。