Swift Codable: как кодировать данные верхнего уровня во вложенный контейнер

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

{
    "result":"OK",
    "data":{

        // Common to all URLs
        "user": {
            "name":"John Smith" // ETC...
        },

        // Different for each URL
        "data_for_this_url":0
    }
}

Как видите, информация, относящаяся к URL, существует в том же словаре, что и общий словарь user.

ЦЕЛЬ:

  1. Decode this JSON into classes/structs.
    • Because user is common, I want this to be in the top-level class/struct.
  2. Encode to new format (e.g. plist).
    • I need to preserve the original structure. (i.e. recreate the data dictionary from top-level user info and child object's info)

ПРОБЛЕМА:

При перекодировании данных я не могу записать в кодировщик как словарь user (из объекта верхнего уровня), так и данные, относящиеся к URL-адресу (из дочернего объекта).

Либо user перезаписывает другие данные, либо другие данные перезаписывают user. Я не знаю, как их совместить.

Вот что у меня есть до сих пор:

// MARK: - Common User
struct User: Codable {
    var name: String?
}

// MARK: - Abstract Response
struct ApiResponse<DataType: Codable>: Codable {
    // MARK: Properties
    var result: String
    var user: User?
    var data: DataType?

    // MARK: Coding Keys
    enum CodingKeys: String, CodingKey {
        case result, data
    }
    enum DataDictKeys: String, CodingKey {
        case user
    }

    // MARK: Decodable
    init(from decoder: Decoder) throws {
        let baseContainer = try decoder.container(keyedBy: CodingKeys.self)
        self.result = try baseContainer.decode(String.self, forKey: .result)
        self.data = try baseContainer.decodeIfPresent(DataType.self, forKey: .data)

        let dataContainer = try baseContainer.nestedContainer(keyedBy: DataDictKeys.self, forKey: .data)
        self.user = try dataContainer.decodeIfPresent(User.self, forKey: .user)
    }

    // MARK: Encodable
    func encode(to encoder: Encoder) throws {
        var baseContainer = encoder.container(keyedBy: CodingKeys.self)
        try baseContainer.encode(self.result, forKey: .result)

        // MARK: - PROBLEM!!

        // This is overwritten
        try baseContainer.encodeIfPresent(self.data, forKey: .data)

        // This overwrites the previous statement
        var dataContainer = baseContainer.nestedContainer(keyedBy: DataDictKeys.self, forKey: .data)
        try dataContainer.encodeIfPresent(self.user, forKey: .user)
    }
}

ПРИМЕР:

В приведенном ниже примере перекодированный plist не включает order_count, так как он был перезаписан словарем, содержащим user.

// MARK: - Concrete Response
typealias OrderDataResponse = ApiResponse<OrderData>

struct OrderData: Codable {
    var orderCount: Int = 0
    enum CodingKeys: String, CodingKey {
        case orderCount = "order_count"
    }
}


let orderDataResponseJson = """
{
    "result":"OK",
    "data":{
        "user":{
            "name":"John"
        },
        "order_count":10
    }
}
"""

// MARK: - Decode from JSON
let jsonData = orderDataResponseJson.data(using: .utf8)!
let response = try JSONDecoder().decode(OrderDataResponse.self, from: jsonData)

// MARK: - Encode to PropertyList
let plistEncoder = PropertyListEncoder()
plistEncoder.outputFormat = .xml

let plistData = try plistEncoder.encode(response)
let plistString = String(data: plistData, encoding: .utf8)!

print(plistString)

// 'order_count' is not included in 'data'!

/*
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>data</key>
    <dict>
        <key>user</key>
        <dict>
            <key>name</key>
            <string>John</string>
        </dict>
    </dict>
    <key>result</key>
    <string>OK</string>
</dict>
</plist>
*/

person ABeard89    schedule 22.05.2018    source источник
comment
Вы не должны изменять структуру данных в первую очередь. Не должно быть проблемой, если все ваши ответы содержат одинаковые результаты. Определите свои структуры в соответствии со структурой JSON. Вы сможете легко кодировать-декодировать их.   -  person nayem    schedule 22.05.2018
comment
Я даже согласен с тобой. Я, вероятно, в конечном итоге сделать это в любом случае. Но пока я просто хочу знать, можно ли это сделать.   -  person ABeard89    schedule 22.05.2018
comment
Кроме того, отработка странных случаев, подобных этому, может помочь углубить мое понимание технологии, что всегда является моей целью.   -  person ABeard89    schedule 22.05.2018


Ответы (2)


У меня только что было озарение, когда я просматривал протоколы кодировщика.

Метод KeyedEncodingContainerProtocol.superEncoder(forKey:) предназначен именно для таких ситуаций.

Этот метод возвращает отдельный Encoder, который может собирать несколько элементов и/или вложенных контейнеров, а затем кодировать их в один ключ.

В этом конкретном случае данные верхнего уровня user можно закодировать, просто вызвав собственный метод encode(to:) с новым superEncoder. Затем с помощью кодировщика также можно создать вложенные контейнеры, которые будут использоваться как обычно.

Решение вопроса

// MARK: - Encodable
func encode(to encoder: Encoder) throws {

    var baseContainer = encoder.container(keyedBy: CodingKeys.self)
    try baseContainer.encode(self.result, forKey: .result)

    // MARK: - PROBLEM!!
//    // This is overwritten
//    try baseContainer.encodeIfPresent(self.data, forKey: .data)
//
//    // This overwrites the previous statement
//    var dataContainer = baseContainer.nestedContainer(keyedBy: DataDictKeys.self, forKey: .data)
//    try dataContainer.encodeIfPresent(self.user, forKey: .user)

    // MARK: - Solution
    // Create a new Encoder instance to combine data from separate sources.
    let dataEncoder = baseContainer.superEncoder(forKey: .data)

    // Use the Encoder directly:
    try self.data?.encode(to: dataEncoder)

    // Create containers for manually encoding, as usual:
    var userContainer = dataEncoder.container(keyedBy: DataDictKeys.self)
    try userContainer.encodeIfPresent(self.user, forKey: .user)
}

Выход:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>data</key>
    <dict>
        <key>order_count</key>
        <integer>10</integer>
        <key>user</key>
        <dict>
            <key>name</key>
            <string>John</string>
        </dict>
    </dict>
    <key>result</key>
    <string>OK</string>
</dict>
</plist>
person ABeard89    schedule 24.05.2018

Отличный вопрос и решение, но если вы хотите упростить его, вы можете использовать KeyedCodable, который я написал. Вся реализация вашего Codable будет выглядеть так (OrderData и User, конечно, остаются прежними):

struct ApiResponse<DataType: Codable>: Codable {
  // MARK: Properties
  var result: String!
  var user: User?
  var data: DataType?

  enum CodingKeys: String, KeyedKey {
    case result
    case user = "data.user"
    case data
  }

}

person decybel    schedule 27.05.2018
comment
Вы продемонстрировали способность декодирования вашей библиотеки. Но вопрос был именно об обращении этого процесса вспять. Может ли ваша библиотека перекодировать данные в исходную структуру? Если да, можете привести пример? - person ABeard89; 28.05.2018
comment
Я понимаю. Вы реализовали Encodable через расширение протокола, чего нельзя сделать для init методов. Вопрос в основном касался стандартного способа Codable, но я буду иметь это в виду. Определенно кажется полезной библиотекой. Хорошая работа. - person ABeard89; 28.05.2018
comment
Я также думаю, что методы Apple .nestedContainer слишком сложны в использовании, спасибо за вашу библиотеку - именно то, что я искал! Я не понимаю, почему кто-то проголосовал за вас, я поставил вам большой палец вверх! Продолжайте хорошую работу! - person smat88dd; 08.07.2021