在.h中定义Static全局变量的风险

结论:

全局变量不可在.h中定义,要在.m中定义。 如果外界需要修改 可在.h中extern或者.h提供修改API才是正道。

踩坑背景:

功能要求:框架内部封装打印DebugLog信息,并向外提供控制LogEnable的接口。

XXLog.h
//暂时忽略多线程下调用加锁的问题
static BOOL kLoggingEnabled = NO;
#define XXDebug(fmt,...) XXLog(fmt, ## __VA_ARGS__);
static inline void XXLog(NSString *format, ...) {
    //NSLog(@"%p = %@",&kLoggingEnabled,[NSString stringWithFormat:@"%d",kLoggingEnabled]);
    if (!kLoggingEnabled) return;
    va_list arg_list;
    va_start (arg_list, format);
    NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
    NSLog(@"[XXLog]: %@", formattedString);
    va_end(arg_list);
}

XXKit.h
//向外提供了控制内部打印的接口
+ (void)setEnableLog:(BOOL)enableLog;
+ (BOOL)getEnableLog;


XXKit.m
#import “XXLog.h”

+ (void)setEnableLog:(BOOL)enableLog {
    kLoggingEnabled = enableLog;
}
+ (BOOL)getEnableLog {
    return kLoggingEnabled;
}

- (void)testA {
   ....
   XXDebug(@"Log info!!!");
   ....
}


OtherFile.m
#import “XXLog.h”

- (void)otherFunc {
   ....
   XXDebug(@"OtherFile Log info!!!");
   ....
}

结果现象:

当外界调用 [XXKit setEnableLog: ![XXKit getEnableLog]]; 仅仅能控制XXKit文件下的Log信息输出与否,而OtherFile.m下的XXDebug信息始终不输出!!

分析:

上述代码思路:定义一个全局BOOL变量和真实Log方法,在Log方法开始,判断BOOL值 enable = NO则return,而向外提供的接口只需更改这个全局变量的值即可。而且在.h中实现 简洁省去了.m 满足了强迫症和装逼心理 : )

但思考编译原理即可知晓: 当import 一个.h时,预编译会简单的把.h中内容Copy进来,所以当XXKit.m 和 OhterFile.m 分别import了XXLog.h后 编译后的结果为:

XXKit.m

//替换#import “XXLog.h”的结果
static BOOL kLoggingEnabled = NO;
#define XXDebug(fmt,...) XXLog(fmt, ## __VA_ARGS__);
static inline void XXLog(NSString *format, ...) {
    //NSLog(@"%p = %@",&kLoggingEnabled,[NSString stringWithFormat:@"%d",kLoggingEnabled]);
    if (!kLoggingEnabled) return;
    va_list arg_list;
    va_start (arg_list, format);
    NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
    NSLog(@"[XXLog]: %@", formattedString);
    va_end(arg_list);
}

......


OtherFile.m

//替换#import “XXLog.h”的结果
static BOOL kLoggingEnabled = NO;
#define XXDebug(fmt,...) XXLog(fmt, ## __VA_ARGS__);
static inline void XXLog(NSString *format, ...) {
    //NSLog(@"%p = %@",&kLoggingEnabled,[NSString stringWithFormat:@"%d",kLoggingEnabled]);
    if (!kLoggingEnabled) return;
    va_list arg_list;
    va_start (arg_list, format);
    NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
    NSLog(@"[XXLog]: %@", formattedString);
    va_end(arg_list);
}
......

这就会导致每一个import “XXLog.h”的.m中 都有一个 static BOOL kLoggingEnabled变量(static变量的作用域是一个编译单元即当前文件)所以当每个文件下调用XXDebug宏 即调用XXLog方法打印信息时,XXLog方法中的kLoggingEnabled变量都是当前文件下的static全局变量,而外界通过调用[XXKit setEnableLog:] 方法只更改了XXKit.m中全局变量的值,而其他文件下的全局变量BOOL值依然是默认的NO。所以导致上述现象中只有XXKit文件下的Log可控,其他文件Log始终不输出。

正确代码思路:

在.m中定义全局变量并使用extern提供给外界,在.m中控制全局变量的值,这样保证全局只有这一个变量而保证外界调用API更改后,Log方法能够正确return。 Talk is cheap,show me the code!

XXLog.h

extern BOOL kLoggingEnabled;
#define XXDebug(fmt,...) XXLog(fmt, ## __VA_ARGS__);
static inline void XXLog(NSString *format, ...) {
    //NSLog(@"%p = %@",&kLoggingEnabled,[NSString stringWithFormat:@"%d",kLoggingEnabled]);
    if (!kLoggingEnabled) return;
    va_list arg_list;
    va_start (arg_list, format);
    NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
    NSLog(@"[XXLog]: %@", formattedString);
    va_end(arg_list);
}


XXKit.h
//向外提供了控制内部打印的接口
+ (void)setEnableLog:(BOOL)enableLog;
+ (BOOL)getEnableLog;


XXKit.m
#import “XXLog.h”

//定义全局变量
BOOL kLoggingEnabled = NO;

+ (void)setEnableLog:(BOOL)enableLog {
    kLoggingEnabled = enableLog;
}
+ (BOOL)getEnableLog {
    return kLoggingEnabled;
}

- (void)testA {
   ....
   XXDebug(@"Log info!!!");
   ....
}


OtherFile.m
#import “XXLog.h”

- (void)otherFunc {
   ....
   XXDebug(@"OtherFile Log info!!!");
   ....
}

或者写成对的XXLog.h 和 XXLog.m , 将定义全局变量的活自己全干了(可移植使用)

XXLog.h

#define XXDebug(fmt,...) XXLog(fmt, ## __VA_ARGS__);

void XXLog(NSString *format, ...);
void setLogEnable(BOOL enable);
BOOL logEnable(void);


XXLog.m

static BOOL kLoggingEnabled = NO;
void XXLog(NSString *format, ...) {
    //NSLog(@"%p = %@",&kLoggingEnabled,[NSString stringWithFormat:@"%d",kLoggingEnabled]);
    if (!kLoggingEnabled) return;
    va_list arg_list;
    va_start (arg_list, format);
    NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
    NSLog(@"[XXLog]: %@", formattedString);
    va_end(arg_list);
}

void setLogEnable(BOOL enable) {
    kLoggingEnabled = enable;
}

BOOL logEnable(void) {
    return kLoggingEnabled;
}

优化加锁:

加锁问题:可将全部操作放到主队列简单省事 或者 加锁

  1. 队列执行
#define XXDebug(fmt,...)\
dispatch_async(dispatch_get_main_queue(), ^{ XXLog(fmt, ## __VA_ARGS__); })

2.加锁执行

XXLog.m

static BOOL kLoggingEnabled = NO;
static NSString *kLockObj = @"kLockConstantObj";

void XXLog(NSString *format, ...) {
    @synchronized(kLockObj) {
        //NSLog(@"%p = %@",&kLoggingEnabled,[NSString stringWithFormat:@"%d",kLoggingEnabled]);
        if (!kLoggingEnabled) return;
        va_list arg_list;
        va_start (arg_list, format);
        NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
        NSLog(@"[XXLog]: %@", formattedString);
        va_end(arg_list);
    }
}

void setLogEnable(BOOL enable) {
    @synchronized(kLockObj) {
        kLoggingEnabled = enable;
    }
}

BOOL logEnable(void) {
    @synchronized(kLockObj) {
        return kLoggingEnabled;
    }
}



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

推荐阅读更多精彩内容