IOS 百行代码切面日志

AOPLogger

切面日志作用

说到日志,切面的实现最大的好处也就是分离出来,单独开发,包括埋点,记录输出log都可以在不影响项目内逻辑的情况下完成,形成完全的一个独立模块。

这里的切面日志,只是作为分离业务而用,所以它的作用只是记录,至于上传删除,这些逻辑同样可以分离出来单独写,存的过程解决了渗透入工程内,上传删除包括分级这些逻辑其实本身就很独立。

在实现上用了Aspects这个库,主要就是hook方法,用它主要是对一些例外情况处理不错,自己写简单实现其实就只写写方法交换剩下的就不管了。。。

下面说一下.h

#import <Foundation/Foundation.h>

extern NSString * const AOPLoggerMethod;//要统计的日志方法Key
extern NSString * const AOPLoggerLogInfo;//要统计的日志信息Key
extern NSString * const AOPLoggerPositionAfter;//方法执行后统计日志
extern NSString * const AOPLoggerPositionBefore;//方法执行前统计日志
extern NSString * const AOPLoggerPositionType;//执行日志统计的类型Key

@protocol AOPLoggerGetConfigInfoProtocol <NSObject>

@required

/**
 创建类扩展如果使用此协议必须实现此方法
 此方法返回统计的配置信息,可以从网络取也可以从本地取
 @return 统计配置字典
 */
-(NSDictionary*)al_getConfigInfo;

@end
@protocol AOPLoggerBLLProtocol <NSObject>

@required

/**
 创建类扩展如果使用此协议必须实现此方法
 此方法主要来处理切面方法后的log信息处理可以存本地也可以使用其他任意第三方输出
 @param log 配置文件里定义的AOPLoggerLogInfo信息
 @param originAOP AspectInfo的方法信息,第三方库Aspect返回的切面方法的所有信息
 */
-(void)al_logger:(id)log originAOP:(id)originAOP;

@end

@interface AOPLogger : NSObject


/**
 开始读取日志Plist配置文件
 */
+(void)startAOPLoggerWithPlist;

/**
 统计日志的调用方法
 (如果不想增加开机时间可以采取每个模块创建一个日志统计类适时调用,在该类里提供一个初始化方法,内部调用此即可)
 @param classString 类名
 @param methodString 方法名
 @param log 相当于AOPLoggerLogInfo信息
 */
+(void)AOPLoggerWithClassString:(NSString*)classString methodString:(NSString*)methodString log:(id)log;

/**
 统计日志的调用方法
 (如果不想增加开机时间可以采取每个模块创建一个日志统计类适时调用,在该类里提供一个初始化方法,内部调用此即可)
 @param classString 类名
 @param methodString 方法名
 @param log 相当于AOPLoggerLogInfo信息
 @param logPosition 日志统计时位置,可放在方法运行前或运行后(默认运行后执行日志统计)
 */
+(void)AOPLoggerWithClassString:(NSString *)classString methodString:(NSString *)methodString log:(id)log logPosition:(NSString*)logPosition;

@end

这里提供了两种方式一种直接读取自定义的Plist,一种就是调用类方法,而即使调用类方法,也是单独建一个类,某个模块的日志类负责记录,传入类名方法名统计信息即可,而plist得形式在初期还好,后期统计曾多可就真的太扯了毕竟要在初始化的时候加载遍历执行


QQ20170306-012628.png

定制扩展

由于每个项目想要做的事情或逻辑都会有不同,这里就可以根据我的协议实现对应的方法,来完成自己的业务需求
如下:

import "AOPLogger+Custom.h"
#import "Aspects.h"
#import <objc/runtime.h>

@implementation AOPLogger (Custom)

-(void)al_logger:(id)log originAOP:(id)originAOP{
    if ([log isKindOfClass:[NSString class]]) {
        NSLog(@"event:%@",log);
    }
    if ([log isKindOfClass:[NSDictionary class]]) {
        NSLog(@"eventName:%@\neventLabel:%@\neventTime:%@",log[@"EventName"],log[@"EventLabel"],[log[@"EventTime"] boolValue]?[NSDate date]:@"不用获取");
    }
    if (originAOP&&[originAOP conformsToProtocol:objc_getProtocol("AspectInfo")]) {
        id<AspectInfo> aspectInfo=originAOP;
        NSLog(@"originClass:%@\noriginSel:%@",NSStringFromClass([aspectInfo.originalInvocation.target class]),NSStringFromSelector(aspectInfo.originalInvocation.selector));

        for (NSInteger i=0; i<aspectInfo.arguments.count; i++) {
            NSLog(@"argument:%@",aspectInfo.arguments[i]);
        }
    }
}

@end

这里只是做了简单的NSLog操作,而当某个业务模块下需要不同处理的时候,不妨就直接hook这个方法添加逻辑,用法完全靠个人想像吧,其实用起来经常能处理很多神奇的逻辑,里面的originAOP如果用过Aspects这个库的话可能会很快明白为什么要选这个库不是自己写了,因为它的这块封装可以让我拿到对应方法执行完后返回的值,当然你得指定这个log是在原方法执行完成后执行,同理如果放在执行前执行log我们通过这个对象还可以拿到方法传递的参数。

