iOS开发——自主设计日志系统

好像很久没有写有关iOS的文章了,其实iOS的开发一直都是在进行的,但是最近有需求拓宽知识的宽度,所以一直在接触别的知识,当然啦,移动端开发并不能丢下。

我平时开发的项目监测bug和崩溃的模块都是集成了鹅厂的Bugly系统,毕竟是谁用谁说好的第三方系统。而Bugly主要还是返回的还是崩溃之后的日志,所以如果想在平时的运行中,就能拿到客户手机中的日志怎么办呢。在这个需求的驱使下,便开始着手设计一个日志系统。

需求还是不难的,记录手机操作的内容,如

时间|日志级别|类名_函数名_行数|分类|Log内容

这样的一种日志形式。

因为不希望频繁的读写,所以希望每十条Log生成之后,读写一次。而未写入硬盘的Log保存在内存中。按照天数,每天都有一份日志,并且在客户的手机异常之后,可以将所有日志压缩上传到服务器。需求介绍完了,并不难对不对。

在Log的生成方面,我的设计是枚举出日志的级别,之后利用Swift的 #function#line等定义,方便的获取函数名和行数,类名我是利用一个对于NSObjectextension来完成的,类似这样:

extension NSObject {
    var className: String {
        return String(describing: type(of: self)).components(separatedBy: ".").last!
    }

    class var className: String {
        return String(describing: self).components(separatedBy: ".").last!
    }
}

开箱可用,准确获取类名。

生成log的核心函数例如如下这样:

