Подтвердить что ты не робот

Swift JSONDecoder с несколькими форматами даты в строке JSON?

Swift JSONDecoder предлагает свойство dateDecodingStrategy, которое позволяет нам определить, как интерпретировать входящие строки даты в соответствии с объектом DateFormatter.

Однако в настоящее время я работаю с API, который возвращает строки даты (yyyy-MM-dd) и строки datetime (yyyy-MM-dd HH:mm:ss) в зависимости от свойства. Есть ли способ иметь JSONDecoder дескриптор this, поскольку предоставленный объект DateFormatter может обрабатывать только один dateFormat за раз?

Одно ham-handed решение состоит в том, чтобы переписать прилагаемые модели Decodable, чтобы просто принимать строки в качестве их свойств и предоставлять общедоступные переменные getter/setter Date, но это кажется мне плохим решением. Любые мысли?

4b9b3361

ОТВЕТЫ

Ответ 1

Есть несколько способов справиться с этим:

  • Вы можете создать подкласс DateFormatter, который сначала пытается создать формат строки даты, а затем, если он терпит неудачу, пытается создать простой формат даты
  • Вы можете дать стратегию декодирования .custom Date, в которой вы задаете Decoder для singleValueContainer(), декодируете строку и передаете ее через любые форматы, которые вы хотите, перед передачей даты синтаксического анализа
  • Вы можете создать обертку вокруг типа Date, которая предоставляет настраиваемые init(from:) и encode(to:), которые делают это (но это не лучше, чем стратегия .custom)
  • Вы можете использовать простые строки, поскольку вы предлагаете
  • Вы можете предоставить пользовательский init(from:) для всех типов, которые используют эти даты и предпринимают различные действия там

В целом, первые два метода, вероятно, будут самыми легкими и чистыми - вы будете повсеместно поддерживать синтезированную реализацию Codable по умолчанию, не жертвуя безопасностью типа.

Ответ 2

Попробуйте декодер, подобный этому:

lazy var decoder: JSONDecoder = {
    let decoder = JSONDecoder()
    decoder.dateDecodingStrategy = .custom({ (decoder) -> Date in
        let container = try decoder.singleValueContainer()
        let dateStr = try container.decode(String.self)
        // possible date strings: "2016-05-01",  "2016-07-04T17:37:21.119229Z", "2018-05-20T15:00:00Z"
        let len = dateStr.count
        var date: Date? = nil
        if len == 10 {
            date = dateNoTimeFormatter.date(from: dateStr)
        } else if len == 20 {
            date = isoDateFormatter.date(from: dateStr)
        } else {
            date = self.serverFullDateFormatter.date(from: dateStr)
        }
        guard let date_ = date else {
            throw DecodingError.dataCorruptedError(in: container, debugDescription: "Cannot decode date string \(dateStr)")
        }
        print("DATE DECODER \(dateStr) to \(date_)")
        return date_
    })
    return decoder
}()

Ответ 3

Опираясь на эту же проблему, я написал следующее расширение:

extension JSONDecoder.DateDecodingStrategy {
    static func custom(_ formatterForKey: @escaping (CodingKey) throws -> DateFormatter?) -> JSONDecoder.DateDecodingStrategy {
        return .custom({ (decoder) -> Date in
            guard let codingKey = decoder.codingPath.last else {
                throw DecodingError.dataCorrupted(DecodingError.Context(codingPath: decoder.codingPath, debugDescription: "No Coding Path Found"))
            }

            guard let container = try? decoder.singleValueContainer(),
                let text = try? container.decode(String.self) else {
                    throw DecodingError.dataCorrupted(DecodingError.Context(codingPath: decoder.codingPath, debugDescription: "Could not decode date text"))
            }

            guard let dateFormatter = try formatterForKey(codingKey) else {
                throw DecodingError.dataCorruptedError(in: container, debugDescription: "No date formatter for date text")
            }

            if let date = dateFormatter.date(from: text) {
                return date
            } else {
                throw DecodingError.dataCorruptedError(in: container, debugDescription: "Cannot decode date string \(text)")
            }
        })
    }
}

Это расширение позволяет вам создавать DateDecodingStrategy для JSONDecoder, который обрабатывает несколько разных форматов даты в одной и той же строке JSON. Расширение содержит функцию, которая требует реализации замыкания, которое дает вам CodingKey, и вам решать предоставить правильный DateFormatter для предоставленного ключа.

Предположим, что у вас есть следующий JSON:

{
    "publication_date": "2017-11-02",
    "opening_date": "2017-11-03",
    "date_updated": "2017-11-08 17:45:14"
}

Следующая структура:

struct ResponseDate: Codable {
    var publicationDate: Date
    var openingDate: Date?
    var dateUpdated: Date

    enum CodingKeys: String, CodingKey {
        case publicationDate = "publication_date"
        case openingDate = "opening_date"
        case dateUpdated = "date_updated"
    }
}

Затем, чтобы декодировать JSON, вы должны использовать следующий код:

let dateFormatterWithTime: DateFormatter = {
    let formatter = DateFormatter()

    formatter.dateFormat = "yyyy-MM-dd HH:mm:ss"

    return formatter
}()

let dateFormatterWithoutTime: DateFormatter = {
    let formatter = DateFormatter()

    formatter.dateFormat = "yyyy-MM-dd"

    return formatter
}()

let decoder = JSONDecoder()

decoder.dateDecodingStrategy = .custom({ (key) -> DateFormatter? in
    switch key {
    case ResponseDate.CodingKeys.publicationDate, ResponseDate.CodingKeys.openingDate:
        return dateFormatterWithoutTime
    default:
        return dateFormatterWithTime
    }
})

