ios里带下划线的json怎么处理

iOS中处理带下划线的JSON：从解析到优雅适配

在iOS开发中,JSON数据解析是日常开发的基础操作，当我们对接的API返回的JSON键名使用下划线命名风格（如user_name、create_time）时，Swift的强类型特性往往会带来适配困扰——Swift推荐使用驼峰命名法（userName、createTime），直接解析会导致属性映射失败，本文将系统介绍iOS中处理带下划线JSON的方法，从原生解析到第三方库适配，助你优雅解决命名风格冲突问题。

为什么带下划线的JSON需要特殊处理？

Swift的Codable协议默认要求JSON键名与Swift结构体/类的属性名完全匹配（区分大小写），当JSON键名为first_name，而Swift属性定义为firstName时，直接解析会得到nil值，导致数据丢失。

{
  "user_id": 1001,
  "user_name": "张三",
  "create_time": "2023-10-01 12:00:00"
}

对应的Swift结构体若直接定义：

struct User: Codable {
    let userId: Int
    let userName: String
    let createTime: String
}

解析时会发现所有属性均为nil，因为user_id≠userId、user_name≠userName，必须通过特定方式建立JSON下划线命名与Swift驼峰命名的映射关系。

原生Codable方案：手动映射与KeyDecodingStrategy

苹果在Codable中提供了KeyDecodingStrategy（键解码策略），支持自定义JSON键名与Swift属性的映射逻辑，以下是两种原生处理方式：

使用`CodingKeys`手动映射

通过在结构体/类中定义CodingKeys枚举，显式指定JSON键名与Swift属性的对应关系，这是最直接的控制方式，适合少量属性或复杂命名场景：

struct User: Codable {
    let userId: Int
    let userName: String
    let createTime: String
    // 定义CodingKeys建立映射
    enum CodingKeys: String, CodingKey {
        case userId = "user_id"       // JSON的"user_id"映射到Swift的"userId"
        case userName = "user_name"   // JSON的"user_name"映射到Swift的"userName"
        case createTime = "create_time" // JSON的"create_time"映射到Swift的"createTime"
    }
}

解析示例：

let json = """
{"user_id": 1001, "user_name": "张三", "create_time": "2023-10-01 12:00:00"}
""".data(using: .utf8)!
do {
    let user = try JSONDecoder().decode(User.self, from: json)
    print(user.userId)    // 输出: 1001
    print(user.userName)  // 输出: "张三"
    print(user.createTime) // 输出: "2023-10-01 12:00:00"
} catch {
    print("解析失败: \(error)")
}

优点：

精确控制每个属性的映射关系,适合特殊命名场景（如非标准的下划线变体）。
无需额外依赖,基于原生Codable实现。

缺点：

当属性较多时,CodingKeys枚举会变得冗长，增加代码量。

全局配置`KeyDecodingStrategy`（推荐批量处理）

如果项目中所有JSON均采用下划线命名,可通过JSONDecoder的keyDecodingStrategy属性统一配置，自动将下划线命名转换为驼峰命名，无需手动定义CodingKeys：

// 全局配置（建议在应用启动时设置，如AppDelegate或SceneDelegate）
let decoder = JSONDecoder()
decoder.keyDecodingStrategy = .convertFromSnakeCase // 自动将下划线转为驼峰
// 解码时直接使用
let user = try decoder.decode(User.self, from: json)

原理：
.convertFromSnakeCase策略会自动执行以下转换：

将下划线后的首字母大写,并移除下划线（如user_name→userName）。
处理连续下划线（如__id__→Id）或数字开头的情况（如_2name→_2Name）。

注意：

此策略仅适用于“下划线转驼峰”的标准场景，若存在非标准命名（如user-name或user name），仍需手动通过CodingKeys处理。
对于已存在CodingKeys的类型，.convertFromSnakeCase会被忽略，仍以手动映射为准。

第三方库方案：简化映射逻辑

当项目复杂度高或需要更灵活的命名处理时,第三方库能提供更简洁的解决方案，以下是iOS开发中常用的JSON解析库及其处理下划线的方式：

HandyJSON

HandyJSON是阿里巴巴开源的JSON库,支持动态映射和自定义转换策略，无需实现Codable协议，通过属性标记即可完成映射：

import HandyJSON
struct User: HandyJSON {
    var userId: Int = 0              // 自动匹配"user_id"
    var userName: String = ""        // 自动匹配"user_name"
    var createTime: String = ""      // 自动匹配"create_time"
}
// 解码
let user = User.deserialize(from: jsonDict) // jsonDict为[String: Any]类型
print(user?.userId) // 输出: 1001

优点：

无需定义CodingKeys，属性名自动匹配JSON键名（支持下划线转驼峰）。
支持动态解析,适合接口字段多变或需要运行时映射的场景。

缺点：

依赖第三方库,需添加CocoaPods或Swift Package Manager依赖。
类型安全性弱于Codable，编译期无法检查属性映射是否正确。

Moya + ObjectMapper

若项目中已使用Moya（网络请求库）和ObjectMapper（JSON映射库），可通过ObjectMapper的mapping方法处理下划线命名：

import ObjectMapper
struct User: Mappable {
    var userId: Int!
    var userName: String!
    var createTime: String!
    init?(map: Map) {}
    mutating func mapping(map: Map) {
        userId <- map["user_id"]       // 显式映射
        userName <- map["user_name"]
        createTime <- map["create_time"]
    }
}

优点：

与Moya深度集成,适合已采用该库的项目。
支持嵌套对象、数组等复杂结构的映射。

缺点：

需要手动定义mapping方法，与HandyJSON的自动映射相比稍显繁琐。

最佳实践：如何选择处理方式？

面对带下划线的JSON,选择哪种处理方式需结合项目实际需求：

场景	推荐方案	原因
新项目、纯Swift开发	原生`Codable` + `.convertFromSnakeCase`	无依赖、类型安全，苹果官方支持，适合标准化命名转换。
少量特殊命名属性	原生`Codable` + `CodingKeys`手动映射	精确控制非标准场景，避免全局策略干扰。
老项目/复杂JSON结构	HandyJSON或ObjectMapper	简化映射逻辑，支持动态解析，减少手动编码量。
已有Moya网络层	Moya + ObjectMapper	库间集成顺畅，统一网络与解析层的处理方式。

注意事项

大小写敏感：
无论是CodingKeys还是KeyDecodingStrategy，均区分大小写，例如User_ID不会自动匹配到userId，需手动处理。
嵌套结构处理：
若JSON包含嵌套对象（如{ "user_info": { "user_name": "张三" } }），需在嵌套类型的CodingKeys中继续定义映射关系，或通过keyPath指定路径。
性能优化：
全局配置KeyDecodingStrategy比逐个定义CodingKeys性能更优，后者需为每个类型创建枚举实例，而全局策略在解码时统一处理，减少重复逻辑。
调试技巧：
若解析失败，可通过JSONSerialization将JSON转为字典打印，确认键名是否符合预期；或使用JSONDecoder的userInfo传递调试信息，捕获具体错误。

处理iOS中的带下划线JSON,核心在于解决“JSON命名风格”与“Swift命名规范”的冲突

正文