实现NS_ENUM的自定义反射

原创文章转载请注明出处,谢谢

最近在项目中遇到一个问题,我们的业务逻辑中存在4种Purpose Type,每种Purpose Type又有5种Status type,所以就有20种组合,每种组合出来的type都会对应一个string,而且未来type的数量可能会越来越多,所以这个如果用switch,if等来操作判断对应的字符串显然是不合理的,太冗余不利于扩展,采用数据字典的方式也不太好还需要自己手动建,每次更新也要手动修改,最好的方式是我们可以直接通过两个type就组合出对应的string,但是OC中反射只是针对于Class,对于基础类型的操作我们只能依赖于C++来帮我们完成。

如下有这两个enum,可以组合成20种type的string

typedef NS_ENUM(NSUInteger, BMTAccountType) {
  kBMTAccountTypeUnknow = 0,
  kBMTAccountTypeConception = 1,
  kBMTAccountTypeContraception = 2,
  kBMTAccountTypeMenstruation = 4,
  kBMTAccountTypePregnancyMonitor = 8,
};


typedef NS_ENUM(NSInteger, BMTMenstruationPeriodStatusType) {
  kReportCalendarDayTypeUnknown = -1,
  kReportCalendarDayTypeNormal,    
  kReportCalendarDayTypeMenustration,
  kReportCalendarDayTypeOvulation,
  kReportCalendarDayTypeCalculateMenstruation,
  kReportCalendarDayTypeOvulationDays
};

我们的目标是可以自动组合成以下的方式直接调用(命名不是很优雅)。

Hint.kBMTAccountTypeConception.kReportCalendarDayTypeNormal.Title = "XXX";
Hint.kBMTAccountTypeConception.kReportCalendarDayTypeOvulation.Title = "XXX";
Hint.kBMTAccountTypeConception.kReportCalendarDayTypeMenustration.Title = "XXX";
Hint.kBMTAccountTypeConception.kReportCalendarDayTypeOvulationDays.Title = "XXX";

Hint.kBMTAccountTypeContraception.kReportCalendarDayTypeNormal.Title = "XXX";
Hint.kBMTAccountTypeContraception.kReportCalendarDayTypeOvulation.Title = "XXX";
Hint.kBMTAccountTypeContraception.kReportCalendarDayTypeMenustration.Title = "XXX";
Hint.kBMTAccountTypeContraception.kReportCalendarDayTypeOvulationDays.Title = "XXX";

Hint.kBMTAccountTypeMenstruation.kReportCalendarDayTypeNormal.Title = "XXX";
Hint.kBMTAccountTypeMenstruation.kReportCalendarDayTypeOvulation.Title = "XXX";
Hint.kBMTAccountTypeMenstruation.kReportCalendarDayTypeMenustration.Title = "XXX";
Hint.kBMTAccountTypeMenstruation.kReportCalendarDayTypeOvulationDays.Title = "XXX";

Hint.kBMTAccountTypePregnancyMonitor.kReportCalendarDayTypeNormal.Title = "XXX";
Hint.kBMTAccountTypePregnancyMonitor.kReportCalendarDayTypeOvulation.Title = "XXX";
Hint.kBMTAccountTypePregnancyMonitor.kReportCalendarDayTypeMenustration.Title = "XXX";
Hint.kBMTAccountTypePregnancyMonitor.kReportCalendarDayTypeOvulationDays.Title = "XXX";

我们的基本思路是自定义NS_ENUM,然后使用__VA_ARGS__进行字符串解析,去除空格和等号,最后反射出结果,如下:

#ifndef BMT_REFLECT_ENUM_H
#define BMT_REFLECT_ENUM_H

NSString *reflectString(NSString *enumDefinition, NSNumber *number);

__attribute__((overloadable)) NSString *BMTReflectStringForMember(NSInteger value);

#define BMT_REFLECTABLE_ENUM(type, name, ...) \
typedef NS_ENUM(type, name) { \
__VA_ARGS__ \
}; \
\
__attribute__((overloadable)) static inline NSString *BMTReflectStringForMember(name value) { \
  return reflectString(@(#__VA_ARGS__), @(value)); \
} \


#endif

- (NSArray *)makeArray:(id(^)(id obj))block {
  NSMutableArray *array = [NSMutableArray arrayWithCapacity:[self count]];
  for(id obj in self) {
    [array addObject:block(obj)];
  }
  return array;
}

- (void)setupWithEnumDefinition:(NSString *)enumDefinition {
  NSNumberFormatter *numberFormatter = [NSNumberFormatter new];
  numberFormatter.numberStyle = NSNumberFormatterDecimalStyle;
  
  NSInteger currentIndex = -1;
  NSMutableDictionary *mutableDictionary = [NSMutableDictionary new];
  
  for (NSString *member in [enumDefinition componentsSeparatedByString:@","]) {
    NSArray *parts = [[member componentsSeparatedByString:@"="] makeArray:^NSString *(NSString *element) {
      return [element stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
    }];
    
    NSAssert(parts.count == 1 || parts.count == 2, @"Reflect Enum illegal member definition");
    
    NSString *name = [parts firstObject];
    if (parts.count == 2) {
      NSString *valueString = [parts lastObject];
      NSNumber *number = [numberFormatter numberFromString:valueString];
      
      if (!number) {
        NSAssert(NO, @"Reflect Enum get string for the enum with duplicated values");
      } else {
        NSString *matchingObject = [mutableDictionary objectForKey:number];
        if (matchingObject) {
          NSAssert(NO, @"Reflect Enum get string for the enum with duplicated values");
        }
      }
      
      currentIndex = [number longLongValue];
    } else {
      currentIndex++;
    }
    mutableDictionary[@(currentIndex)] = name;
  }
  
  _mapFromValueToString = [mutableDictionary copy];
}

这里有几个需要注意点:

* 我们需要缓存每个枚举解析后的值,防止浪费资源

* 我们的反射枚举类型中不能包括相同的枚举值,key-value是唯一对应的

// Demo one
REFLECTABLE_ENUM(NSInteger,
   ThirdEnum,
   ThirdEnum1 = 0,
   ThirdEnum2 = ThirdEnum1,
   ThirdEnum3,
   ThirdEnum4
);

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

推荐阅读更多精彩内容