let results = try? decoder.decode(ResponseDate.self, from: data)

Ответ 4

попробуй это. (быстро 4)

let formatter = DateFormatter()

var decoder: JSONDecoder {
    let decoder = JSONDecoder()
    decoder.dateDecodingStrategy = .custom { decoder in
        let container = try decoder.singleValueContainer()
        let dateString = try container.decode(String.self)

        formatter.dateFormat = "yyyy-MM-dd HH:mm:ss"
        if let date = formatter.date(from: dateString) {
            return date
        }
        formatter.dateFormat = "yyyy-MM-dd"
        if let date = formatter.date(from: dateString) {
            return date
        }
        throw DecodingError.dataCorruptedError(in: container,
            debugDescription: "Cannot decode date string \(dateString)")
    }
    return decoder
}

Ответ 5

Невозможно сделать это с помощью одного кодера. Лучше всего настроить методы encode(to encoder:) и init(from decoder:) и предоставить собственный перевод для одного из этих значений, оставив встроенную стратегию даты для другой.

Возможно, стоит обратить внимание на передачу одного или нескольких форматировщиков в объект userInfo для этой цели.

Ответ 6

Если у вас есть несколько дат с разными форматами в одной модели, трудно применить .dateDecodingStrategy для каждой даты.

Проверьте здесь https://gist.github.com/romanroibu/089ec641757604bf78a390654c437cb0 для удобного решения

Ответ 7

Это немного многословный, но более гибкий подход: обернуть дату другим классом Date и реализовать для него настраиваемые методы сериализации. Например:

let dateFormatter = DateFormatter()
dateFormatter.dateFormat = "yyyy-MM-dd"

class MyCustomDate: Codable {
    var date: Date

    required init?(_ date: Date?) {
        if let date = date {
            self.date = date
        } else {
            return nil
        }
    }

    public func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        let string = dateFormatter.string(from: date)
        try container.encode(string)
    }

    required public init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        let raw = try container.decode(String.self)
        if let date = dateFormatter.date(from: raw) {
            self.date = date
        } else {
            throw DecodingError.dataCorruptedError(in: container, debugDescription: "Cannot parse date")
        }
    }
}

Так что теперь вы независимы от .dateDecodingStrategy и .dateEncodingStrategy и ваши даты MyCustomDate будут проанализированы в указанном формате. Используйте это в классе:

class User: Codable {
    var dob: MyCustomDate
}

Создать с

user.dob = MyCustomDate(date)

Ответ 8

Swift 5

На самом деле основано на версии @BrownsooHan с использованием расширения JSONDecoder

JSONDecoder + dateDecodingStrategyFormatters.swift

extension JSONDecoder {

    /// Assign multiple DateFormatter to dateDecodingStrategy
    ///
    /// Usage :
    ///
    ///      decoder.dateDecodingStrategyFormatters = [ DateFormatter.standard, DateFormatter.yearMonthDay ]
    ///
    /// The decoder will now be able to decode two DateFormat, the 'standard' one and the 'yearMonthDay'
    ///
    /// Throws a 'DecodingError.dataCorruptedError' if an unsupported date format is found while parsing the document
    var dateDecodingStrategyFormatters: [DateFormatter]? {
        @available(*, unavailable, message: "This variable is meant to be set only")
        get { return nil }
        set {
            guard let formatters = newValue else { return }
            self.dateDecodingStrategy = .custom { decoder in

                let container = try decoder.singleValueContainer()
                let dateString = try container.decode(String.self)

                for formatter in formatters {
                    if let date = formatter.date(from: dateString) {
                        return date
                    }
                }

                throw DecodingError.dataCorruptedError(in: container, debugDescription: "Cannot decode date string \(dateString)")
            }
        }
    }
}

Это немного хакерский способ добавить переменную, которую можно только установить, но вы можете легко преобразовать var dateDecodingStrategyFormatters помощью func setDateDecodingStrategyFormatters(_ formatters: [DateFormatter]? )

использование

допустим, вы уже определили несколько DateFormatter в своем коде, например, так:

extension DateFormatter {
    static let standardT: DateFormatter = {
        var dateFormatter = DateFormatter()
        dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss"
        return dateFormatter
    }()

    static let standard: DateFormatter = {
        var dateFormatter = DateFormatter()
        dateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss"
        return dateFormatter
    }()

    static let yearMonthDay: DateFormatter = {
        var dateFormatter = DateFormatter()
        dateFormatter.dateFormat = "yyyy-MM-dd"
        return dateFormatter
    }()
}

теперь вы можете сразу назначить их декодеру, установив dateDecodingStrategyFormatters:

// Data structure
struct Dates: Codable {
    var date1: Date
    var date2: Date
    var date3: Date
}

// The Json to decode 
let jsonData = """
{
    "date1": "2019-05-30 15:18:00",
    "date2": "2019-05-30T05:18:00",
    "date3": "2019-04-17"
}
""".data(using: .utf8)!

// Assigning mutliple DateFormatters
let decoder = JSONDecoder()
decoder.dateDecodingStrategyFormatters = [ DateFormatter.standardT,
                                           DateFormatter.standard,
                                           DateFormatter.yearMonthDay ]


do {
    let dates = try decoder.decode(Dates.self, from: jsonData)
    print(dates)
} catch let err as DecodingError {
    print(err.localizedDescription)
}

Sidenotes

Еще раз, я знаю, что установка dateDecodingStrategyFormatters в качестве var немного хакерская, и я не рекомендую это dateDecodingStrategyFormatters вместо этого вы должны определить функцию. Однако это личное предпочтение.