Ansible模块开发中整数键JSON序列化问题的分析与解决

在Ansible 2.19版本开发过程中，社区发现了一个关于模块返回值中整数键JSON序列化的重要变更。这个问题最初在community.clickhouse集合的测试中被发现，表现为模块执行失败并返回错误信息："Key of type 'int' is not JSON serializable by the 'module_legacy_m2c' profile"。

问题背景

在Python中，JSON序列化处理字典键时有特殊规则。当字典键为整数类型时，Python的json模块会隐式将其转换为字符串类型。例如：

import json
print(json.dumps({1: 2}))  # 输出: {"1": 2}

Ansible 2.19版本引入了新的序列化配置文件(profile)系统，这套系统对数据类型转换采取了更严格的策略。新系统不再自动执行这种隐式转换，而是直接抛出错误，提醒开发者注意数据类型问题。

问题分析

问题的根源在于模块代码中直接使用整数作为字典键，例如：

result['shards'][shard_num] = {
    'replicas': replicas,
    'replica_count': len(replicas)
}

在旧版Ansible中，这种写法能够正常工作，因为底层JSON序列化会自动处理整数键的转换。但在2.19版本中，新的序列化配置文件要求开发者必须显式处理这种类型转换。

解决方案

针对这个问题，开发者有两种解决途径：

1. 模块代码修改：在模块内部显式将整数键转换为字符串

result['shards'][str(shard_num)] = {  # 显式转换
    'replicas': replicas,
    'replica_count': len(replicas)
}

2. 序列化配置文件调整：修改Ansible核心代码，使序列化配置文件恢复旧版行为

第一种方案更为推荐，因为它：

• 使代码行为更明确
• 不依赖Ansible核心的特殊处理
• 提高代码的可维护性和可移植性

对开发者的建议

1. 在开发Ansible模块时，应避免直接使用非字符串类型作为字典键
2. 对于需要返回给控制器的数据结构，建议预先进行类型检查和处理
3. 在模块测试中，应包含对返回值数据类型的验证

这个变更体现了Ansible向更严格、更明确的数据处理方向发展。虽然短期内可能需要一些适配工作，但从长远看，这种改变有助于提高代码质量和减少隐式行为带来的潜在问题。

对于集合维护者来说，在升级到Ansible 2.19时，应当检查模块中所有可能返回字典的地方，确保键的类型符合JSON规范，或者进行适当的显式转换。