Rustfmt格式化宏调用时错误删除关键代码的问题分析

在Rustfmt格式化工具的最新版本中，出现了一个值得开发者注意的问题：当格式化包含特定宏调用的代码时，工具会错误地删除宏参数中的关键部分。这个问题主要影响使用frame_support::construct_runtime!宏的代码，但类似的格式化问题也可能出现在其他宏调用场景中。

问题现象

在受影响版本中，当开发者编写如下代码时：

frame_support::construct_runtime!(
    pub struct Test {
        System: frame_system = 0,
        SelfDomainId: pallet_domain_id = 1,
    }
);

经过rustfmt格式化后，会错误地删除= NUMBER部分，变成：

frame_support::construct_runtime!(
    pub struct Test {
        System: frame_system,
        SelfDomainId: pallet_domain_id,
    }
);

这种变化不是等价的代码转换，而是直接破坏了原有代码的功能。这个问题在rustfmt 1.8.0-nightly (426d173423 2024-12-21)版本中出现，而在较早的1.8.0-nightly (4392847410 2024-10-21)版本中表现正常。

技术背景

Rustfmt作为Rust官方的代码格式化工具，其核心目标是保持代码功能不变的前提下，统一代码风格。对于宏调用的格式化一直是相对复杂的部分，因为宏的语法和语义高度依赖于具体实现。

在construct_runtime!宏的上下文中，= NUMBER部分通常用于指定模块的索引或标识符，这些数字对于运行时功能至关重要。删除这些数字会导致编译错误或运行时行为改变。

问题影响范围

这个问题不仅影响连续数字的情况，如=0、=1，也同样影响非连续数字的情况，例如：

frame_support::construct_runtime!(
    pub struct Test {
        System: frame_system = 60,
        SelfDomainId: pallet_domain_id = 1,
    }
);

在这种情况下，rustfmt同样会错误地删除所有= NUMBER部分，无论数字值是多少。

解决方案

开发者可以采取以下措施应对此问题：

1. 暂时降级：回退到已知工作正常的rustfmt版本，如1.8.0-nightly (4392847410 2024-10-21)

2. 等待修复：该问题已在最新nightly版本(1.8.0-nightly (bdc6b3de48 2024-12-23))中得到修复

3. 配置排除：在项目根目录的rustfmt配置文件中，添加相关宏到不格式化列表

最佳实践建议

对于使用复杂宏的项目，建议：

1. 在CI流程中加入格式化检查步骤，确保格式化不会改变代码行为

2. 对于关键宏调用，考虑添加#[rustfmt::skip]属性跳过格式化

3. 定期更新rustfmt版本，但更新后要进行全面测试

4. 对于团队项目，统一rustfmt版本以避免不同环境下的格式化差异

总结

代码格式化工具虽然能提高代码一致性，但也可能引入意外行为变更。开发者应当了解所用工具的限制，特别是对于宏这类复杂语法结构的处理。这个问题提醒我们，即使是官方工具，也需要谨慎使用并及时跟进版本更新。