public func createLog(level: DebugLevel, targetClass: AnyClass, type: OperateType, content: String,  _ line: Int = #line, _ function: String = #function)
-> String {
    let lineStr = String.init(format: "line:%d", line)
    let levelStr = levelToString(level: level)
    let separator = "|"
    let classSeparator = "_"
    let log: String = Date().toString() + separator + levelStr + separator + targetClass.className + classSeparator + function + classSeparator + lineStr + separator + content + "\n"
    print(log)
    return log
}

而基于这个函数做一些封装,就能封装出很简便的打印各级别日志的API了。

至此,介绍完Log的生成类: LogGenerator

之后是对日志的读写,需要有一个文件读写的类,暂定名为LogStorage

因为文件的读写都是常规的操作,所以代码就不贴出来了。我在这里只是贴出我在LogStorage类里暴露的接口方法

public protocol LogStorageProtocol {

    /// 获取日志缓存地址
    ///
    /// - Returns: String
    func getCachePath() -> String

    /// 删除文件
    ///
    /// - Parameter fileName: String
    /// - Returns: Bool
    func deleteFile(fileName: String) -> Bool

    /// 清除全部日志缓存
    ///
    /// - Returns: Bool
    func cleanCache() -> Bool

    /// 读取日志文件
    ///
    /// - Parameter fileName: String
    /// - Returns: Data
    func readFile(fileName: String) -> Data?

    /// 更新写入Log数据
    ///
    /// - Parameters:
    ///   - fileName: String
    ///   - data: Data
    /// - Returns: Data
    func updateFile(fileName: String, data: Data) -> Bool

    /// 自动根据天数创建文件名
    ///
    /// - Returns: String
    func createFileName() -> String
}

而这个十条一写,没有达到标准的就暂时保存在内存里,我的想法是创建一个循环队列,根据FIFO原则,当满足十条Log时,做一次写入操作,而循环队列在空间上是非常节省资源的,如果没有满足十条日志,那就都暂存在队列里,整个开销就是循环队列的一个数组,容量是11个元素,还有一个充当哨兵。

循环队列的数据结构是队列的数据结构里最基础的

protocol QueueProtocol {
    func createQueue()
    func traverseQueue()
    func isFullQueue() -> Bool
    func isEmptyQueue() -> Bool
    func Enqueue(log: String) -> Bool
    func Dequeue() -> Bool
}

在内部增加了一个遍历队列写入日志的函数

private func updateFileWhenTranverse() {
    var i = queue.front
    while (i != queue.rear) {
        let fileName = LogStorage.share.createFileName()
        let data = queue.logData[i].data(using: .utf8)
        if (LogStorage.share.updateFile(fileName: fileName, data: data!)) {
            let _ = Dequeue()
        }
        i += 1
        i = i % queue.maxsize
    }
}

而最后一个需求就是压缩上传了,在这里使用了SSZipArchive这个第三方库来压缩文件成zip格式。封装成LogArchive类。是不是三言两语间,整个日志系统就设计完成了,但是我是用Swift来写的,若是Objective-C调用怎么办呢。答案当然是用Objc强大的宏定义来搞定咯,几个宏定义,轻松的一行代码就调用了Log输出。

#define Cute_Debug(log) [[LogGenerator new] debugWithTargetClass:self.classForCoder content:[NSString stringWithFormat:@"%@", log] :(NSInteger)__LINE__ :[NSString stringWithFormat:@"%s", __FUNCTION__]];

#define Cute_Warning(log) [[LogGenerator new] warningWithTargetClass:self.classForCoder content:[NSString stringWithFormat:@"%@", log] :(NSInteger)__LINE__ :[NSString stringWithFormat:@"%s", __FUNCTION__]];

#define Cute_Info(log) [[LogGenerator new] infoWithTargetClass:self.classForCoder content:[NSString stringWithFormat:@"%@", log] :(NSInteger)__LINE__ :[NSString stringWithFormat:@"%s", __FUNCTION__]];

#define Cute_Error(log) [[LogGenerator new] errorWithTargetClass:self.classForCoder content:[NSString stringWithFormat:@"%@", log] :(NSInteger)__LINE__ :[NSString stringWithFormat:@"%s", __FUNCTION__]];

整个日志系统,我已经开源放在了我的github上,具体的代码可以去github上看。 欢迎提issue,如果有用,请点个star谢谢。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏流媒体人生

ATL Thunk机制学习

  ATL模板类库使用Thunk技术来实现与窗口消息相关联的HWND和负责处理消息的对象的this指针之间的映射。      ATL中窗口类注册时,窗口过程函数...

591
来自专栏Java 源码分析

NioEventLoopGroup 源码分析

NioEventLoopGroup 源码分析 1. 在阅读源码时做了一定的注释,并且做了一些测试分析源码内的执行流程,由于博客篇幅有限。为了方便 IDE 查看...

3807
来自专栏逆向技术

内核开发知识第一讲.内核中的数据类型.重要数据结构.常用内核API函数.

  在内核中.程序的编写不能简单的用基本数据类型了. 因为操作系统不同.很有可能造成数据类型的长度不一.而产生重大问题.所以在内核中.

1592
来自专栏Java3y

JDBC【数据库连接池、DbUtils框架、分页】

1.数据库连接池 什么是数据库连接池 简单来说:数据库连接池就是提供连接的。。。 为什么我们要使用数据库连接池 数据库的连接的建立和关闭是非常消耗资源的 频繁地...

3784
来自专栏wOw的Android小站

[设计模式]之三:单例模式

还是试想一个情景:现在有一个自定义对话框。当主界面上的按钮被点击后,弹出对话框。 一般的设计思路是这样的:

751
来自专栏青玉伏案

Objective-C中的单例模式

    ​    ​单例模式算是设计模式中比较简单的一种吧,设计模式不是只针对某种编程语言,在C++, Java, PHP等其他OOP语言也有设计模式,笔者初接...

2047
来自专栏進无尽的文章

编码篇-ARC下的内存泄漏

内存泄露是一个相对挺严重的问题,可是它的存在未引起足够的重视,如果程序运行时一直分配内存而不及时释放无用的内存,程序占用的内存越来越大,直到把系统分配给该APP...

1372
来自专栏程序生活

Python pickle的使用pickle简介实例参考资料

pickle模块是对Python对象结构进行二进制序列化和反序列化的协议实现,就是把Python数据变成流的形式。

801
来自专栏IT技术精选文摘

ZooKeeper 分布式锁实现

1532
来自专栏進无尽的文章

RunTime 之其他实践运用

有关Runtime的知识总结,我本来想集中写成一篇文章的,但是最后发现实在是太长,而且不利于阅读,最后分成了如下几篇:

1123

扫码关注云+社区

领取腾讯云代金券