一次日志库的导入经历

2017-04-25  本文已影响161人  松哥888

基本的方案

接口函数

采用类似NSLog();的形式,只是对第三方库的一层简单封装

// 默认的宏,方便使用
#define WJSLog(frmt, ...)           WJSLogInfo(frmt, ##__VA_ARGS__)

// 提供不同的宏,对应到特定参数的对外接口
#define WJSLogError(frmt, ...)      DDLogError(frmt, ##__VA_ARGS__)
#define WJSLogWarning(frmt, ...)    DDLogWarn(frmt, ##__VA_ARGS__)
#define WJSLogInfo(frmt, ...)       DDLogInfo(frmt, ##__VA_ARGS__)
#define WJSLogDebug(frmt, ...)      DDLogDebug(frmt, ##__VA_ARGS__)
#define WJSLogVerbose(frmt, ...)    DDLogVerbose(frmt, ##__VA_ARGS__)

日志等级

typedef NS_OPTIONS(NSUInteger, DDLogFlag){
    /**
     *  0...00001 DDLogFlagError
     */
    DDLogFlagError      = (1 << 0),
    
    /**
     *  0...00010 DDLogFlagWarning
     */
    DDLogFlagWarning    = (1 << 1),
    
    /**
     *  0...00100 DDLogFlagInfo
     */
    DDLogFlagInfo       = (1 << 2),
    
    /**
     *  0...01000 DDLogFlagDebug
     */
    DDLogFlagDebug      = (1 << 3),
    
    /**
     *  0...10000 DDLogFlagVerbose
     */
    DDLogFlagVerbose    = (1 << 4)
};
#ifdef DEBUG
static const DDLogLevel ddLogLevel = DDLogLevelVerbose;
#else
static const DDLogLevel ddLogLevel = DDLogLevelWarning;
#endif
    // 对于Debug和verbose级别的日志,不发送到后台
    // 但我们依然要告诉 DDLog 这个存进去了。
    if ((DDLogLevelDebug == logMessage.flag) || (DDLogLevelVerbose == logMessage.flag)) {
        return YES;
    }

对第三方库CocoaLumberjack功能选择

#define kLogNumberThreshold    50        // 达到多少条就保存传后台
#define kLogTimeThreshold      (5 * 60)  // 间隔多少时间(单位:秒)就保存传后台

我们定义的是日志数量达到50条或者间隔时间达到5分钟,就往阿里云批量发送一次。

- (instancetype)init {
    self = [super init];
    if (self) {
        // 自定义的log,直接处理格式,不用代理。阿里云要求的是字典,不是字符串
        XXXLogger *logger = [[XXXLogger alloc] init];
        [DDLog addLogger:logger];
        
        // XCode的log,用自定义的输出格式,采用代理的格式
        XXXLogFormatter *formatter = [[XXXLogFormatter alloc] init];
        [[DDTTYLogger sharedInstance] setLogFormatter:formatter];
        [DDLog addLogger:[DDTTYLogger sharedInstance]]; // TTY = Xcode console
    }
    return self;
}

日志格式

- (NSString *)formatLogMessage:(DDLogMessage *)logMessage {
    NSString *logLevel = nil;
    switch (logMessage->_flag) {
        case DDLogFlagError:
            logLevel = @"[ERROR] >  ";
            break;
        case DDLogFlagWarning:
            logLevel = @"[WARN]  >  ";
            break;
        case DDLogFlagInfo:
            logLevel = @"[INFO]  >  ";
            break;
        case DDLogFlagDebug:
            logLevel = @"[DEBUG] >  ";
            break;
        default:
            logLevel = @"[VBOSE] >  ";
            break;
    }
    
    NSString *formatLog = [NSString stringWithFormat:@"%@ %@ %@ [line: %ld] %@",
                           logLevel, logMessage->_fileName, logMessage->_function,
                           logMessage->_line, logMessage->_message];
    return formatLog;
}

日志发送到阿里云

#import <AliyunLogObjc/AliyunLogObjc.h> 
LogClient *client = [[LogClient alloc] initWithApp: @"endpoint" accessKeyID:@"" accessKeySecret:@"" projectName:@""];
LogGroup *logGroup = [[LogGroup alloc] initWithTopic: @"" andSource:@""];
Log *log1 = [[Log alloc] init];
[log1 PutContent: @"Value" withKey: @"Key"];
[logGroup PutLog:log1];
[client PostLog:logGroup logStoreName: @"" call:^(NSURLResponse* _Nullable response,NSError* _Nullable error) {
    if (error != nil) {
    }
}];
#define kLogKeyLevel             @"level"            // 日志等级
#define kLogKeyFileName          @"file_name"        // 文件名或者说是类名
#define kLogKeyFunction          @"function"         // 函数名或者说是方法名
#define kLogKeyLine              @"line"             // 行数
#define kLogKeyContent           @"content"          // 日志内容
- (id _Nonnull )initWithApp:(NSString*_Nonnull) endPoint accessKeyID:(NSString *_Nonnull)ak accessKeySecret: (NSString *_Nonnull)as projectName: (NSString *_Nonnull)name;

- (void)PostLog:(LogGroup*_Nonnull)logGroup logStoreName:(NSString*_Nullable)name call:(void (^_Nullable)(NSURLResponse* _Nullable response,NSError* _Nullable error) )errorCallback;
- (void)PostLog:(LogGroup*)logGroup logStoreName:(NSString*)name call:(void (^)(NSURLResponse* _Nullable response,NSError* _Nullable error) )errorCallback {
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        // Force to use https api interface
        // Due to the requirement of Apple Security Policy after Jan. 1st, 2017
        // NSString *httpUrl = [NSString stringWithFormat:@"https://%@.%@/logstores/%@/shards/lb",_mProject,_mEndPoint,name];
        // 我们的阿里云服务不支持证书,这里改为http可以把log传到后台,否则用https就是证书不通过。
        NSString *httpUrl = [NSString stringWithFormat:@"http://%@.%@/logstores/%@/shards/lb",_mProject,_mEndPoint,name];
        NSData *httpPostBody = [[logGroup GetJsonPackage] dataUsingEncoding:NSUTF8StringEncoding];
        NSData *httpPostBodyZipped = [httpPostBody gzippedData];
        
        NSDictionary<NSString*,NSString*>* httpHeaders = [self GetHttpHeadersFrom:name url:httpUrl body:httpPostBody bodyZipped:httpPostBodyZipped];
        
        [self HttpPostRequest: httpUrl withHeaders:httpHeaders andBody:httpPostBodyZipped callback:errorCallback];
    });
}

关于本地缓存

- (void)saveLogsToLocalCache:(NSArray *)logs {
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        @synchronized (self) {
            NSString *key = nil;
            // 从0开始轮询,直到查到一个有空的;如果填满了,就覆盖最后一个
            for (NSInteger i = 0; i < 1000; i++) {
                key = [NSString stringWithFormat:@"Log%ld", (long)i];
                if (![self.localCache containsObjectForKey:key]) {
                    break;
                }
            }
            [self.localCache setObject:logs forKey:key];
        }
    });
}
- (void)sendLocalCacheLogsToAliyun {
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        @synchronized (self) {
            for (NSInteger i = 0; i < 1000; i++) {
                NSString *key = [NSString stringWithFormat:@"WJSLog%ld", i];
                NSArray *logs = (NSArray *)[self.localCache objectForKey:key];
                if ((nil == logs) || (0 == logs.count)) {
                    continue;
                }
                [self sendLogsToAliyun:logs success:^(NSURLResponse * _Nullable response) {
                    [self.localCache removeObjectForKey:key];
                } fail:nil]; 
            }
        }
    });
}

日志发送

@interface XXXLogSender : NSObject

// 将logs数组发送到阿里云,如果失败,会把这个logs存储在本地缓存中(内存缓存和磁盘缓存中都有)
+ (void)sendLogs:(NSArray *)logs;

@end
#import "XXXLogSender.h"
#import "LogClient.h"
#import "LogGroup.h"
#import "Log.h"
#import <YYCache/YYCache.h>
#import <AdSupport/AdSupport.h>

#define kEndpoint              @""      // 问运维要
#define kAccessKeyID           @""      // 问运维要
#define kAccessKeySecret       @""      // 问运维要
#define kProjectName           @""      // 问运维要
#define kLogStoreName          @""      // 问运维要

#define kLocalCacheName        @"XXXLogCache"    // 本地缓存的名字,YYCache要求的
// 留Log0 ~ Log999位置,填满就覆盖最后一个。每一个位置是一个logs数组。发送失败暂存本地
#define kMaxLocalCacheNumber   1000
// 轮询本地缓存,向阿里云发送日志的时间间隔
#define kSendLocalCacheLogsInterval        (1 * 60 * 60)

@interface XXXLogSender ()

@property (nonatomic, strong) LogClient *client;         // 阿里云日志发送对象 
@property (nonatomic, strong) YYCache *localCache;       // 本地缓存对象
@property (nonatomic, strong) dispatch_source_t timer;   // 本地缓存发送定时器

@end

@implementation XXXLogSender

