Swift Codable — как инициализировать необязательное свойство Enum с ошибкой

Я думаю, что у меня была похожая проблема с вашей, если я правильно понимаю. В моем случае я написал обертку для каждого рассматриваемого перечисления:

struct NilOnFail<T>: Decodable where T: Decodable {

    let value: T?

    init(from decoder: Decoder) throws {
        self.value = try? T(from: decoder) // Fail silently
    }

    // TODO: implement Encodable
}

Затем используйте его следующим образом:

class MyClass: Codable {

    enum Company: Int {
        case toyota = 1
        case ford
        case gm
    } 

    var company: NilOnFail<Company>
...

Предостережение, конечно, заключается в том, что везде, где вам нужно получить доступ к значению company, вам нужно использовать myClassInstance.company.value

Изучив документацию по протоколам Decoder и Decodable и конкретному классу JSONDecoder, я понял, что нет способа добиться именно того, что я искал. Ближе всего просто реализовать init(from decoder: Decoder) и выполнить все необходимые проверки и преобразования вручную.

Дополнительные мысли

Поразмыслив над проблемой, я обнаружил несколько проблем с моим текущим дизайном: во-первых, отображение значения 0 в ответе JSON на nil кажется неправильным.

Несмотря на то, что значение 0 имеет конкретное значение «неопределенное» на стороне API, форсируя отказоустойчивое init?(rawValue:), я, по сути, объединяю все недопустимые значения вместе. Если из-за какой-то внутренней ошибки или ошибки сервер вернет (скажем) -7, мой код не сможет это обнаружить и молча сопоставит его с nil, как если бы это был назначенный 0.

Поэтому я думаю, что правильный дизайн будет следующим:

1. Отказаться от необязательности для свойства company и определить enum следующим образом:

   enum Company: Int {
      case unspecified = 0
      case toyota
      case ford
      case gm
   }
   

   ... точно соответствует JSON или,

2. Сохраните необязательность, но пусть API возвращает JSON, в котором отсутствует значение для ключа «компания» (так что сохраненное свойство Swift сохраняет свое начальное значение nil) вместо возврата 0 (я полагаю, что JSON делает имеют "нулевое" значение, но я не уверен, как JSONDecoder с этим справляется)

Первый вариант требует изменения большого количества кода во всем приложении (изменение вхождений if let... на сравнения с .unspecified).

Второй вариант требует изменения серверного API, что мне неподвластно (и приведет к проблеме миграции/обратной совместимости между серверной и клиентской версиями).

Я думаю, что пока буду придерживаться своего обходного пути и, возможно, когда-нибудь в будущем приму вариант № 1...

Я знаю, что мой ответ запоздал, но, возможно, это поможет кому-то еще.

У меня также были перечисления StringOptional, но если бы я получил от бэкэнда новое значение, которое не было включено в локальное перечисление, json не проанализировался бы, даже если перечисление было необязательным.

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

struct DetailView: Codable {

var title: ExtraInfo?
var message: ExtraInfo?
var action: ExtraInfo?
var imageUrl: String?

// 1
private var imagePositionRaw: String?
private var alignmentRaw: String?

// 2
var imagePosition: ImagePosition {
    ImagePosition.init(optionalRawValue: imagePositionRaw) ?? .top
}

// 3
var alignment: AlignmentType? {
    AlignmentType.init(optionalRawValue: alignmentRaw)
}

enum CodingKeys: String, CodingKey {
    case imagePositionRaw = "imagePosition",
         alignmentRaw = "alignment",
         imageUrl,
         title,
         message,
         action
}

}

(1) Вы получаете значения из бэкэнда как необработанные (строка, int - все, что вам нужно), и вы инициализируете свои перечисления из этих необработанных значений (2,3).

Если значение из бэкенда равно нулю или отличается от ожидаемого, вы возвращаете ноль (3) или значение по умолчанию (2).

--- отредактируйте, чтобы добавить расширение, используемое для инициализации перечисления:

extension RawRepresentable {
  init?(optionalRawValue: RawValue?) {
    guard let rawData = optionalRawValue else { return nil }
    self.init(rawValue: rawData)
  }
}

Вы можете попробовать SafeDecoder.

import SafeDecoder

class MyClass: Codable {

  enum Company: Int {
    case toyota = 1
    case ford
    case gm
  }
  var company: Company?
}

Тогда просто расшифруйте как необычное. Любое значение, отличное от 1,2,3, автоматически возвращается к нулю.

Спасибо за подробный вопрос и ответ. Вы заставили меня переосмыслить мой подход к декодированию JSON. Имела аналогичную проблему и решила декодировать значение JSON в Int, а не добавлять логику к тому, что должно было быть DTO. После этого добавление расширения модели для преобразования значения в перечисление не имеет значения с точки зрения использования перечисления, но выглядит более чистым решением.