Как согласовать UIImage с Codable?

Swift 4 имеет Codable, и это потрясающе. Но UIImage не соответствует ему по умолчанию. Как мы можем это сделать?

Я пробовал с singleValueContainer и unkeyedContainer

extension UIImage: Codable {
  // 'required' initializer must be declared directly in class 'UIImage' (not in an extension)
  public required init(from decoder: Decoder) throws {
    let container = try decoder.singleValueContainer()
    let data = try container.decode(Data.self)
    guard let image = UIImage(data: data) else {
      throw MyError.decodingFailed
    }

    // A non-failable initializer cannot delegate to failable initializer 'init(data:)' written with 'init?'
    self.init(data: data)
  }

  public func encode(to encoder: Encoder) throws {
    var container = encoder.singleValueContainer()
    guard let data = UIImagePNGRepresentation(self) else {
      return
    }

    try container.encode(data)
  }
}

Я получаю 2 ошибки

'required' initializer должен быть объявлен непосредственно в классе 'UIImage' (не в расширении)
Инициализатор без отказов не может делегировать инициализатору инициализатора init (data:) ', написанный с помощью' init? '

Обходной путь заключается в использовании обертки. Но есть ли другие способы?

Ответ 1

Решение: сверните свой собственный класс оболочки, соответствующий Codable.

Одно из решений, поскольку расширения для UIImage отсутствуют, - это обернуть изображение в новый собственный класс. В противном случае ваша попытка в основном прямая. Я видел, что это прекрасно сделано в среде кэширования Hyper Interactive, которая называется, ну, в общем, Cache.

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

let wrapper = ImageWrapper(image: starIconImage)
try? theCache.setObject(wrapper, forKey: "star")

let iconWrapper = try? theCache.object(ofType: ImageWrapper.self, forKey: "star")
let icon = iconWrapper.image

Вот их класс оболочки:

// Swift 4.0
public struct ImageWrapper: Codable {
  public let image: Image

  public enum CodingKeys: String, CodingKey {
    case image
  }

  // Image is a standard UI/NSImage conditional typealias
  public init(image: Image) {
    self.image = image
  }

  public init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    let data = try container.decode(Data.self, forKey: CodingKeys.image)
    guard let image = Image(data: data) else {
      throw StorageError.decodingFailed
    }

    self.image = image
  }

  // cache_toData() wraps UIImagePNG/JPEGRepresentation around some conditional logic with some whipped cream and sprinkles.
  public func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    guard let data = image.cache_toData() else {
        throw StorageError.encodingFailed
    }

    try container.encode(data, forKey: CodingKeys.image)
  }
}

Я хотел бы услышать, что вы в конечном итоге используете.

ОБНОВЛЕНИЕ: оказывается, что OP написал код, на который я ссылался (обновление Swift 4.0 для Cache), чтобы решить эту проблему. Конечно, код заслуживает того, чтобы быть здесь, но я также оставлю свои слова неотредактированными для драматической иронии всего этого. :)

Ответ 2

Вы можете использовать очень элегантное решение, используя расширение для KeyedDecodingContainer и KeyedEncodingContainer:

enum ImageEncodingQuality: CGFloat {
    case png = 0
    case jpegLow = 0.2
    case jpegMid = 0.5
    case jpegHigh = 0.75
}

extension KeyedEncodingContainer {

    mutating func encode(_ value: UIImage,
                         forKey key: KeyedEncodingContainer.Key,
                         quality: ImageEncodingQuality = .png) throws {
        var imageData: Data!
        if quality == .png {
            imageData = value.pngData()
        } else {
            imageData = value.jpegData(compressionQuality: quality.rawValue)
        }
        try encode(imageData, forKey: key)
    }

}

extension KeyedDecodingContainer {

    public func decode(_ type: UIImage.Type, forKey key: KeyedDecodingContainer.Key) throws -> UIImage {
        let imageData = try decode(Data.self, forKey: key)
        if let image = UIImage(data: imageData) {
            return image
        } else {
            throw SDKError.imageConversionError
        }
    }

}

Вот пример использования:

class DocumentScan: Codable {

    private enum CodingKeys: String, CodingKey {
        case scanDate
        case image
    }

    let scanDate: Date
    let image: UIImage

    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        scanDate = try container.decode(Date.self, forKey: .scanDate)
        image = try container.decode(UIImage.self, forKey: .image)
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(scanDate, forKey: .scanDate)
        try container.encode(image, forKey: .image, quality: .png)
    }
}

PS: Вы можете использовать такой способ принятия Codable для любого типа класса

Ответ 3

Один из способов передать UIImage - преобразовать его в нечто, соответствующее Codable, например String.

Чтобы преобразовать UIImage в строку внутри func encode(to encoder: Encoder) throws:

let imageData: Data = UIImagePNGRepresentation(image)!
let strBase64 = imageData.base64EncodedString(options: .lineLength64Characters)
try container.encode(strBase64, forKey: .image)

Чтобы преобразовать строку обратно в UIImage внутри required init(from decoder: Decoder) throws:

let strBase64: String = try values.decode(String.self, forKey: .image)
let dataDecoded: Data = Data(base64Encoded: strBase64, options: .ignoreUnknownCharacters)!
image = UIImage(data: dataDecoded)

Ответ 4

Собственно, самый простой способ - просто сделать это Data вместо UIImage:

public struct SomeImage: Codable {

    public let photo: Data

    public init(photo: UIImage) {
        self.photo = photo.pngData()!
    }
}

Deserialize:

UIImage(data: instanceOfSomeImage.photo)!