写软件的时候经常需要用到打印日志功能,可以帮助你调试和定位问题,项目上线后还可以帮助你分析数据,但是Ruby原生带有的puts方法却很少在真正的项目开发中使用。
为什么作为Ruby新手神器的puts,到了真正项目开发当中会被唾弃呢?其实只要细细分析,你就会发现它的很多弊端。比如不可控制,所有的日志都会在项目上线后照常打印,从而降低运行效率;又或者不能将日志记录到本地文件,一旦打印被清除,日志将再也找不回来;再或者打印的内容没有Tag区分,你将很难辨别这一行日志是在哪个类里打印的。
你的leader也不是傻瓜,用puts的各项弊端他也清清楚楚,因此他今天给你的任务就是制作一个日志工具类,来提供更好的日志功能。不过你的leader人还不错,并没让你一开始就实现一个具备各项功能的牛逼日志工具类,只需要一个能够控制打印级别的日志工具就好。
这个需求对你来说并不难,你立刻就开始动手编写了,并很快完成了第一个版本:
class Logger
DEBUG = 0
INFO = 1
ERROR = 2
NOTHING = 3
LEVEL = DEBUG
def debug msg
puts msg if DEBUG >= LEVEL
end
def info msg
puts msg if INFO >= LEVEL
end
def error msg
puts msg if ERROR >= LEVEL
end
end
通过这个类来打印日志,只需要控制LEVEL的级别,就可以自由地控制打印的内容。比如现在项目处于开发阶段,就将LEVEL设置为DEBUG,这样所有的日志信息都会被打印。而项目如果上线了,可以把LEVEL设置为INFO,这样就只能看到INFO及以上级别的日志打印。如果你只想看到错误日志,就可以把LEVEL设置为ERROR。而如果你开发的项目是客户端版本,不想让任何日志打印出来,可以将LEVEL设置为NOTHING。打印的时候只需要调用:
logger = Logger.new
logger.debug("Hello World")
你迫不及待地将这个工具介绍给你的leader,你的leader听完你的介绍后说:“好样的,今后大伙都用你写的这个工具来打印日志了!”
可是没过多久,你的leader找到你来反馈问题了。他说虽然这个工具好用,可是打印这种事情是不区分对象的,这里每次需要打印日志的时候都需要new出一个新的Logger,太占用内存了,希望你可以将这个工具改成用单例模式实现。
你认为你的leader说的很有道理,而且你也正想趁这个机会练习使用一下设计模式,于是你写出了如下的代码:
class Logger
private_class_method :new
DEBUG = 0
INFO = 1
ERROR = 2
NOTHING = 3
LEVEL = DEBUG
@@instance = nil
def debug msg
puts msg if DEBUG >= LEVEL
end
def info msg
puts msg if INFO >= LEVEL
end
def error msg
puts msg if ERROR >= LEVEL
end
def self.instance
@@instance = new unless @@instance
end
end
首先使用private_class_method将Logger的new方法私有化,这样就无法通过new方法创建Logger的实例了。然后使用一个静态变量@@instance来保存实例,并提供一个公有的instance方法用于获取Logger的实例,在这个方法里面判断如果@@instance为nil,就new出一个新的Logger实例,否则就直接返回@@instance。这样就可以保证内存当中只会存在一个Logger的实例了。单例模式完工!这时打印日志的代码需要改成如下方式:
logger = Logger.instance
logger.debug("Hello World")
你将这个版本展示给你的leader瞧,他看后笑了笑,说:“恩,不错,功能是实现了。不过在ruby上还有更简单的实现方式哦。”
只见他熟练地敲起了键盘,来向你展示更简单的单例实现方式(在最初代码基础上修改)。
require 'singleton'
class Logger
include Singleton
#省略剩余代码
end
首先从系统配置路径中引入singleton.rb这个文件,然后在Logger类里引入Singleton这个模块。OK,一切完工了!
“什么?!” 你简直不相信自己的眼睛,仅仅加入了两行代码就完成了单例模式。“可是instance方法从哪里来的呢?”
你的leader告诉你,ruby有一个模块(module)机制,在类里引入模块后,该类可以访问模块中的定义的方法。instance方法就是定义在Singleton这个模块里面的,然后在运行时将这个模块引入,Logger类就可以访问Singleton中的instance方法了。
单例:保证一个类仅有一个实例,并提供一个访问它的全局访问点。