Coolie(苦力)
Coolie parse a JSON file to generate models (& their constructors).
苦力有很强的类型推断能力，除了能识别 URL 或常见 Date 类型，还能自动推断数组类型（并进行类型合并），你可从下面的例子看出细节。
中文介绍：制作一个苦力
Swift 3.0
test.json:
{
"name": "NIX",
"detail": {
"birthday": "1987-10-04",
"gender": null,
"loves": [],
"is_dog_lover": true,
"skills": [
"Swift on iOS",
"C on Linux"
],
"motto": "爱你所爱，恨你所恨。",
"latest_feelings": [4, 3.5, -4.2],
"latest_dreams": [null, "Love", null, "Hate"],
"favorite_websites": ["https://google.com", "https://www.apple.com"],
"twitter": "https://twitter.com/nixzhu"
},
"experiences": [
{
"name": "Linux",
"age": 2.5
},
{
"name": "iOS",
"age": 4
}
],
"projects": [
{
"name": "Coolie",
"url": "https://github.com/nixzhu/Coolie",
"created_at": "2016-01-24T14:50:51.644000Z",
"bytes": [1, 2, 3],
"more": {
"design": "nixzhu",
"code": "nixzhu",
"comments": ["init", "tokens", "parse"]
}
},
null,
{
"name": null,
"bytes": [],
"more": {
}
}
]
}Build coolie & run:
$ swift build
$ ./.build/debug/coolie -i test.json --model-name User --argument-label jsonIt will generate:
struct User {
struct Detail {
let birthday: Date
let favoriteWebsites: [URL]
let gender: UnknownType?
let isDogLover: Bool
let latestDreams: [String?]
let latestFeelings: [Double]
struct Love {
init?(json info: [String: Any]) {
}
}
let loves: [Love]
let motto: String
let skills: [String]
let twitter: URL
init?(json info: [String: Any]) {
guard let birthdayString = info["birthday"] as? String else { return nil }
guard let birthday = dateOnlyDateFormatter.date(from: birthdayString) else { return nil }
guard let favoriteWebsitesStrings = info["favorite_websites"] as? [String] else { return nil }
let favoriteWebsites = favoriteWebsitesStrings.map({ URL(string: $0) }).flatMap({ $0 })
let gender = info["gender"] as? UnknownType
guard let isDogLover = info["is_dog_lover"] as? Bool else { return nil }
guard let latestDreams = info["latest_dreams"] as? [String?] else { return nil }
guard let latestFeelings = info["latest_feelings"] as? [Double] else { return nil }
guard let lovesJSONArray = info["loves"] as? [[String: Any]] else { return nil }
let loves = lovesJSONArray.map({ Love(json: $0) }).flatMap({ $0 })
guard let motto = info["motto"] as? String else { return nil }
guard let skills = info["skills"] as? [String] else { return nil }
guard let twitterString = info["twitter"] as? String else { return nil }
guard let twitter = URL(string: twitterString) else { return nil }
self.birthday = birthday
self.favoriteWebsites = favoriteWebsites
self.gender = gender
self.isDogLover = isDogLover
self.latestDreams = latestDreams
self.latestFeelings = latestFeelings
self.loves = loves
self.motto = motto
self.skills = skills
self.twitter = twitter
}
}
let detail: Detail
struct Experience {
let age: Double
let name: String
init?(json info: [String: Any]) {
guard let age = info["age"] as? Double else { return nil }
guard let name = info["name"] as? String else { return nil }
self.age = age
self.name = name
}
}
let experiences: [Experience]
let name: String
struct Project {
let bytes: [Int]
let createdAt: Date?
struct More {
let code: String?
let comments: [String]?
let design: String?
init?(json info: [String: Any]) {
let code = info["code"] as? String
let comments = info["comments"] as? [String]
let design = info["design"] as? String
self.code = code
self.comments = comments
self.design = design
}
}
let more: More
let name: String?
let url: URL?
init?(json info: [String: Any]) {
guard let bytes = info["bytes"] as? [Int] else { return nil }
let createdAtString = info["created_at"] as? String
let createdAt = createdAtString.flatMap({ iso8601DateFormatter.date(from: $0) })
guard let moreJSONDictionary = info["more"] as? [String: Any] else { return nil }
guard let more = More(json: moreJSONDictionary) else { return nil }
let name = info["name"] as? String
let urlString = info["url"] as? String
let url = urlString.flatMap({ URL(string: $0) })
self.bytes = bytes
self.createdAt = createdAt
self.more = more
self.name = name
self.url = url
}
}
let projects: [Project?]
init?(json info: [String: Any]) {
guard let detailJSONDictionary = info["detail"] as? [String: Any] else { return nil }
guard let detail = Detail(json: detailJSONDictionary) else { return nil }
guard let experiencesJSONArray = info["experiences"] as? [[String: Any]] else { return nil }
let experiences = experiencesJSONArray.map({ Experience(json: $0) }).flatMap({ $0 })
guard let name = info["name"] as? String else { return nil }
guard let projectsJSONArray = info["projects"] as? [[String: Any]?] else { return nil }
let projects = projectsJSONArray.map({ $0.flatMap({ Project(json: $0) }) })
self.detail = detail
self.experiences = experiences
self.name = name
self.projects = projects
}
}You may need some date formatters:
let iso8601DateFormatter: DateFormatter = {
let formatter = DateFormatter()
formatter.timeZone = TimeZone(abbreviation: "UTC")
formatter.locale = Locale(identifier: "en_US_POSIX")
formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ"
return formatter
}()
let dateOnlyDateFormatter: DateFormatter = {
let formatter = DateFormatter()
formatter.dateFormat = "yyyy-MM-dd"
return formatter
}()Use --iso8601-date-formatter-name or --date-only-date-formatter-name can set the name of the date formatter.
Pretty cool, ah?
Now you can modify the models (the name of properties or their type) if you need.
You can specify constructor name, argument label, or json dictionary name, like following command:
$ ./.build/debug/coolie -i test.json --model-name User --constructor-name create --argument-label with --json-dictionary-name JSONDictionaryIt will generate:
struct User {
struct Detail {
let birthday: Date
let favoriteWebsites: [URL]
let gender: UnknownType?
let isDogLover: Bool
let latestDreams: [String?]
let latestFeelings: [Double]
struct Love {
static func create(with info: JSONDictionary) -> Love? {
return Love()
}
}
let loves: [Love]
let motto: String
let skills: [String]
let twitter: URL
static func create(with info: JSONDictionary) -> Detail? {
guard let birthdayString = info["birthday"] as? String else { return nil }
guard let birthday = dateOnlyDateFormatter.date(from: birthdayString) else { return nil }
guard let favoriteWebsitesStrings = info["favorite_websites"] as? [String] else { return nil }
let favoriteWebsites = favoriteWebsitesStrings.map({ URL(string: $0) }).flatMap({ $0 })
let gender = info["gender"] as? UnknownType
guard let isDogLover = info["is_dog_lover"] as? Bool else { return nil }
guard let latestDreams = info["latest_dreams"] as? [String?] else { return nil }
guard let latestFeelings = info["latest_feelings"] as? [Double] else { return nil }
guard let lovesJSONArray = info["loves"] as? [JSONDictionary] else { return nil }
let loves = lovesJSONArray.map({ Love.create(with: $0) }).flatMap({ $0 })
guard let motto = info["motto"] as? String else { return nil }
guard let skills = info["skills"] as? [String] else { return nil }
guard let twitterString = info["twitter"] as? String else { return nil }
guard let twitter = URL(string: twitterString) else { return nil }
return Detail(birthday: birthday, favoriteWebsites: favoriteWebsites, gender: gender, isDogLover: isDogLover, latestDreams: latestDreams, latestFeelings: latestFeelings, loves: loves, motto: motto, skills: skills, twitter: twitter)
}
}
let detail: Detail
struct Experience {
let age: Double
let name: String
static func create(with info: JSONDictionary) -> Experience? {
guard let age = info["age"] as? Double else { return nil }
guard let name = info["name"] as? String else { return nil }
return Experience(age: age, name: name)
}
}
let experiences: [Experience]
let name: String
struct Project {
let bytes: [Int]
let createdAt: Date?
struct More {
let code: String?
let comments: [String]?
let design: String?
static func create(with info: JSONDictionary) -> More? {
let code = info["code"] as? String
let comments = info["comments"] as? [String]
let design = info["design"] as? String
return More(code: code, comments: comments, design: design)
}
}
let more: More
let name: String?
let url: URL?
static func create(with info: JSONDictionary) -> Project? {
guard let bytes = info["bytes"] as? [Int] else { return nil }
let createdAtString = info["created_at"] as? String
let createdAt = createdAtString.flatMap({ iso8601DateFormatter.date(from: $0) })
guard let moreJSONDictionary = info["more"] as? JSONDictionary else { return nil }
guard let more = More.create(with: moreJSONDictionary) else { return nil }
let name = info["name"] as? String
let urlString = info["url"] as? String
let url = urlString.flatMap({ URL(string: $0) })
return Project(bytes: bytes, createdAt: createdAt, more: more, name: name, url: url)
}
}
let projects: [Project?]
static func create(with info: JSONDictionary) -> User? {
guard let detailJSONDictionary = info["detail"] as? JSONDictionary else { return nil }
guard let detail = Detail.create(with: detailJSONDictionary) else { return nil }
guard let experiencesJSONArray = info["experiences"] as? [JSONDictionary] else { return nil }
let experiences = experiencesJSONArray.map({ Experience.create(with: $0) }).flatMap({ $0 })
guard let name = info["name"] as? String else { return nil }
guard let projectsJSONArray = info["projects"] as? [JSONDictionary?] else { return nil }
let projects = projectsJSONArray.map({ $0.flatMap({ Project.create(with: $0) }) })
return User(detail: detail, experiences: experiences, name: name, projects: projects)
}
}You may need typealias JSONDictionary = [String: Any].
If you need class model, use the following command:
$ ./.build/debug/coolie -i test.json --model-name User --model-type classAlso --argument-label and --json-dictionary-name options are available for class.
If you need more information for debug, append a --debug option in all the commands.
NIX @nixzhu
Coolie is available under the [MIT License][mitLink]. See the LICENSE file for more info. [mitLink]:http://opensource.org/licenses/MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent