Xcode中OC和Swift自定义log打印信息

作者: Vonkin | 来源:发表于2017-03-05 19:39 被阅读827次

    在开发过程中,打印Log进行调试是必不可少的,但是在上线之后这些Log会很消耗性能资源,同时我们又想在Log中显示更详细的信息,在Debug模式下打印,在Release模式下不打印。接下来就来说一下在OC和Swift中来是如何实现这个功能的。

    OC中自定义Log打印信息

    在OC中我们可以使用宏定义来设置工程Debug模式下打印log,Release模式下不打印Log,通常我们会定义在PCH文件中(点击查看如何创建PCH文件)。

    //自定义Log输入日志+显示行号
    
    #ifdef DEBUG  //在调试模式下
    #define MYLog(fmt, ...) NSLog((@"[Line-%d] %s " fmt), __LINE__, __PRETTY_FUNCTION__,  ##__VA_ARGS__)
    
    #else  //Release模式下
    #define MYLog(...)
    #endif  // #ifdef   需要 #endif 结束
    

    Debug和Release的切换用来控制MYLog的日志输出

    切换DEBUG模式

    如上图切换到Release即可取消在PCH文件中定义的MYLog的输入日志。

    func MYLog<T> (message: T, fileName: String = #file, funcName: String = #function, lineNum: Int = #line) {
        
        #if DEBUG
            
            let file = (fileName as NSString).lastPathComponent
            
            print("\(file):\(funcName):\(lineNum):\("打印内容"):\(message)")
            
            
            
        #endif
        
    }
    

    Swifit中自定义Log打印信息

    使用Swift我们发现,它的特性已经不再具备像OC那样的宏,所以我们不能像上面那样设置了,但我们可以通过下面的方式来实现和上面一样的功能。

    首先,我们需要通过定义全局函数的形式来实现让所有的类都能调用。

    import UIKit
    
    @UIApplicationMain
    
    class AppDelegate: UIResponder, UIApplicationDelegate {
    
        var window: UIWindow?    
        
        func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
            //调用自定义Log
            MYLog(message: "Hello")
            return true
        }
    }
    
    /// 自定义Log打印
    ///
    /// - Description:
    ///     考虑到自定义Log要打印方法所在的文件/方法名/行号,以及自定义的内容,同时考虑调用的便捷性,所以要使用默认参数(fileName: String = #file),因此无需调用者传递太多的参数。
    ///     T 使用泛型,可以让调用者传递任意的类型,进行打印Log的操作。
    /// - Parameters:
    ///   - message: 需要打印的内容
    ///   - fileName: 当前打印所在文件名 使用#file获取
    ///   - funcName: 当前打印所在方法名 使用#function获取
    ///   - lineNum: 当前打印所在行号   使用#line获取
    func MYLog<T> (message: T, fileName: String = #file, funcName: String = #function, lineNum: Int = #line) {
        
        #if DEBUG
            
            let file = (fileName as NSString).lastPathComponent
            
            print("-\(file) \(funcName)-[\(lineNum)]: \(message)")
            
        #endif
    
    }
    

    这里需要说明一下,在Swift中,全局函数的概念是,将函数定义在任意一个文件的class外面,这样即可在项目的任何地方都可以调用这个方法。这里我们可以写在AppDelegata.swift的class{}外面,也可以单独建立一个Swift文件,将MYLog方法写到里面。

    另外,考虑到要在Debug模式下进行打印,而在Release模式下不需要进行打印。我们在代码中使用到了#if DEBUG #endif。由于Swift中没有宏定义的概念,所以需要在项目的Build Settings->Other Swift Flags中为Debug添加一个标记,例如"-D DEBUG"。

    添加DEBUG标示
    这样,就可以在上面的代码中,直接通过"DEBUG"这个关键词,来判断当前的运行环境是否为Debug模式。

    到这里即可像文章开头那样,切换到DEBUG模式即可显示Log打印信息,而在Release模式下不打印。

    相关文章

      网友评论

        本文标题:Xcode中OC和Swift自定义log打印信息

        本文链接:https://www.haomeiwen.com/subject/greegttx.html