日志框架:一个经过专门设计的实用程序,用于规范应用程序的日志记录过程。
日志框架可以自己编写(技术要牛才行哦),也可以由第三方(例如:log4cplus)提供。对于不同的日志框架,各自的组织在实现方式上也有所不同。
虽然可以简单地“标准化”日志(例如:调用文件系统 API,将信息写入名为 log.txt 的文件),但是要成为一个严格意义上的框架,必须要超越标准化。也就是说,日志框架必须通过处理日志记录来标准化解决方案,从而暴露一个标准的 API。
没明白?那就再具体一些,设想一个日志框架,封装了三个主要部分:
主要组成
当想要捕获程序的运行时信息时,首先要发出要记录的信息。然后,格式化这些信息。最后,决定将它输出到哪里。一般情况下,会输出到文件中,但是也可以将其输出到控制台、数据库,或者任何能够接收数据的地方。
如果有一系列代码,能够解决这些问题,那么就可以被看作是一个日志框架。
使用日志,只为成为更好的攻城狮。
也许有人会问:既然 C++ 中有 cout,为什么还要使用日志呢?
无法否认,在使用像 C++、JAVA、php 这样的编程语言时,我们会经常将消息打印到控制台,因为这是开发、测试和调试程序的一部分。但倘若我们正在处理一个服务端程序,却无法看到其内部发生了什么,这时该怎么办?唯一的可见性工具是日志文件,如果没有日志,我们就不能进行任何调试,也无法知道程序内部在做什么。
尽管 C++ 中有相当方便的 cout 输出流,可以在控制台上打印一些信息,或者可以通过其他方式将这些信息重定向到文件中,但这对于实际的应用程序来说根本不够。尤其对于复杂的 C++ 程序来说,像 log4cplus 或任何其他日志框架能够提供了更多的灵活性,而这是 cout 不可能完成的。
在编写代码时,使用日志框架是一种很好的实践。即使像《代码整洁之道》这样的书籍,也建议学习像 Log4j 这样的框架进行日志记录。所以,请尽可能的在生产代码中使用日志,而不是用 cout 来打印东西(这是不可接受的)。
日志是一个优秀系统不可或缺的组成部分。
对于很多人来说,日志的作用仅限于调试。其实不然,它在很多方面都非常有用:
绝大多数人都曾面临这样的困境——一旦程序出现问题,很长时间都找不出原因!
缺少日志,我们将不得不依赖于客户或支持团队,让他们描述在什么情况下发生了什么(很可能会存在一些误导)。随后我们需要通过开发环境重现问题,并进行各种调试,直至错误修复为止,然而这一般会耗费很长时间。但若有日志的帮助,我们便能迅速摆脱这种困境,可以很快地发现异常,并快速定位、解决问题!
随着项目规模的增加,模块会越来越多,调优也变成了一场持久战。
通过记录某些操作的日期和时间,我们可以及时地检测模块的瓶颈,并针对性地对一些耗时操作做出优化。
为了提高产品质量,提供个性化服务,就必须了解用户行为——他们做了什么,想要什么。
要搞清楚这些,当然要有数据,所以需要采集和分析用户的行为,而日志无疑是最主要的数据来源。
不要去重新发明轮子——《麦肯锡方法》
不要发明轮子
既然已经对日志框架有了明确的了解,那么应该使用现有的日志框架,还是构建自己的日志框架呢?其实,这是一个老生常谈的问题了——要不要重新发明轮子?引用莎士比亚戏剧《哈姆雷特》中的一句名言:
To be or not to be - that is the question.
现在我们正处于技术大爆发的时代,每一个技术领域中都有很多好的解决方案。因此,自己完全不需要、也不应该去写日志框架。就像不应该写版本控制工具或 Bug 跟踪管理工具一样,其他人已经把这些东西搞出来了,而且搞的很好,Git、SVN,Bugzilla、Trac……应有尽有,我们完全可以花很少的钱,甚至是免费使用它们。
所以,请避免重复劳动,不要去重新发明轮子。应该坚持在自己的领域解决问题,将时间花在刀刃上。话虽如此,但我们还是需要了解关于轮子的一些细节(谁造的?怎么创造的?如何使用?),以从中接受灵感,并把自己的知识加进去。
因此,当需要一个日志框架时,应该使用现有的框架,而不是去重新发明轮子。那么,问题来了,日志框架都有哪些呢?
C++ 中的日志框架有很多,其中比较著名的有:
这么多框架,应该选择哪一个呢?
由于每个人的需求和技术栈都不一样,所以很难直接回答这个问题,但是有一些选择标准可供参考。
易于使用的框架,能让你事半功倍。
易用性,是优秀框架的一个重要特性。所以无论使用什么框架,都应优先考虑这一点。
对于日志框架而言,一旦被选定,在后期开发过程中,项目组中的每个人都会频繁使用。如果易用性不好的话,那绝对是一个噩梦!所以,在选择日志框架时,应尽量找那些由简单、直观的 API 实现的方案。一个简单日志框架,衡量标准可参考:对于缺乏经验的团队成员,应该在查看文档和简单示例之后,就能够快速上手。
功能决定现在,性能决定未来。
另一个要考虑的重要因素是性能影响。正如上面提到的,我们会经常调用日志,这可能会对程序的性能产生巨大的影响。
想象一下,一个日志框架,需要花费很长的时间才能启动,在每次调用时阻塞并执行文件 I/O,缺少缓冲机制……对于这样的框架,你会用吗?
因此,在评估日志框架时,可以参考网上的一些文章来比较,也可以自己做一些比较性实验(基准测试),例如:吞吐量——测量每秒可以完成多少次方法调用(越高越好);采样——测量每次调用执行究竟花费了多少时间(越低越好)。
影响越小,越容易维护。
在以后的使用中,日志将无处不在。就像会影响运行时性能一样,它们也会影响源码的可维护性。
从应用程序的角度来看,日志所处的位置比较尴尬。之所以这么说,是因为我们尽力隔离依赖性,提供良好的接口,并最小化耦合,在编程时考虑的是单一职责原则。然后日志出现了,它到处都是,与周围的代码无关。与这些优秀的设计原则相比,日志显得有些背道而驰。
每一个成功框架的背后,都有一个伟大的社区。
框架的生命力源于不断地完善和发展,如果没有强大的社区做支撑,这个框架便失去了源动力。
因此,在选择框架时,这一点非常重要——所选的框架是否有专门的团队做支撑?在像 Stack Overflow 这样的问答网站上,它是否有很强的存在感?确保一点,如果在使用过程中遇到了问题,你能有办法快速解决。倘若选择了一个不知名的框架,当遇到了 Bug 时,那么可能会浪费大量的时间来解决问题。
完整的框架,铸就完美的生产力。
在最前面,我们将日志的功能分为三个主要部分:日志记录、格式化和输出地,所以要确保所选的日志框架彻底解决了这些问题。
日志记录和输出地比较基础,几乎所有日志框架都有这些概念。话虽如此,但对于好的框架来说,应该巧妙地将日志记录与输出地分开,并且还应该有多种可选的输出地。在理想情况下,最好能够自定义输出地。
一般情况下,格式化日志文件会整齐地排列,并具有很好的可读性。但在 DevOps 的世界里,这些远远不够。具体来说,日志文件需要被格式化为可解析的数据。通过将日志输出作为数据处理,可以很容易地聚合、搜索和可视化日志,从而能够在生产支持方面助你一臂之力。所以,要确保日志框架拥有这种能力。
只有前途光明,方能大行其道。
无法绕过这一点——在选择日志框架时,不仅要考虑它的现状,还应该注重它的发展前景。
像上面提到的 C++ 日志框架,每一个都非常优秀且特点鲜明。但有一些却获得了更多的关注度,例如 log4cplus、glog,为什么如此呢?因为它们有很强大的“基因”和“后台”,一个是著名的 Log4j 的衍生品,另一个则是 Google 的“亲儿子”。
一个框架的发展前景,取决于众多因素——关注度、用户基数、社区活跃度……要想大行其道,这些几乎都不能少。
作者:一去、二三里,爱编程、爱分享、爱生活!
欢迎大家关注,更多优质原创内容敬请期待!
本文出自头条号【高效程序员】,VX 公众号同名。