SerializedSwift

一个受 GSON 启发的 Swift JSON 解码策略，使用 @propertyWrappers。

特性

无需编写自己的 init(from decoder: Decoder)
无需编写自己的 CodingKeys 子类
开箱即用地支持继承和组合
自定义 Transformer 类
备用编码键
如果 JSON 键缺失，则使用默认值

struct Foo: Serializable {
    @Serialized
    var bar: String
    
    @Serialized("globalId")
    var id: String?
    
    @Serialized(alternateKey: "mobileNumber")
    var phoneNumber: String?
    
    @Serialized(default: 0)
    var score: Int
}

安装

CocoaPods

将此行添加到你的 Podfile 中

pod 'SerializedSwift'

Swift Package Manager

如果你使用 SPM 作为你的依赖管理工具，请将此添加到你的 Package.swift 文件中的依赖项中

dependencies: [
    .package(url: "https://github.com/dejanskledar/SerializedSwift.git")
]

要求

iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
Xcode 11+
Swift 5.1+

用法

class User: Serializable {

    @Serialized
    var name: String
    
    @Serialized("globalId")
    var id: String?
    
    @Serialized(alternateKey: "mobileNumber")
    var phoneNumber: String?
    
    @Serialized(default: 0)
    var score: Int
    
    required init() {}
}

支持继承

无需额外的解码逻辑

class PowerUser: User {
    @Serialized
    var powerName: String?

    @Serialized(default: 0)
    var credit: Int
}

支持组合

无需额外的解码逻辑

class ChatRoom: Serializable {
    @Serialized
    var admin: PowerUser?

    @Serialized(default: [])
    var users: [User]
}

自定义 transformer 类

你可以创建自己的自定义 Transformable 类，用于自定义转换逻辑。

class DateTransformer: Transformable {
    static func transformFromJSON(from value: String?) -> Date? {
        let formatter = DateFormatter()
        return formatter.date(from: value ?? "")
    }
    
    static func transformToJson(from value: Date?) -> String? {
        let formatter = DateFormatter()
        return formatter.string(from: value ?? Date())
    }
}

struct User: Serializable {
    @SerializedTransformable<DateTransformer>
    var birthDate: Date?
}

特性

`Serializable`

SerializableEncodable & SerializableDecodable 的类型别名
使用 propertyWrappers 进行自定义解码和编码（如下所列）
将此协议与下面的 property wrappers 结合使用于你的类和结构体中

`Serialized`

所有属性的序列化 propertyWrapper，包括可选和非可选属性！
自定义解码键
默认情况下使用 propertyName 作为解码键
支持备用解码键
可选的默认值（如果键缺失）。默认情况下，默认值为 nil。对于非可选属性，建议使用默认值，以避免崩溃

@Serialized("mainKey", alternativeKey: "backupKey", default: "")
var key: String?

`SerializedTransformable`

自定义转换 property wrapper
创建自己的 Transformable 类
将 Decodable 对象转换为你自己的类型，例如将自定义 String Date 格式转换为原生 Date

 class DateTransformer: Transformable {
     static func transformFromJSON(from value: String?) -> Date? {
         let formatter = DateFormatter()
         return formatter.date(from: value ?? "")
     }
     
     static func transformToJson(from value: Date?) -> String? {
         let formatter = DateFormatter()
         return formatter.string(from: value ?? "")
     }
 }

 // Usage of `SerializedTransformable`
 struct User: Serializable {
     @SerializedTransformable<DateTransformer>
     var birthDate: Date?
 }

贡献

这仅仅是使用 Property Wrappers 可以实现的功能以及如何改进 Swift 中 JSON 解码和编码的冰山一角。欢迎合作。