Structify 0.1.1

Structify 0.1.1

[arturdev] 维护。



Structify 0.1.1

  • 作者:
  • arturdev

Structify

Version License Platform

Structify 设计用于简化您的开发生活,尤其是在您需要处理 Swift 结构体而不是 Objective-C 类时,您必须手动将结构体转换为类并反过来达到这个目的。
最明显的例子是 Realm

例如,假设您有一个名为 User 的结构体,您想要将其保存到 Realm 的数据库中。
如您所知,Realm 不支持 Swift 结构体,所以最常用的解决方案是创建一对类(它们将具有相同的属性)并手动编写转换方法。

不使用 Structify

struct User {
    let address: String
    let company: String
    let email: String
    let name: String
    let phone: String
    let uid: String
    let username: String
    let website: String
    let birthday: Date
}

class RLMUser: Object {

    @objc dynamic var address: String = ""
    @objc dynamic var company: String = ""
    @objc dynamic var email: String = ""
    @objc dynamic var name: String = ""
    @objc dynamic var phone: String = ""
    @objc dynamic var uid: String = ""
    @objc dynamic var username: String = ""
    @objc dynamic var website: String = ""
    @objc dynamic var birthday: Date = Date()
    
    override class func primaryKey() -> String? {
        return "uid"
    }
}

extension RLMUser {
    func toStruct() -> User {
        return User(address: address,
                    company: company,
                    email: email,
                    name: name,
                    phone: phone,
                    uid: uid,
                    username: username,
                    website: website,
                    birthday: birthday)
    }
}

extension User {
    func toObject() -> RLMUser {
        return RLMUser.build { object in
            object.uid = uid
            object.address = address
            object.company = company
            object.email = email
            object.name = name
            object.phone = phone
            object.username = username
            object.website = website
            object.birthday = birthday
        }
    }
}

乍一看,这看起来是一个非常方便的方法。但是,如果你的结构体不大,有很多属性呢?如果你有很多像 User 这样的结构体呢?如果你想在学习过程中向现有的结构体添加更多属性呢?你必须为每个结构体编写这个样板代码!如果你忘记将这些附加属性添加到 Realm 的配对类中,你还会得到额外的错误作为奖励!
是的,非常恼人。所以,Structify 就出现了来拯救我们!

简而言之

使用 Structify

struct User {
    var address: String = ""
    var company: String = ""
    var email: String = ""
    var name: String = ""
    var phone: String = ""
    var uid: String = ""
    var username: String = ""
    var website: String = ""
    var birthday: Date = Date()
}

class RLMUser: Object {
    //you only set the primaryKey as usual 
    override class func primaryKey() -> String? {
        return "uid"
    }
}

extension RLMUser: StructConvertible {
    typealias StructType = User
}

extension User: ObjectConvertible {
    typealias ClassType = RLMUser
}

很容易吧?
您需要做的只是让您的 struct 符合 ObjectConvertible 协议,并创建一个 Objective-C 配对类,并符合 StructConvertible 协议。搞定!

示例

let user = User(address: "Some address",
                company: "Some company",
                email: "[email protected]",
                name: "John",
                phone: "Doe",
                uid: "90jq0j30n0nc02930293",
                username: "arturdev",
                website: "http://github.com",
                birthday: Date())
        
let rlmUser = user.toObject()
print(rlmUser)
/*
Console:

RLMUser {
	address = Some address;
	company = Some company;
	email = [email protected];
	name = John;
	phone = Doe;
	uid = 90jq0j30n0nc02930293;
	username = arturdev;
	website = http://github.com;
	birthday = 2019-02-08 14:00:41 +0000;
}
*/

要查看示例项目,请先克隆仓库,然后从示例目录运行 pod install,之后打开 Tests.swift

要求

  • iOS 8.0+
  • Xcode 10.+
  • Swift 4.2+

安装

Structify 通过 CocoaPods 提供。要安装它,只需将以下行添加到您的 Podfile 中

pod 'Structify'

作者

arturdev,[email protected]

许可证

Structify 在 MIT 许可证下可用。更多信息请查看 LICENSE 文件。