再看.m的源码

#import "AOPLogger.h"
#import "Aspects.h"
#import <objc/runtime.h>

NSString * const AOPLoggerMethod=@"AOPLoggerMethod";
NSString * const AOPLoggerLogInfo=@"AOPLoggerLogInfo";
NSString * const AOPLoggerPositionAfter=@"AOPLoggerPositionAfter";
NSString * const AOPLoggerPositionBefore=@"AOPLoggerPositionBefore";
NSString * const AOPLoggerPositionType=@"AOPLoggerPositionType";

@implementation AOPLogger

+ (AOPLogger *)sharedAOPLogger {
    static AOPLogger *sharedAOPLogger = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedAOPLogger = [[self alloc] init];
    });
    return sharedAOPLogger;
}

+(void)startAOPLoggerWithPlist{
    NSDictionary *loggerConfigInfo=nil;
    if ([[AOPLogger sharedAOPLogger] conformsToProtocol:objc_getProtocol("AOPLoggerGetConfigInfoProtocol")]) {
        loggerConfigInfo=[(AOPLogger<AOPLoggerGetConfigInfoProtocol>*)[AOPLogger sharedAOPLogger] al_getConfigInfo];
    }
    else{
        loggerConfigInfo=[NSDictionary dictionaryWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"AOPLoggerConfig" ofType:@"plist"]];
    }
    
    for (NSString *className in loggerConfigInfo) {
        for (NSDictionary *eventInfo in loggerConfigInfo[className]) {
            Class clazz = NSClassFromString(className);
            SEL selector = NSSelectorFromString(eventInfo[AOPLoggerMethod]);
            AspectOptions positionOptions=AspectPositionAfter;
            if ([loggerConfigInfo[AOPLoggerPositionType] isEqualToString:AOPLoggerPositionAfter]) {
                positionOptions=AspectPositionAfter;
            }
            if ([loggerConfigInfo[AOPLoggerPositionType] isEqualToString:AOPLoggerPositionBefore]) {
                positionOptions=AspectPositionBefore;
            }

            [clazz aspect_hookSelector:selector
                           withOptions:AspectPositionAfter
                            usingBlock:^(id<AspectInfo> aspectInfo) {
                                id log=eventInfo[AOPLoggerLogInfo];
                                
                                if ([[AOPLogger sharedAOPLogger] conformsToProtocol:objc_getProtocol("AOPLoggerBLLProtocol")]) {
                                    [(AOPLogger<AOPLoggerBLLProtocol>*)[AOPLogger sharedAOPLogger] al_logger:log originAOP:aspectInfo];
                                }
                                else{
                                    if ([log isKindOfClass:[NSString class]]) {
                                        NSLog(@"AOPLogger:%@",log);
                                    }
                                }
                            } error:NULL];
            
        }
    }

}

+(void)AOPLoggerWithClassString:(NSString *)classString methodString:(NSString *)methodString log:(id)log{
    [self AOPLoggerWithClassString:classString methodString:methodString log:log logPosition:nil];
}

+(void)AOPLoggerWithClassString:(NSString *)classString methodString:(NSString *)methodString log:(id)log logPosition:(NSString*)logPosition{
    Class clazz = NSClassFromString(classString);
    SEL selector = NSSelectorFromString(methodString);
    AspectOptions positionOptions=AspectPositionAfter;
    if ([logPosition isEqualToString:AOPLoggerPositionAfter]) {
        positionOptions=AspectPositionAfter;
    }
    if ([logPosition isEqualToString:AOPLoggerPositionBefore]) {
        positionOptions=AspectPositionBefore;
    }
    
    [clazz aspect_hookSelector:selector
                   withOptions:positionOptions
                    usingBlock:^(id<AspectInfo> aspectInfo) {
                        if ([[AOPLogger sharedAOPLogger] conformsToProtocol:objc_getProtocol("AOPLoggerBLLProtocol")]) {
                            [(AOPLogger<AOPLoggerBLLProtocol>*)[AOPLogger sharedAOPLogger] al_logger:log originAOP:aspectInfo];
                        }
                        else{
                            if ([log isKindOfClass:[NSString class]]) {
                                NSLog(@"AOPLogger:%@",log);
                            }
                        }
                    } error:NULL];
    
}

核心处理.m直接不到百行,主要逻辑就是 单例初始化, 读取plist并格式化出执行的类 ·方法·log信息,最后就是利用AOP,切面hook对应方法插入我们统计逻辑。

有了这个库完全可以日志动态话统计,前提你要做好热更新或使用plist形式。

源码地址:https://github.com/heroims/AOPLogger

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,070评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,709评论 0 9
  • 木村在他的第一篇文章《木村拓哉》中将四个字拆分为自己身体的各个部分,的确是很神奇的笔法,却总觉得不怎么贴切。有趣的...
    看看木村看看你阅读 401评论 0 1
  • 日念亲人一处好,加持美好享幸福 第85天(2017.11.2) 1.念老公好:晚上洗碗时老公发现自动倒油壶漏油是因...
    轩轩妈慧子阅读 114评论 0 0