Arrow

Arrow

Language: Swift 6 Platform: iOS 8+ SPM compatible Build Status codebeat badge License: MIT Release version

原因 - 示例 - 安装

identifier <-- json["id"]
name <-- json["name"]
stats <-- json["stats"]

因为在 Swift 中解析 JSON 充满了不必要的 if lets, 显而易见的类型转换和 nil 检查
一定有更好的方法

试试看

Arrow 是 freshOS iOS 工具集的一部分。 在示例应用程序中尝试它! 下载 Starter Project

如何使用

通过使用一个简单的箭头运算符,来处理那些样板代码。
Json 映射代码变得简洁易于维护 ❤️

为什么使用 Arrow

示例

Swift 模型

struct Profile {
    var identifier = 0
    var name = ""
    var link:NSURL?
    var weekday:WeekDay = .Monday
    var stats = Stats()
    var phoneNumbers = [PhoneNumber]()
}

JSON 文件

{
    "id": 15678,
    "name": "John Doe",
    "link": "https://apple.com/steve",
    "weekdayInt" : 3,
    "stats": {
        "numberOfFriends": 163,
        "numberOfFans": 10987
    },
    "phoneNumbers": [{
                     "label": "house",
                     "number": "9809876545"
                     }, {
                     "label": "cell",
                     "number": "0908070656"
                     }, {
                     "label": "work",
                     "number": "0916570656"
    }]
}

之前 (混乱)

var profile = Profile()

// Int
if let id = json["id"] as? Int {
    profile.identifier = id
}  
// String
if let name = json["name"] as? String {
    profile.name = name
}
// NSURL
if let link = json["link"] as? String, url = NSURL(string:link)  {
    profile.link = link
}
// Enum
if let weekdayInt = json["weekdayInt"] as? Int, weekday = WeekDay(rawValue:weekdayInt) {
    profile.weekday = weekday
}
// Custom nested object
if let statsJson = json["stats"] as? AnyObject {
    if let numberOfFans = statsJson["numberOfFans"] as? Int {
        profile.stats.numberOfFans = numberOfFans
    }
    if let numberOfFriends = statsJson["numberOfFriends"] as? Int {
        profile.stats.numberOfFriends = numberOfFriends
    }
}
// Array of custom nested object
if let pns = json["phoneNumbers"] as? [AnyObject] {
    for pn in pns {
        phoneNumbers.append(PhoneNumber(json: pn))
    }
}

之后 🎉🎉🎉

extension Profile:ArrowParsable {
    mutating func deserialize(_ json: JSON) {
        identifier <-- json["id"]
        link <-- json["link"]
        name <-- json["name"]
        weekday <-- json["weekdayInt"]
        stats <- json["stats"]
        phoneNumbers <-- json["phoneNumbers"]
    }
}

用法

let profile = Profile()
profile.deserialize(json)

安装

Swift Package Manager (SPM) 现在是安装 Arrow 的官方方式。 其他包管理器从 5.1.2 版本开始已被弃用,并且在未来的版本中将不再支持。

Swift Package Manager

Xcode > File > Swift Packages > Add Package Dependency... > 粘贴 https://github.com/freshOS/Arrow

Carthage - 已弃用

github "freshOS/Arrow"

CocoaPods - 已弃用

target 'MyApp'
pod 'Arrow'
use_frameworks!

它是如何工作的

注意,之前我们输入了

stats <-- json["stats"]

那是因为我们创建了一个扩展 "Stats+Arrow.swift" ,使我们能够使用 Arrow 运算符

//  Stats+Arrow.swift

import Foundation

extension Stats:ArrowParsable {
    mutating func deserialize(json: JSON) {
        numberOfFriends <-- json["numberOfFriends"]
        numberOfFans <-- json["numberOfFans"]
    }
}

你说的灵活

stats.numberOfFriends <-- json["stats.numberOfFriends"]
stats.numberOfFans <-- json["stats.numberOfFans"]

日期解析

全局地

// Configure Global Date Parsing with one of those
Arrow.setDateFormat("yyyy-MM-dd'T'HH:mm:ssZZZZZ")
Arrow.setUseTimeIntervalSinceReferenceDate(true)
Arrow.setDateFormatter(aDateFormatter)

// Then later dates can be parsed form custom date format or timestamps automatically 🎉
let json:JSON = JSON(["date": "2013-06-07T16:38:40+02:00", "timestamp": 392308720])
date1 <-- json["date"]
date2 <-- json["timestamp"]

在每个键的基础上

createdAt <-- json["created_at"]?.dateFormat("yyyy-MM-dd'T'HH:mm:ssZZZZZ")
createdAt <-- json["created_at"]?.dateFormatter(aCustomDateFormatter)

只需在个别情况下提供即可!🎉

访问 JSON 值

嵌套的值

value <-- json["nested.nested.nested.nestedValue"]

对象在索引

value <-- json[12]

两者结合

value <-- json[1]?["someKey"]?[2]?["something.other"]

循环数组

if let collection = json.collection {
    for jsonEntry in collection {
        //Do something
    }
}

Swift 版本

鸣谢

如果没有 YannickDot, Damien-ndmaxkonovalov,这一切都不会存在

赞助者

喜欢这个项目吗? 请提供咖啡或每月捐款来支持我们,并帮助我们继续我们的活动:)

赞助商

成为赞助商,并在我们的 Github README 上获得带有指向您的网站链接的徽标:)