Swift结构:为单个属性处理多种类型

时间:2017-10-15 19:21:06

标签: json swift data-structures swift4 swift-structs

我正在使用Swift 4并尝试解析一些JSON数据,显然在某些情况下可以为同一个键设置不同的类型值,例如:

{
    "type": 0.0
}

{
    "type": "12.44591406"
}

我实际上坚持定义我的struct,因为我无法弄清楚如何处理这种情况,因为

struct ItemRaw: Codable {
    let parentType: String

    enum CodingKeys: String, CodingKey {
        case parentType = "type"
    }
}

抛出"Expected to decode String but found a number instead.",当然,

struct ItemRaw: Codable {
    let parentType: Float

    enum CodingKeys: String, CodingKey {
        case parentType = "type"
    }
}

相应地抛出"Expected to decode Float but found a string/data instead."

在定义struct时如何处理此(及类似)案例?

3 个答案:

答案 0 :(得分:6)

我在尝试解码/编码"编辑过的#34;时遇到了同样的问题。 Reddit列表JSON响应的字段。我创建了一个结构,表示给定键可能存在的动态类型。键可以有布尔值或整数。

{ "edited": false }
{ "edited": 123456 }

如果您只需要能够解码,只需实现init(from :)。如果您需要双向进行,则需要实现encode(to :)函数。

struct Edited: Codable {
    let isEdited: Bool
    let editedTime: Int

    // Where we determine what type the value is
    init(from decoder: Decoder) throws {
        let container =  try decoder.singleValueContainer()

        // Check for a boolean
        do {
            isEdited = try container.decode(Bool.self)
            editedTime = 0
        } catch {
            // Check for an integer
            editedTime = try container.decode(Int.self)
            isEdited = true
        }
    }

    // We need to go back to a dynamic type, so based on the data we have stored, encode to the proper type
    func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        try isEdited ? container.encode(editedTime) : container.encode(false)
    }
}

在我的Codable类中,然后我使用我的结构。

struct Listing: Codable {
    let edited: Edited
}

编辑:针对您的方案的更具体的解决方案

我建议使用CodingKey协议和枚举来解码时存储所有属性。当您创建符合Codable的内容时,编译器将为您创建一个私有枚举CodingKeys。这使您可以根据JSON对象属性键决定要执行的操作。

例如,这是我正在解码的JSON:

{"type": "1.234"}
{"type": 1.234}

如果你想从String转换为Double,因为你只需要double值,只需解码字符串然后从中创建一个double。 (这是Itai Ferber正在做的事情,你必须使用try decoder.decode解码所有属性(类型:forKey :))

struct JSONObjectCasted: Codable {
    let type: Double?

    init(from decoder: Decoder) throws {
        // Decode all fields and store them
        let container = try decoder.container(keyedBy: CodingKeys.self) // The compiler creates coding keys for each property, so as long as the keys are the same as the property names, we don't need to define our own enum.

        // First check for a Double
        do {
            type = try container.decode(Double.self, forKey: .type)

        } catch {
            // The check for a String and then cast it, this will throw if decoding fails
            if let typeValue = Double(try container.decode(String.self, forKey: .type)) {
                type = typeValue
            } else {
                // You may want to throw here if you don't want to default the value(in the case that it you can't have an optional).
                type = nil
            }
        }

        // Perform other decoding for other properties.
    }
}

如果需要将类型与值一起存储,则可以使用符合Codable而不是struct的枚举。然后你可以使用带有"类型"的switch语句。 JSONObjectCustomEnum的属性,并根据大小写执行操作。

struct JSONObjectCustomEnum: Codable {
    let type: DynamicJSONProperty
}

// Where I can represent all the types that the JSON property can be. 
enum DynamicJSONProperty: Codable {
    case double(Double)
    case string(String)

    init(from decoder: Decoder) throws {
        let container =  try decoder.singleValueContainer()

        // Decode the double
        do {
            let doubleVal = try container.decode(Double.self)
            self = .double(doubleVal)
        } catch DecodingError.typeMismatch {
            // Decode the string
            let stringVal = try container.decode(String.self)
            self = .string(stringVal)
        }
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        switch self {
        case .double(let value):
            try container.encode(value)
        case .string(let value):
            try container.encode(value)
        }
    }
}

答案 1 :(得分:5)

一个简单的解决方案是提供init(from:)的实现,它尝试将值解析为String,如果由于类型错误而失败,请尝试解码为Double }:

public init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    do {
        self.parentType = try container.decode(String.self, forKey: .parentType)
    } catch DecodingError.typeMismatch {
        let value = try container.decode(Double.self, forKey: .parentType)
        self.parentType = "\(value)"
    }
}

答案 2 :(得分:1)

我必须解码作为字符串给出的PHP/MySQL/PDO双精度值,在这种情况下,我必须扩展KeyedDecodingContainer,就像这样:

extension KeyedDecodingContainer {
    func decode(forKey key: KeyedDecodingContainer.Key) throws -> Double {
        do {
            let str = try self.decode(String.self, forKey: key)
            if let dbl = Double(str) {
                return dbl
            }
        } catch DecodingError.typeMismatch {
            return try self.decode(Double.self, forKey: key)
        }
        let context = DecodingError.Context(codingPath: self.codingPath,
                                            debugDescription: "Wrong Money Value")
        throw DecodingError.typeMismatch(Double.self, context)
    }
}

用法:

let data = """
{"value":"1.2"}
""".data(using: .utf8)!

struct Test: Decodable {
    let value: Double
    enum CodingKeys: String, CodingKey {
        case value
    }
    init(from decoder: Decoder) throws {
        self.value = try decoder.container(keyedBy: CodingKeys.self)
                                .decode(forKey: CodingKeys.value)
    }
}
try JSONDecoder().decode(Test.self, from: data).value