為何造這個輪子
國慶的時候寫了個小工具來將 JSON 轉化成 Model,也算是我的第一個 Mac App,今天重構了下,順便跟大家分享下 Mac 開發(fā)有多不方便……
項目地址在這里,如果是跟我一樣使用 ObjectMapper 的朋友可以直接下載使用一下。市面上其實已經(jīng)有一些 JSON 轉 Model 的工具了,那我為何還要重復造輪子呢?顯然是因為別人寫的并不能滿足我的需求,代碼生成器絕對是個需要定制化的東西,畢竟每個人每個團隊,都有一套代碼風格(不單是指縮進、空格、大括號換不換行這些,因為這些其實每個社區(qū)幾乎都有廣為人接受的最佳實踐),比如我寫 Model 不喜歡把 String、Int 等類型的屬性聲明為 Optional,而是習慣給它們一個初始值,但是對象類型的屬性給它個初始值我又覺得開銷有點大,一般就用 Optional。所以我寫的這個工具也不一定適合你們,但是我把我的一點微小經(jīng)驗分享給大家,你們就可以隨意修改我的代碼進行定制化或者自己重新造個最趁手的輪子。當然,如果你確實有需要,而自己又沒時間造輪子,可以留言告訴我,我會考慮擴展功能。
界面
好了話不多說先放張截圖,圖中的 JSON 數(shù)據(jù)來自 GitHub API 文檔:
UI 非常簡單,左邊用來輸入 Model Name 和粘貼 JSON,右邊是轉化結果。我對 Mac 開發(fā)其實一無所知……我就是直接打開 Xcode,新建了個 macOS 的項目,然后在 Storyboard 上拖了一個 TextField 和兩個 TextView 進去,設置好約束之后,我準備把三個控件連到代碼中……然后我尷尬地發(fā)現(xiàn) NSTextView 連到 IBOutlet 之后,類型是 NSScrollView [黑人問號???]。這個時候我還沒有意識到自己已經(jīng)一只腳踏進坑里,我心想難道 NSTextView 是 NSScrollView 的子類?那我手動把它改成 NSTextView 吧……然后迎接我的是各種 crash。后來仔細揣摩了一下 Storyboard 里控件的層級關系,我發(fā)現(xiàn)之前真的只是單純地連了個 NSScrollView 到代碼中,真正的 NSTextView 在一個奇怪的地方:
我之前拖到代碼中的是最外層的 Bordered Scroll View,它下面還有一層 Clip View,之后才是我需要的 TextView……
思路分析
有人可能覺得代碼生成器是個很高端很難實現(xiàn)的東西,其實不然。代碼生成器的難點在于解析輸入,而輸入的規(guī)則很多情況下是我們自己定的,只要盡可能保證解析規(guī)則簡單,剩下的工作就是把解析好的信息填到預定的模版中輸出而已。拿我的 Model 生成器來說,最難的任務本應該是解析 JSON 字符串,但是我直接把字符串序列化然后生成結構化的 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 對象有了,我們還需要把屬性名進行標準化。Swift 中變量名是使用駝峰風格的,如果你的服務端是用 PHP,Ruby 之類的語言寫的,返回的 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
}
接下來就是邊解析 JSON 邊拼接字符串,難點在于嵌套對象的處理,我使用了遞歸,代碼有點長我就不貼了,大家可以看源碼。還有就是碰到了對象數(shù)組的話,對于該對象 Model 的命名,也不太好辦,我的處理是屬性名以“s”或者“List”結尾的話,就把“s”或者“List”之前的單詞作為 Model 名,至于其它的情況(譬如 people、productArray 等),就管不過來了,真的碰到了就手動修改下。按《程序員修煉之道》中說的:
這是被動代碼生成器的一個有趣的特性:它們不必完全正確。你需要在你投入生成器的努力和你花在修正其輸出上的精力之間進行權衡。
在 Mac 開發(fā)中使用 RxSwift
感覺 RxCocoa 對 Cocoa 的支持并不好,譬如沒有為 NSTextView 和 NSTextField 提供 rx.string、rx.stringValue 之類的擴展。不過關系也不大,可以自己用 PublishSubject 去接一下相應的委托方法,然后我們只要訂閱這個 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 把兩個 Subject 組合在一起,無論哪個 Subject 發(fā)出新事件,都會接收到該新事件和另一個 Subject 的發(fā)射過的最新事件。具體效果就是,只有在左側把 Model Name 和 JSON 都填上,右邊才會顯示結果,之后無論是改變 Model Name 還是 JSON 內(nèi)容,右側結果都會跟著變化。
最后
覺得有點意思的話可以隨手 Star 一個哈 ^ ^