Swift 5:将复杂对象保存到文件存储

Question

我正在完成一项学校作业，为此我必须在Swift5中开发一个iOS应用程序。应用程序需要利用web服务（web-API）和文件存储或用户默认值。

我选择开发一个“QR code Manager”，用户可以通过设置一些设计参数为URL创建QR代码，然后将这些参数发送到生成器API。这个API（在OK请求时）返回一个指定格式的图像（在我的例子中是PNG）。

我有一个类与URL和所有设计属性的二维码，其中也将包含图像本身。请参阅下面的类代码片段。

public class QRCode {
    
    var bsId : Int?
    var url : String?
    var name: String?
    var frame: Frame?
    var logo: QrCodeLogo?
    var marker: Marker?
    var color : String?
    var bgColor : String?
    var image : Data?
    
    
    init(data: [String:String]) {
        self.url = data["url"]
        self.frame = Frame.allCases.first(where: { $0.description == data["frame"] })
        self.logo = QrCodeLogo.allCases.first(where: { $0.description == data["logo"] })
        self.marker = Marker.allCases.first(where: { $0.description == data["marker"] })
        self.bgColor = data["backGroundColor"]
        self.color = data["colorLight"]
    }
    
    init(json: String) {
        // todo
    }
}

extension QRCode {
    func toDict() -> [String:Any] {
        var dict = [String:Any]();
        let otherSelf = Mirror(reflecting: self);
        for child in otherSelf.children {
            if let key = child.label {
                dict[key] = child.value;
            }
        }
        return dict;
    }
}

为了便于开发，所有的属性都是空的，一旦我成功地实现了所有的东西，类将被进一步重构。

我尝试了我在网上找到的各种方法，其中一种可以在类扩展中找到。函数todict()将对象属性及其值转换为[string:any]类型的Dictionary对象。但是，我读到当对any数据类型进行编码然后进行解码时，Swift无法确定解码的数据应该是哪种复杂的数据类型，从而有效地使数据变得没有意义或不可用。

我发现的另一种方法是通过扩展类中的codable-协议。然而，据我所知，codable只接受基本数据类型。

请在下面找到我当前编写的文件存储处理代码。虽然还没有完成，但我觉得这是一个很好的开始，可能会对这个问题有所帮助。

class StorageManager {
    
    fileprivate let filemanager: FileManager = FileManager.default;
    
    fileprivate func filePath(forKey key: String) -> URL? {
        guard let docURL = filemanager.urls(for: .documentDirectory, in: FileManager.SearchPathDomainMask.userDomainMask).first else {
            return nil;
        }
        
        return docURL.appendingPathComponent(key);
    }
    
    func writeToStorage(identifier: String, data: QRCode) -> Void {
        guard let path = filePath(forKey: identifier) else {
            throw ApplicationErrors.runtimeError("Something went wrong writing the file to storage");
        }
        
        let dict = data.toDict();
        // TODO:: Implement
    }
    
    func readFromStorage(identifier: String) -> Any {
        // TODO:: Implement
        return 0;
    }
    
    func readAllFromStorage() throws -> [URL] {
        let docsURL = filemanager.urls(for: .documentDirectory, in: .userDomainMask)[0];
        
        do {
            let fileURLs = try filemanager.contentsOfDirectory(at: docsURL, includingPropertiesForKeys: nil);
            
            return fileURLs;
        } catch {
            throw ApplicationErrors.runtimeError("Something went wrong retrieving the files from \(docsURL.path): \(error.localizedDescription)");
        }
    }
}

我对Swift还是个新手，我的文件存储卡在了我的头上。有没有什么方法可以将该类的实例存储在文件存储中，以便在检索数据时重新n实例化该类？

提前谢谢！如果有任何问题，请不要犹豫。

基于Matt的评论，请在下面找到marker，frame和QRCodeLogo枚举的代码片段。框架枚举:

public enum Frame: String, CaseIterable {
    case noFrame
    case bottomFrame
    case bottomTooltip
    case topHeader
    static var count: Int { return 4 }
    
    var description: String {
        switch self {
        case .noFrame:
            return "no-frame"
        case .bottomFrame:
            return "bottom-frame"
        case .bottomTooltip:
            return "bottom-tooltip"
        case .topHeader:
            return "top-header"
        }
    }
}

QRCodeLogo枚举:

public enum QrCodeLogo: String, CaseIterable {
    case noLogo
    case scanMe
    case scanMeSquare
    static var count: Int { return 3 }
    
    var description: String {
        switch self {
        case .noLogo:
            return "no-logo"
        case .scanMe:
            return "scan-me"
        case .scanMeSquare:
            return "scan-me-square"
        }
    }
}

标记枚举:

public enum Marker: String, CaseIterable {
    case version1
    case version2
    case version3
    case version4
    case version5
    case version6
    case version7
    case version8
    case version9
    case version10
    case version11
    case version12
    case version13
    case version15
    case version16
    static var count: Int { return 15 }
    
    var description: String {
        switch self {
        case .version1:
            return "version1"
        case .version2:
            return "version2"
        case .version3:
            return "version3"
        case .version4:
            return "version4"
        case .version5:
            return "version5"
        case .version6:
            return "version6"
        case .version7:
            return "version7"
        case .version8:
            return "version8"
        case .version9:
            return "version9"
        case .version10:
            return "version10"
        case .version11:
            return "version11"
        case .version12:
            return "version12"
        case .version13:
            return "version13"
        case .version15:
            return "version15"
        case .version16:
            return "version16"
        }
    }
}

上述所有枚举都包含我所使用的API的有效设计选项。它们用作输入限制，以防止出现“无效参数”错误。

希望这能把事情搞清楚。

再次感谢！

Answer 1

一个类型可以符合Codable，前提是它的所有属性都符合Codable。除了枚举之外，您的所有属性都符合Codable，如果您声明它们符合Codable，那么它们也将符合Codable。因此，您的类型的这个简单草图将编译:

public enum Frame: String, Codable {
    case noFrame
    case bottomFrame
    case bottomTooltip
    case topHeader
}
public enum QrCodeLogo: String, Codable {
    case noLogo
    case scanMe
    case scanMeSquare
}
public enum Marker: String, Codable {
    case version1
    case version2
    case version3
    case version4
    case version5
    case version6
    case version7
    case version8
    case version9
    case version10
    case version11
    case version12
    case version13
    case version15
    case version16
}
public class QRCode : Codable {
    var bsId : Int?
    var url : String?
    var name: String?
    var frame: Frame?
    var logo: QrCodeLogo?
    var marker: Marker?
    var color : String?
    var bgColor : String?
    var image : Data?
}

关于您的代码，还有很多很多其他的地方可以改进。您不需要对任何事情使用CaseIterable或description。现在您的类型是可编码的，您可以使用它直接自动地从JSON检索值。如果您的枚举事例的名称与相应的JSON键不匹配，只需制作一个CodingKey嵌套枚举来充当桥接器。

换句话说，可编码使得您的类型既可以直接从JSON填充，也可以序列化到磁盘。