导语：
DDLog，即CocoaLumberjack是iOS开发用的最多的日志框架，出自大神Robbie Hanson之手（还有诸多知名开源框架如 XMPPFramework、 CocoaAsyncSocket，都是即时通信领域很基础应用很多的框架）。了解DDLog的源码将有助于我们更好的输出代码中的日志信息，便于定位问题，也能对我们在书写自己的日志框架或者其他模块时有所启发。
此系列文章将分为以下几篇：
- DDLog源码解析一：框架结构
- DDLog源码解析二：设计初衷
- DDLog源码解析三：FileLogger
本文将对DDLog支持的众多Logger中值得分析的文件logger（其余logger基本只涉及系统api的调用）进行分析，并简要分析一些杂乱的知识点。
FileLogger初始化
FileLogger初始化包含两种初始化操作：默认配置和自定义配置
- (instancetype)init {
DDLogFileManagerDefault *defaultLogFileManager = [[DDLogFileManagerDefault alloc] init];
return [self initWithLogFileManager:defaultLogFileManager];
}
- (instancetype)initWithLogFileManager:(id <DDLogFileManager>)aLogFileManager {
if ((self = [super init])) {
_maximumFileSize = kDDDefaultLogMaxFileSize;
_rollingFrequency = kDDDefaultLogRollingFrequency;
_automaticallyAppendNewlineForCustomFormatters = YES;
logFileManager = aLogFileManager;
self.logFormatter = [DDLogFileFormatterDefault new];
}
return self;
}
FileLogger默认配置
FileLogger默认配置由DDLogFileManagerDefault来实现，DDLogFileManagerDefault类中除可以定义日志文件保存路径外，其余信息都属于写死的固定值（包括下面的静态常量）：
// 日志文件数的最大值
NSUInteger const kDDDefaultLogMaxNumLogFiles = 5; // 5 Files
// 日志文件占用空间最大值
unsigned long long const kDDDefaultLogFilesDiskQuota = 20 * 1024 * 1024; // 20 MB
// 日志默认路径为沙盒中caches文件中的Logs文件夹
- (NSString *)defaultLogsDirectory {
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
NSString *baseDir = paths.firstObject;
NSString *logsDirectory = [baseDir stringByAppendingPathComponent:@"Logs"];
return logsDirectory;
}
同时，DDLogFileManagerDefault的实例初始化时还对两个变量通过KVO形式进行监听变化:
[self addObserver:self forKeyPath:NSStringFromSelector(@selector(maximumNumberOfLogFiles)) options:kvoOptions context:nil];
[self addObserver:self forKeyPath:NSStringFromSelector(@selector(logFilesDiskQuota)) options:kvoOptions context:nil];
如果将一个对象设定成属性,这个属性是自动支持KVO的,如果这个对象是一个实例变量,那么,这个KVO是需要我们自己来实现的. 所以这里对maximumNumberOfLogFiles和logFilesDiskQuota重写了
- (BOOL)automaticallyNotifiesObserversForKey:(NSString *)theKey
来支持KVO:
+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)theKey
{
BOOL automatic = NO;
if ([theKey isEqualToString:@"maximumNumberOfLogFiles"] || [theKey isEqualToString:@"logFilesDiskQuota"]) {
automatic = NO;
} else {
automatic = [super automaticallyNotifiesObserversForKey:theKey];
}
return automatic;
}
当KVO监听到两个实例变量的变化时，需要通过- (void)deleteOldLogFiles方法来判断是否需要删除文件以满足最新的文件数量和大小的要求，但删除的时候需要注意，如果只剩一个文件待删除，判断到该文件未归档，则不能删除，因为此文件可能正在写入信息，还没有关闭文件。 代码片段如下：
if (firstIndexToDelete == 0) {
// Do we consider the first file?
// We are only supposed to be deleting archived files.
// In most cases, the first file is likely the log file that is currently being written to.
// So in most cases, we do not want to consider this file for deletion.
if (sortedLogFileInfos.count > 0) {
DDLogFileInfo *logFileInfo = sortedLogFileInfos[0];
if (!logFileInfo.isArchived) {
// Don't delete active file.
++firstIndexToDelete;
}
}
}
文件命名
默认的文件名命名方式：app名称为前缀，加上经过一定格式format过的格式。
- (NSDateFormatter *)logFileDateFormatter {
NSMutableDictionary *dictionary = [[NSThread currentThread]
threadDictionary];
NSString *dateFormat = @"yyyy'-'MM'-'dd'--'HH'-'mm'-'ss'-'SSS'";
NSString *key = [NSString stringWithFormat:@"logFileDateFormatter.%@", dateFormat];
NSDateFormatter *dateFormatter = dictionary[key];
if (dateFormatter == nil) {
dateFormatter = [[NSDateFormatter alloc] init];
[dateFormatter setLocale:[NSLocale localeWithLocaleIdentifier:@"en_US_POSIX"]];
[dateFormatter setDateFormat:dateFormat];
[dateFormatter setTimeZone:[NSTimeZone timeZoneForSecondsFromGMT:0]];
dictionary[key] = dateFormatter;
}
return dateFormatter;
}
- (NSString *)newLogFileName {
NSString *appName = [self applicationName];
NSDateFormatter *dateFormatter = [self logFileDateFormatter];
NSString *formattedDate = [dateFormatter stringFromDate:[NSDate date]];
return [NSString stringWithFormat:@"%@ %@.log", appName, formattedDate];
}
- (NSString *)applicationName {
static NSString *_appName;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
_appName = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleIdentifier"];
if (!_appName) {
_appName = [[NSProcessInfo processInfo] processName];
}
if (!_appName) {
_appName = @"";
}
});
return _appName;
}
这里需要注意applicationName的获取方式中使用了dispatch_once，是为了保证线程安全和低负载：NSProcessInfo是线程不安全的，而这个方法可能在多个线程中同时访问到NSProcessInfo。而低负载是指这部分信息其实是app的通用信息，不会改变，所以复制到静态变量中，不管哪个实例变量来获取，都可以通过第一次获取的值直接给它。
FileLogger重要逻辑
FileLogger还要在初始化时配置单个文件大小的最大值和轮询检查文件时间（这两个值已写死）
unsigned long long const kDDDefaultLogMaxFileSize = 1024 * 1024; // 1 MB
NSTimeInterval const kDDDefaultLogRollingFrequency = 60 * 60 * 24; // 24 Hours
_maximumFileSize = kDDDefaultLogMaxFileSize;
_rollingFrequency = kDDDefaultLogRollingFrequency;
由于这两个值直接跟写日志相关，所以这两个值的getter和setter方法都使用了上一节解析的线程保护方式：先在全局日志队列排队，再到自己的日志队列中排队进行操作，以一个为例：
- (NSTimeInterval)rollingFrequency {
__block NSTimeInterval result;
dispatch_block_t block = ^{
result = _rollingFrequency;
};
NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure");
NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax.");
dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue];
dispatch_sync(globalLoggingQueue, ^{
dispatch_sync(self.loggerQueue, block);
});
return result;
}
当轮询检查需要检查文件两方面信息：大小和已经打开的时间。文件大小通过NSFileHandle的方法可以判断，而已经打开的时间则需要通过计时器来计时，最终在轮询时刻与设定的值比较。到当前文件已经符合设置的值时，需要关闭文件，并将文件归档，再将文件计时器关闭。
文件权限
在写日志文件前需要创建新文件，由于iOS系统默认设置文件权限为NSFileProtectionCompleteUnlessOpen， 但如果app可以在后台运行，需要设置为NSFileProtectionCompleteUntilFirstUserAuthentication，才能保证即使锁屏也能正常创建和读写文件。
//文件未受保护，随时可以访问 （Default）
NSFileProtectionNone
//文件受到保护，而且只有在设备未被锁定时才可访问
NSFileProtectionComplete
//文件收到保护，直到设备启动且用户第一次输入密码
NSFileProtectionCompleteUntilFirstUserAuthentication
//文件受到保护，而且只有在设备未被锁定时才可打开，不过即便在设备被锁定时，已经打开的文件还是可以继续使用和写入
NSFileProtectionCompleteUnlessOpen
而其中app是否可以在app后台运行，是通过plist中对应的配置项是否申请了后台运行能力来判断的：
BOOL doesAppRunInBackground() {
BOOL answer = NO;
NSArray *backgroundModes = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"UIBackgroundModes"];
for (NSString *mode in backgroundModes) {
if (mode.length > 0) {
answer = YES;
break;
}
}
return answer;
}
网友评论