试水 Mac 开发 —— 代码生成器

为何造这个轮子

国庆的时候写了个小工具来将 JSON 转化成 Model,也算是我的第一个 Mac App,今天重构了下,顺便跟大家分享下 Mac 开发有多不方便……

项目地址在这里,如果是跟我一样使用 ObjectMapper 的朋友可以直接下载使用一下。市面上其实已经有一些 JSON 转 Model 的工具了,那我为何还要重复造轮子呢?显然是因为别人写的并不能满足我的需求,代码生成器绝对是个需要定制化的东西,毕竟每个人每个团队,都有一套代码风格(不单是指缩进、空格、大括号换不换行这些,因为这些其实每个社区几乎都有广为人接受的最佳实践),比如我写 Model 不喜欢把 String、Int 等类型的属性声明为 Optional,而是习惯给它们一个初始值,但是对象类型的属性给它个初始值我又觉得开销有点大,一般就用 Optional。所以我写的这个工具也不一定适合你们,但是我把我的一点微小经验分享给大家,你们就可以随意修改我的代码进行定制化或者自己重新造个最趁手的轮子。当然,如果你确实有需要,而自己又没时间造轮子,可以留言告诉我,我会考虑扩展功能。

界面

好了话不多说先放张截图,图中的 JSON 数据来自 GitHub API 文档:

screenshot.png

UI 非常简单,左边用来输入 Model Name 和粘贴 JSON,右边是转化结果。我对 Mac 开发其实一无所知……我就是直接打开 Xcode,新建了个 macOS 的项目,然后在 Storyboard 上拖了一个 TextField 和两个 TextView 进去,设置好约束之后,我准备把三个控件连到代码中……然后我尴尬地发现 NSTextView 连到 IBOutlet 之后,类型是 NSScrollView [黑人问号❓❓❓]。这个时候我还没有意识到自己已经一只脚踏进坑里,我心想难道 NSTextView 是 NSScrollView 的子类?那我手动把它改成 NSTextView 吧……然后迎接我的是各种 crash。后来仔细揣摩了一下 Storyboard 里控件的层级关系,我发现之前真的只是单纯地连了个 NSScrollView 到代码中,真正的 NSTextView 在一个奇怪的地方:

TextView.png

我之前拖到代码中的是最外层的 Bordered Scroll View,它下面还有一层 Clip View,之后才是我需要的 TextView……

思路分析

有人可能觉得代码生成器是个很高端很难实现的东西,其实不然。代码生成器的难点在于解析输入,而输入的规则很多情况下是我们自己定的,只要尽可能保证解析规则简单,剩下的工作就是把解析好的信息填到预定的模版中输出而已。拿我的 Model 生成器来说,最难的任务本应该是解析 JSON 字符串,但是我直接把字符串序列化然后生成结构化的 JSON 数据,这一步就只需要两行代码:

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 边拼接字符串,难点在于嵌套对象的处理,我使用了递归,代码有点长我就不贴了,大家可以看源码。还有就是碰到了对象数组的话,对于该对象 Model 的命名,也不太好办,我的处理是属性名以“s”或者“List”结尾的话,就把“s”或者“List”之前的单词作为 Model 名,至于其它的情况(譬如 people、productArray 等),就管不过来了,真的碰到了就手动修改下。按《程序员修炼之道》中说的:

这是被动代码生成器的一个有趣的特性:它们不必完全正确。你需要在你投入生成器的努力和你花在修正其输出上的精力之间进行权衡。

在 Mac 开发中使用 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 发出新事件,都会接收到该新事件和另一个 Subject 的发射过的最新事件。具体效果就是,只有在左侧把 Model Name 和 JSON 都填上,右边才会显示结果,之后无论是改变 Model Name 还是 JSON 内容,右侧结果都会跟着变化。

最后

觉得有点意思的话可以随手 Star 一个哈 ^ ^

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,567评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 1. 捧着半儿拉西瓜挖着吃的时候 2. 躺在床上上无忧无虑发呆的时候 3. 上完一天班后躺在床上看电影,并拿着半儿...
    马雨_Val阅读 125评论 0 1
  • 回家作业: 1.workbook:Homework1 2.Tutorial book:Homework1 在线练习...
    EmilyJia阅读 312评论 0 0
  • 最近经常看到一些产品经理写的文章,最多的还是在分享产品经理是干什么的,造成他们有想分享冲动的原因大概是他们接触到了...
    秦时明月V阅读 1,359评论 4 6