Swift开发小技巧系列 - 改造print函数

原文链接

正文

在实际开发中,print函数应该是我们最常用到的调试手段。使用非常灵活简单。但有的时候就是不够那么方便。在开发中主要体现在以下两点:

  • 显示log语句的具体位置,即在哪个文件的哪个函数的哪一行
  • 在release版本中,自动失效

下面我们就针对以上两点来进行对print函数的改造。

public func debugPrintLog(_ message: Any, file: String = #file, function: String = #function, line: Int = #line) {
    print("\((file as NSString).lastPathComponent):\(function):\(line) -> \(message)")
}

自定义了一个debugPrintLog来替代原来的print函数,这个函数除了要传入输出的内容,还要三个参数:文件路径,函数名和代码行数。当然我们绝大多数时候只要使用默认参数就可以了。使用起来也很简单,看效果。

// PrintHelperViewController.swift

func testPrintLog() {
    debugPrintLog("Hello, World!")
}

// 输出结果: PrintHelperViewController.swift:testPrintLog():20 -> Hello, World!

这时候我们就解决了第一个问题。其实这里我们还可以继改进下,我们在实际开发时,会一些情况,我只想确定某些方法有没有被调用,不想输出其它信息,毕竟每次思考输出什么文字也是件头疼的事。

public func debugPrintLog(_ message: Any? = nil, file: String = #file, function: String = #function, line: Int = #line) {
    print("\((file as NSString).lastPathComponent):\(function):\(line) -> \(message)")
}
// PrintHelperViewController.swift

func testPrintLog() {
    debugPrintLog()
}

// 输出结果: PrintHelperViewController.swift:testPrintLog():20

第一个问题解决,我们开始解决第二个问题。

public func debugPrintLog(_ message: Any? = nil, file: String = #file, function: String = #function, line: Int = #line) {
    #if DEBUG
        if let message = message {
            print("\((file as NSString).lastPathComponent):\(function):\(line) -> \(message)")
        } else {
            print("\((file as NSString).lastPathComponent):\(function):\(line)")
        }
    #endif
}

思路也很简单,我们让输出语句只在DEBUG模式有效。改造结束,到此为止,我们就完成了一个解决特定需求的输出函数debugPrintLog

参考资料

联系方式

备注

我们在软件开发的过程中,为了提高效率,其中很重要的一环就是把反复使用到的功能或模块封装起来。因此我在GitHub上开源了一个小工具集 - SwiftDevHints,来总结自己在实际项目开发过程中封装的一些小功能。

刚刚介绍的只是其中一个小功能,想看看其它更多功能,请直接点击SwiftDevHints。如果您觉得对您有所帮助,请给一个star吧。

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

推荐阅读更多精彩内容