為何造這個(gè)輪子
國(guó)慶的時(shí)候?qū)懥藗€(gè)小工具來(lái)將 JSON 轉(zhuǎn)化成 Model,也算是我的第一個(gè) Mac App蛛枚,今天重構(gòu)了下,順便跟大家分享下 Mac 開發(fā)有多不方便……
項(xiàng)目地址在這里该园,如果是跟我一樣使用 ObjectMapper 的朋友可以直接下載使用一下兆解。市面上其實(shí)已經(jīng)有一些 JSON 轉(zhuǎn) Model 的工具了,那我為何還要重復(fù)造輪子呢亲雪?顯然是因?yàn)閯e人寫的并不能滿足我的需求勇凭,代碼生成器絕對(duì)是個(gè)需要定制化的東西,畢竟每個(gè)人每個(gè)團(tuán)隊(duì)义辕,都有一套代碼風(fēng)格(不單是指縮進(jìn)虾标、空格、大括號(hào)換不換行這些灌砖,因?yàn)檫@些其實(shí)每個(gè)社區(qū)幾乎都有廣為人接受的最佳實(shí)踐)璧函,比如我寫 Model 不喜歡把 String、Int 等類型的屬性聲明為 Optional基显,而是習(xí)慣給它們一個(gè)初始值蘸吓,但是對(duì)象類型的屬性給它個(gè)初始值我又覺得開銷有點(diǎn)大,一般就用 Optional撩幽。所以我寫的這個(gè)工具也不一定適合你們库继,但是我把我的一點(diǎn)微小經(jīng)驗(yàn)分享給大家箩艺,你們就可以隨意修改我的代碼進(jìn)行定制化或者自己重新造個(gè)最趁手的輪子。當(dāng)然宪萄,如果你確實(shí)有需要艺谆,而自己又沒時(shí)間造輪子,可以留言告訴我拜英,我會(huì)考慮擴(kuò)展功能静汤。
界面
好了話不多說(shuō)先放張截圖,圖中的 JSON 數(shù)據(jù)來(lái)自 GitHub API 文檔:
UI 非常簡(jiǎn)單聊记,左邊用來(lái)輸入 Model Name 和粘貼 JSON撒妈,右邊是轉(zhuǎn)化結(jié)果。我對(duì) Mac 開發(fā)其實(shí)一無(wú)所知……我就是直接打開 Xcode排监,新建了個(gè) macOS 的項(xiàng)目狰右,然后在 Storyboard 上拖了一個(gè) TextField 和兩個(gè) TextView 進(jìn)去,設(shè)置好約束之后舆床,我準(zhǔn)備把三個(gè)控件連到代碼中……然后我尷尬地發(fā)現(xiàn) NSTextView 連到 IBOutlet 之后棋蚌,類型是 NSScrollView [黑人問號(hào)???]。這個(gè)時(shí)候我還沒有意識(shí)到自己已經(jīng)一只腳踏進(jìn)坑里挨队,我心想難道 NSTextView 是 NSScrollView 的子類谷暮?那我手動(dòng)把它改成 NSTextView 吧……然后迎接我的是各種 crash。后來(lái)仔細(xì)揣摩了一下 Storyboard 里控件的層級(jí)關(guān)系盛垦,我發(fā)現(xiàn)之前真的只是單純地連了個(gè) NSScrollView 到代碼中湿弦,真正的 NSTextView 在一個(gè)奇怪的地方:
我之前拖到代碼中的是最外層的 Bordered Scroll View,它下面還有一層 Clip View腾夯,之后才是我需要的 TextView……
思路分析
有人可能覺得代碼生成器是個(gè)很高端很難實(shí)現(xiàn)的東西颊埃,其實(shí)不然。代碼生成器的難點(diǎn)在于解析輸入蝶俱,而輸入的規(guī)則很多情況下是我們自己定的班利,只要盡可能保證解析規(guī)則簡(jiǎn)單,剩下的工作就是把解析好的信息填到預(yù)定的模版中輸出而已榨呆。拿我的 Model 生成器來(lái)說(shuō)罗标,最難的任務(wù)本應(yīng)該是解析 JSON 字符串,但是我直接把字符串序列化然后生成結(jié)構(gòu)化的 JSON 數(shù)據(jù)积蜻,這一步就只需要兩行代碼:
func json(from text: String) -> Any? {
guard let data = text.data(using: .utf8) else { return nil }
return try? JSONSerialization.jsonObject(with: data, options: [])
}
JSON 對(duì)象有了闯割,我們還需要把屬性名進(jìn)行標(biāo)準(zhǔn)化。Swift 中變量名是使用駝峰風(fēng)格的竿拆,如果你的服務(wù)端是用 PHP宙拉,Ruby 之類的語(yǔ)言寫的,返回的 JSON 中的 key 一般是用下劃線分隔單詞的如输,我們可以這么做:
func normalizeVariableName(key: String) -> String {
var name = key
if name.contains(underline) {
var words = name.components(separatedBy: underline)
name = words.removeFirst()
words.forEach { name += $0.capitalized }
}
return name
}
接下來(lái)就是邊解析 JSON 邊拼接字符串,難點(diǎn)在于嵌套對(duì)象的處理,我使用了遞歸不见,代碼有點(diǎn)長(zhǎng)我就不貼了澳化,大家可以看源碼。還有就是碰到了對(duì)象數(shù)組的話稳吮,對(duì)于該對(duì)象 Model 的命名缎谷,也不太好辦,我的處理是屬性名以“s”或者“List”結(jié)尾的話灶似,就把“s”或者“List”之前的單詞作為 Model 名列林,至于其它的情況(譬如 people、productArray 等)酪惭,就管不過來(lái)了希痴,真的碰到了就手動(dòng)修改下。按《程序員修煉之道》中說(shuō)的:
這是被動(dòng)代碼生成器的一個(gè)有趣的特性:它們不必完全正確春感。你需要在你投入生成器的努力和你花在修正其輸出上的精力之間進(jìn)行權(quán)衡砌创。
在 Mac 開發(fā)中使用 RxSwift
感覺 RxCocoa 對(duì) Cocoa 的支持并不好,譬如沒有為 NSTextView 和 NSTextField 提供 rx.string鲫懒、rx.stringValue 之類的擴(kuò)展嫩实。不過關(guān)系也不大,可以自己用 PublishSubject 去接一下相應(yīng)的委托方法窥岩,然后我們只要訂閱這個(gè) PublishSubject 就好了:
extension ViewController: NSTextViewDelegate {
func textDidChange(_ notification: Notification) {
source.onNext(sourceText.string ?? "")
}
}
extension ViewController: NSTextFieldDelegate {
override func controlTextDidChange(_ obj: Notification) {
let model = modelNameText.stringValue.isEmpty ? "Model" : modelNameText.stringValue
modelName.onNext(model)
}
}
func parse() {
Observable
.combineLatest(source, modelName) { (json: $0.0, modelName: $0.1) }
.map { (self.json(with: $0.json), $0.modelName) }
.map(convert)
.subscribe(onNext: {
self.resultText.string = $0
})
.addDisposableTo(bag)
}
我用 combineLatest 把兩個(gè) Subject 組合在一起甲献,無(wú)論哪個(gè) Subject 發(fā)出新事件,都會(huì)接收到該新事件和另一個(gè) Subject 的發(fā)射過的最新事件颂翼。具體效果就是晃洒,只有在左側(cè)把 Model Name 和 JSON 都填上,右邊才會(huì)顯示結(jié)果疚鲤,之后無(wú)論是改變 Model Name 還是 JSON 內(nèi)容锥累,右側(cè)結(jié)果都會(huì)跟著變化。
最后
覺得有點(diǎn)意思的話可以隨手 Star 一個(gè)哈 ^ ^