编码/解码时 UIImage 不等效

Question

我一直在对我的模型进行一些测试，以确保当我将它们编码为 JSON 并使用 JSONEncoder/Decoder 将它们解码回来时它们是相等的。但是，我的一项测试失败了，罪魁祸首是UIImage。我确保在编码/解码过程中没有抛出任何错误。

首先，这是有问题的测试：

func testProfileImageCodable() throws {
    let image = ProfileImage(UIImage(systemName: "applelogo")!)
    try XCTAssertTrue(assertCodable(image))
}

这是我的“可编码性”测试，我确保编码/解码前后的类型相等：

func assertCodable<T: Codable & Equatable>(
    _ value: T,
    decoder: JSONDecoder = .init(),
    encoder: JSONEncoder = .init()
) throws -> Bool {
    let encoded = try encoder.encode(value)
    let decoded = try decoder.decode(T.self, from: encoded)
    
    return value == decoded
}

首先，这是我如何让UIImage 与Codable 一起工作：

extension KeyedEncodingContainer {
    mutating func encode(_ value: UIImage, forKey key: Key) throws {
        guard let data = value.pngData() else {
            throw EncodingError.invalidValue(
                value,
                EncodingError.Context(codingPath: [key],
                debugDescription: "Failed convert UIImage to data")
            )
        }
        try encode(data, forKey: key)
    }
}

extension KeyedDecodingContainer {
    func decode(_ type: UIImage.Type, forKey key: Key) throws -> UIImage {
        let imageData = try decode(Data.self, forKey: key)
        if let image = UIImage(data: imageData) {
            return image
        } else {
            throw DecodingError.dataCorrupted(
                DecodingError.Context(codingPath: [key],
                debugDescription: "Failed load UIImage from decoded data")
            )
        }
    }
}

UIImage 存在于 ProfileImage 类型中，因此使其符合 Codable 如下所示：

extension ProfileImage: Codable {
    enum CodingKeys: CodingKey {
        case image
    }
    
    public init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.image = try container.decode(UIImage.self, forKey: .image)
    }
    
    public func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(self.image, forKey: .image)
    }
}

此外，ProfileImage 的Equatable 一致性在UIImage 属性上使用isEqual(_:)，they say 是“确定两个图像是否包含相同图像数据的唯一可靠方法。”

然而，我的测试仍然失败，我不知道为什么。任何帮助将不胜感激。

Answer 1

判断两张图片是否包含相同图片数据的唯一可靠方法

他们错了。过去那段文档也误导了我！

比较两个图像的内容是否相等（底层位图）的方法是比较它们的pngData。

---

您的代码有什么问题，但是，在最深层次上，UIImage 具有您正在丢弃的scale 信息。例如，您原始图像的scale 可能是2 或3。但是当您在解码时调用image(data:) 时，您没有考虑到这一点。如果您确实考虑到了这一点，那么您的断言将按预期工作。

我像这样调整了您的代码（可能有更好的方法，我只是想证明scale 是问题所在）：

struct Image: Codable {
    let image:UIImage
    init(image:UIImage) {
        self.image = image
    }
    enum CodingKeys: CodingKey {
        case image
        case scale
    }
    public init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        let scale = try container.decode(CGFloat.self, forKey: .scale)
        let image = try container.decode(UIImage.self, forKey: .image)
        self.image = UIImage(data:image.pngData()!, scale:scale)!
    }
    public func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(self.image, forKey: .image)
        try container.encode(self.image.scale, forKey: .scale)
    }
}

这是我的测试：

let im = UIImage(systemName:"applelogo")!
let encoded = try! JSONEncoder().encode(Image(image:im))
let decoded = try! JSONDecoder().decode(Image.self, from: encoded)
assert(im.pngData()! == decoded.image.pngData()!)
print("ok") // yep