# pragma mark interface
+ (void)sendLogs:(NSArray *)logs {
    [[XXXLogSender sharedInstance] sendLogsToAliyun:logs];
}

# pragma mark lifecycle
+ (instancetype)sharedInstance{
    static id sharedInstance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedInstance = [[self alloc] init];
    });
    return sharedInstance;
}

- (void)dealloc {
    if (nil != self.timer) {
        dispatch_cancel(self.timer);
        self.timer = nil;
    }
}

- (instancetype)init {
    self = [super init];
    if (self) {
        self.client = [[LogClient alloc] initWithApp:kEndpoint accessKeyID:kAccessKeyID accessKeySecret:kAccessKeySecret projectName:kProjectName];
        
        [self createTimer];
        
        self.localCache = [YYCache cacheWithName:kLocalCacheName];
    }
    return self;
}

# pragma mark private
- (void)sendLogsToAliyun:(NSArray *)logs {
    __weak __typeof(self)weakSelf = self;
    [self sendLogsToAliyun:logs success:nil fail:^(NSError * _Nullable error) {
        __strong __typeof(weakSelf)strongSelf = weakSelf;
        [strongSelf saveLogsToLocalCache:logs];
    }];
}

- (void)sendLogsToAliyun:(NSArray *)logs success:(void(^)(NSURLResponse * _Nullable response))successCallback fail:(void(^)(NSError * _Nullable error))failCallback {
    if ((nil == logs) || (0 == logs.count)) {
        return;
    }
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        NSString *topic = @"ios-log-native";       // 自定义的,跟运维商量好
        NSString *source = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];  // 广告id,用来标识来源手机,
        LogGroup *group = [[LogGroup alloc] initWithTopic:topic andSource:source];
        for (NSDictionary *sourceLog in logs) {
            Log *log = [[Log alloc] init];
            [log PutContent:sourceLog[kLogKeyLevel] withKey:kLogKeyLevel];
            [log PutContent:sourceLog[kLogKeyFileName] withKey:kLogKeyFileName];
            [log PutContent:sourceLog[kLogKeyFunction] withKey:kLogKeyFunction];
            [log PutContent:sourceLog[kLogKeyLine] withKey:kLogKeyLine];
            [log PutContent:sourceLog[kLogKeyContent] withKey:kLogKeyContent];
            [group PutLog:log];
        }
        [self.client PostLog:group logStoreName:kLogStoreName call:^(NSURLResponse * _Nullable response, NSError * _Nullable error) {
            if (nil == error) {
                if (nil != successCallback) {
                    successCallback(response);
                }
            } else {
                if (nil != failCallback) {
                    failCallback(error);
                }
            }
        }];
    });
}

- (void)saveLogsToLocalCache:(NSArray *)logs {
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        @synchronized (self) {
            NSString *key = nil;
            // 从0开始轮询,直到查到一个有空的;如果填满了,就覆盖最后一个
            for (NSInteger i = 0; i < kMaxLocalCacheNumber; i++) {
                key = [NSString stringWithFormat:@"WJSLog%ld", (long)i];
                if (![self.localCache containsObjectForKey:key]) {
                    break;
                }
            }
            [self.localCache setObject:logs forKey:key];
        }
    });
}

- (void)sendLocalCacheLogsToAliyun {
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        @synchronized (self) {
            for (NSInteger i = 0; i < kMaxLocalCacheNumber; i++) {
                NSString *key = [NSString stringWithFormat:@"WJSLog%ld", i];
                NSArray *logs = (NSArray *)[self.localCache objectForKey:key];
                if ((nil == logs) || (0 == logs.count)) {
                    continue;
                }
                [self sendLogsToAliyun:logs success:^(NSURLResponse * _Nullable response) {
                    [self.localCache removeObjectForKey:key];
                } fail:nil];
            }
        }
    });
}

- (void)createTimer {
    // 获得队列
    dispatch_queue_t queue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);
    // 创建一个定时器
    self.timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, queue);
    // 设置开始时间: 1秒之后
    dispatch_time_t start = dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC));
    // 设置时间间隔
    uint64_t interval = (uint64_t)(kSendLocalCacheLogsInterval * NSEC_PER_SEC);
    // 设置定时器
    dispatch_source_set_timer(self.timer, start, interval, 0);
    // 设置回调
    __weak __typeof(self)weakSelf = self;
    dispatch_source_set_event_handler(self.timer, ^{
        __strong __typeof(weakSelf)strongSelf = weakSelf;
        [strongSelf sendLocalCacheLogsToAliyun];
    });
    //由于定时器默认是暂停的所以我们启动一下
    //启动定时器
    dispatch_resume(self.timer);
}

