如何为Swift的JSONEncoder设置自定义元素顺序？

当然可以自定义JSON元素的输出顺序！虽然JSON规范本身不要求键的顺序，但在单元测试这类需要稳定输出的场景下，确实有办法让JSONEncoder严格按照你想要的顺序生成键值对，而且完全不需要依赖iOS 11+的.sortedKeys选项。

核心思路：手动实现encode(to:)方法 #

默认情况下，JSONEncoder会使用自动合成的编码逻辑，而这个逻辑依赖于Swift字典的哈希表实现（本身是无序的），所以输出顺序会不可预测。要控制顺序，我们需要手动接管编码过程，按指定顺序向编码容器中添加键值对。

举个例子，假设你的Encodable类型是这样的：

struct APIResponse: Encodable {
    let id: Int
    let message: String?
    let error: String?
    
    // 显式定义CodingKeys，方便手动编码时引用
    enum CodingKeys: String, CodingKey {
        case id, message, error
    }
}

现在我们手动实现encode(to:)方法，严格按照id → message → error的顺序编码：

extension APIResponse {
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        
        // 按你想要的顺序依次添加键值对
        try container.encode(id, forKey: .id)
        try container.encodeIfPresent(message, forKey: .message)
        try container.encodeIfPresent(error, forKey: .error)
    }
}

这样处理后，无论你什么时候编码这个类型，输出的JSON键顺序都会和你手动添加的顺序完全一致，完美适配单元测试的字符串对比需求。

额外提示 #

• 如果你的项目中有多个需要控制顺序的Encodable类型，可以考虑封装一个通用的编码工具类，或者用协议扩展来复用逻辑，但对于单个类型来说，直接手动实现encode(to:)是最简洁高效的方式。
• 这种方法完全兼容iOS 11以下的系统，不需要依赖任何高版本API。

内容的提问来源于stack exchange，提问作者Kevin Schildhorn