@end

自定义logger

#import <CocoaLumberjack/DDAbstractDatabaseLogger.h>

@interface XXXLogger : DDAbstractDatabaseLogger

@end
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Override Me
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// 每次打log的时候都会进来,一般在这里把log搜集到一个数组中,等达到一定条件再统一发送
- (BOOL)db_log:(DDLogMessage *)logMessage {
    // Override me and add your implementation.
    //
    // Return YES if an item was added to the buffer.
    // Return NO if the logMessage was ignored.

    return NO;
}

// 等条件满足,默认的条件是日志书达到500条,或者,时间间隔超过1分钟,这个函数都会调用一下
// 这里是将log数组发送到阿里云的地方
- (void)db_save {
    // Override me and add your implementation.
}

// 下面两个是关于本地数据库删除的实现函数。我们其实并不需要本地数据库缓存,这两个函数可以不实现。
- (void)db_delete {
    // Override me and add your implementation.
}

- (void)db_saveAndDelete {
    // Override me and add your implementation.
}
#import "XXXLogger.h"
#import "XXXLogSender.h"

#define kLogNumberThreshold    50  // 达到多少条就保存传后台
#define kLogTimeThreshold      (5 * 60)  // 间隔多少时间(秒)就保存传后台

// 数组容量达到这个最大值的话,说明网络出了问题
#define kLogMaxCapacity        (kLogNumberThreshold * 10)

@interface XXXLogger ()

@property (nonatomic, strong) NSMutableArray *logs;

@end

@implementation XXXLogger

// 生命周期函数
- (void)dealloc {
    [[NSNotificationCenter defaultCenter] removeObserver:self];
}

- (instancetype)init {
    self = [super init];
    if (self) {
        self.logs = [NSMutableArray array];
        // 使用默认的配置。达到500条或者间隔1分钟就保存;磁盘数据库保留7天,删除操作间隔5分钟,这两个数据不关心,用基类的就可以了
        self.saveThreshold = kLogNumberThreshold;
        self.saveInterval = kLogTimeThreshold;
        
        // 监听UIApplicationWillResignActiveNotification消息,在程序进入后台前保存log
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(onWillResignActive:) name:UIApplicationWillResignActiveNotification object:nil];
    }
    return self;
}

// 重写父类函数
- (BOOL)db_log:(DDLogMessage *)logMessage {
    if ([self.logs count] > kLogMaxCapacity) {
        // 如果段时间内进入大量log,并且迟迟发不到服务器上,我们可以判断哪里出了问题,在这之后的log暂时不处理了。
        // 但我们依然要告诉DDLog这个存进去了。
        return YES;
    }
    
    // 对于Debug和verbose级别的日志,不发送到后台
    // 但我们依然要告诉 DDLog 这个存进去了。
    if ((DDLogLevelDebug == logMessage.flag) || (DDLogLevelVerbose == logMessage.flag)) {
        return YES;
    }
    
    // 将log放在缓存的数组中
    @synchronized (self) {
        // 阿里云要求字典格式的日志;而_logFormatter返回的是字符串,不符合;所以这里直接设置日志的格式
        // 自定义的log要传到阿里云后台,值处理3级log
        NSMutableDictionary *log = [NSMutableDictionary dictionary];
        switch (logMessage.flag) {
            case DDLogFlagError:
                log[kLogKeyLevel] = @"ERROR";
                break;
            case DDLogFlagWarning:
                log[kLogKeyLevel] = @"WARNING";
                break;
            default:
                log[kLogKeyLevel] = @"INFO";
                break;
        }
        log[kLogKeyFileName] = logMessage.fileName;
        log[kLogKeyFunction] = logMessage.function;
        log[kLogKeyLine] = [NSString stringWithFormat:@"%ld", (unsigned long)logMessage.line];
        log[kLogKeyContent] = logMessage.message;
        
        [self.logs addObject:[log copy]];
    }
    
    return YES;
}

- (void)db_save {
    //如果缓存内没数据,啥也不做
    if (0 == [self.logs count]) {
        return;
    }
    
    // 将缓存在数组中的logs传给后台,并清空缓存数组
    [XXXLogSender sendLogs:[self.logs copy]];
    @synchronized (self) {
        [self.logs removeAllObjects];
    }
}

// selector
// 手机退到后台,不管条件是否满足,都保存一次,也就是向阿里云发送一次
- (void)onWillResignActive:(NSNotification *)notification {
    dispatch_async(self.loggerQueue, ^{
        [self db_save];
    });
}

@end

实际效果

上一篇 下一篇

猜你喜欢

热点阅读