iOS面向切面的TableView-AOPTableView
這個是公司很久之前的開源專案，一個大牛寫的，在專案中一直有在用，今天有空發了點時間看下如何實現，看了之後感覺挺有收穫，故撰此文，分享給需要的同學。
該庫的開源地址：MeetYouDevs/IMYAOPTableView
概覽
WHY AOP TableView
關於為何使用AOP，在MeetYouDevs/IMYAOPTableView這個庫的簡介中已經有提及到了，主要是針對在我們資料流中接入廣告的這種場景，最原始的方法就是分別請求資料以及廣告，根據規則合併資料，分別處理業務資料和廣告資料的展示這個流程如下圖所示。這種方案的弊端就是有很明顯的耦合，廣告和正常的業務耦合在一起了，同時也違反了設計原則中的單一職責原則，所以這種方式是做的不夠優雅的，後期的維護成本也是比較大的。


那麼如何解決這個問題呢？如何使用一種不侵入業務的方式優雅的去解決這個問題呢？答案就是使用AOP，讓正常的業務和廣告並行獨立滴處理，下圖就是使用AOP方式處理資料流中接入廣告流程圖

HOW DESIGN AOP TableView
該如何設計一個可用AOP的TableView呢？設計中提到的一點是沒有什麼問題是通過新增一個層解決不了的，不行的話就在新增一個層！。AOP TableView中同樣是存在著這個處理層的，承擔著如下的職責：1、注入非業務的廣告內容；2、轉發不同的業務到不同的處理者；3、處理展示、業務、廣告之間的轉換關係；另外還有一些輔助的方法。
下面這張圖是AOPTableView設計類圖，IMYAOPTableViewUtils該類就是這一層，為了更加符合設計中的單一職責原則，通過分類的方式，這個類的功能被拆分在多個不同的模組中，比如處理delegate轉發的IMYAOPTableViewUtils (UITableViewDelegate)、處理dataSource轉發的IMYAOPTableViewUtils (UITableViewDataSource)，主要完成如下事務處理
- 注入廣告內容對應的位置
- 設定AOP
- 作為TableView的真實Delegate/DataSource
- 處理轉發Delegate/DataSource方法到業務或者廣告
- 處理delegate轉發 ->IMYAOPTableViewUtils (UITableViewDelegate)
- 處理dataSource轉發->IMYAOPTableViewUtils (UITableViewDataSource)

設定AOP

AOP設定的時序圖如上圖所示，以下是對應的程式碼，建立了IMYAOPTableViewUtils物件之後，需要注入 aop class ，主要的步驟如下：
- 儲存業務的Delegate/DataSource ->injectTableView方法處理
- 設定TableView的delegate/dataSource為IMYAOPBaseUtils -> injectFeedsView方法處理
- 動態建立TableView的子類 -> makeSubclassWithClass方法處理
- 並設定業務的TableView的isa指標 -> bindingFeedsView方法處理
- 設定動態建立TableView的子類的aop方法 -> setupAopClass方法處理
特別地：動態建立子類以及給動態建立的子類新增aop的方法，最終該子型別的處理方法會在 _IMYAOPTableView 類中，下面會講到 _IMYAOPTableView 類的用途
- (void)injectTableView {
UITableView *tableView = self.tableView;
_origDataSource = tableView.dataSource;
_origDelegate = tableView.delegate;
[self injectFeedsView:tableView];
}
#pragma mark - 注入 aop class
- (void)injectFeedsView:(UIView *)feedsView {
// 設定TableView的delegate為IMYAOPBaseUtils
// 設定TableView的dataSource為IMYAOPBaseUtils
struct objc_super objcSuper = {.super_class = [self msgSendSuperClass], .receiver = feedsView};
((void (*)(void *, SEL, id))(void *)objc_msgSendSuper)(&objcSuper, @selector(setDelegate:), self);
((void (*)(void *, SEL, id))(void *)objc_msgSendSuper)(&objcSuper, @selector(setDataSource:), self);
self.origViewClass = [feedsView class];
// 動態建立TableView的子類
Class aopClass = [self makeSubclassWithClass:self.origViewClass];
if (![self.origViewClass isSubclassOfClass:aopClass]) {
// isa-swizzle: 設定TableView的isa指標為建立的TableView子類
[self bindingFeedsView:feedsView aopClass:aopClass];
}
}
/**
isa-swizzle: 設定TableView的isa指標為建立的TableView子類
這裡需要注意的是KVO使用的也是isa-swizzle，設定了isa-swizzle之後需要把設定的KVO重新新增回去
*/
- (void)bindingFeedsView:(UIView *)feedsView aopClass:(Class)aopClass {
id observationInfo = [feedsView observationInfo];
NSArray *observanceArray = [observationInfo valueForKey:@"_observances"];
///移除舊的KVO
for (id observance in observanceArray) {
NSString *keyPath = [observance valueForKeyPath:@"_property._keyPath"];
id observer = [observance valueForKey:@"_observer"];
if (keyPath && observer) {
[feedsView removeObserver:observer forKeyPath:keyPath];
}
}
object_setClass(feedsView, aopClass);
///新增新的KVO
for (id observance in observanceArray) {
NSString *keyPath = [observance valueForKeyPath:@"_property._keyPath"];
id observer = [observance valueForKey:@"_observer"];
if (observer && keyPath) {
void *context = NULL;
NSUInteger options = 0;
@try {
Ivar _civar = class_getInstanceVariable([observance class], "_context");
if (_civar) {
context = ((void *(*)(id, Ivar))(void *)object_getIvar)(observance, _civar);
}
Ivar _oivar = class_getInstanceVariable([observance class], "_options");
if (_oivar) {
options = ((NSUInteger(*)(id, Ivar))(void *)object_getIvar)(observance, _oivar);
}
/// 不知道為什麼，iOS11 返回的值 會填充8個位元組。。 128
if (options >= 128) {
options -= 128;
}
} @catch (NSException *exception) {
IMYLog(@"%@", exception.debugDescription);
}
if (options == 0) {
options = (NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew);
}
[feedsView addObserver:observer forKeyPath:keyPath options:options context:context];
}
}
}
#pragma mark - install aop method
/**
動態建立TableView的子類
*/
- (Class)makeSubclassWithClass:(Class)origClass {
NSString *className = NSStringFromClass(origClass);
NSString *aopClassName = [kAOPFeedsViewPrefix stringByAppendingString:className];
Class aopClass = NSClassFromString(aopClassName);
if (aopClass) {
return aopClass;
}
aopClass = objc_allocateClassPair(origClass, aopClassName.UTF8String, 0);
// 設定動態建立的子類的aop方法，真實處理方法是在_IMYAOPTableView類中的aop_字首的方法
[self setupAopClass:aopClass];
objc_registerClassPair(aopClass);
return aopClass;
}
/**
設定動態建立的子類的aop方法，這裡做了省略
*/
- (void)setupAopClass:(Class)aopClass {
///純手動敲打
[self addOverriteMethod:@selector(class) aopClass:aopClass];
[self addOverriteMethod:@selector(setDelegate:) aopClass:aopClass];
// ....
///UI Calling
[self addOverriteMethod:@selector(reloadData) aopClass:aopClass];
[self addOverriteMethod:@selector(layoutSubviews) aopClass:aopClass];
[self addOverriteMethod:@selector(setBounds:) aopClass:aopClass];
// ....
///add real reload function
[self addOverriteMethod:@selector(aop_refreshDataSource) aopClass:aopClass];
[self addOverriteMethod:@selector(aop_refreshDelegate) aopClass:aopClass];
// ....
// Info
[self addOverriteMethod:@selector(numberOfSections) aopClass:aopClass];
[self addOverriteMethod:@selector(numberOfRowsInSection:) aopClass:aopClass];
// ....
// Row insertion/deletion/reloading.
[self addOverriteMethod:@selector(insertSections:withRowAnimation:) aopClass:aopClass];
[self addOverriteMethod:@selector(deleteSections:withRowAnimation:) aopClass:aopClass];
// ....
// Selection
[self addOverriteMethod:@selector(indexPathForSelectedRow) aopClass:aopClass];
[self addOverriteMethod:@selector(indexPathsForSelectedRows) aopClass:aopClass];
// ....
// Appearance
[self addOverriteMethod:@selector(dequeueReusableCellWithIdentifier:forIndexPath:) aopClass:aopClass];
}
- (void)addOverriteMethod:(SEL)seletor aopClass:(Class)aopClass {
NSString *seletorString = NSStringFromSelector(seletor);
NSString *aopSeletorString = [NSString stringWithFormat:@"aop_%@", seletorString];
SEL aopMethod = NSSelectorFromString(aopSeletorString);
[self addOverriteMethod:seletor toMethod:aopMethod aopClass:aopClass];
}
- (void)addOverriteMethod:(SEL)seletor toMethod:(SEL)toSeletor aopClass:(Class)aopClass {
// 這裡的這個implClass在AOPTableViewUtils中為_IMYAOPTableView
Class implClass = [self implAopViewClass];
Method method = class_getInstanceMethod(implClass, toSeletor);
if (method == NULL) {
method = class_getInstanceMethod(implClass, seletor);
}
const char *types = method_getTypeEncoding(method);
IMP imp = method_getImplementation(method);
// 新增aopClass也就是建立的子型別kIMYAOP_UITableView的處理方法，真實處理方法是在_IMYAOPTableView類中的
class_addMethod(aopClass, seletor, imp, types);
}
複製程式碼_IMYAOPTableView的職責是在業務端直接使用TableView對應的方法的時候，把業務的規則轉換為真實列表的規則，比如下面的業務端呼叫了cellForRowAtIndexPath這個方法，會走到如下的方法中，這裡的indexPath是業務自己的indexPath，比如在列表可見的第五個位置，但是前面是有兩個廣告，在業務端的邏輯中該indexPath對應的位置是在第三個位置的，所以需要進行修正，返回正確的IndexPath，獲取到對應位置的Cell，這樣才不會有問題
- (UITableViewCell *)aop_cellForRowAtIndexPath:(NSIndexPath *)indexPath {
AopDefineVars;
if (aop_utils) {
// 修復業務使用的indexPath為真實的indexPath
indexPath = [aop_utils feedsIndexPathByUser:indexPath];
}
aop_utils.isUICalling += 1;
UITableViewCell *cell = AopCallSuperResult_1(@selector(cellForRowAtIndexPath:), indexPath);
aop_utils.isUICalling -= 1;
return cell;
}
複製程式碼使用AOP
非業務資料插入
IMYAOPBaseUtils類提供了兩個方法用於非業務資料的處理
///插入sections 跟 indexPaths
- (void)insertWithSections:(nullable NSArray<__kindof IMYAOPBaseInsertBody *> *)sections;
- (void)insertWithIndexPaths:(nullable NSArray<__kindof IMYAOPBaseInsertBody *> *)indexPaths;
// 實現
- (void)insertWithIndexPaths:(NSArray<IMYAOPBaseInsertBody *> *)indexPaths {
NSArray<IMYAOPBaseInsertBody *> *array = [indexPaths sortedArrayUsingComparator:^NSComparisonResult(IMYAOPBaseInsertBody *_Nonnull obj1, IMYAOPBaseInsertBody *_Nonnull obj2) {
return [obj1.indexPath compare:obj2.indexPath];
}];
NSMutableDictionary *insertMap = [NSMutableDictionary dictionary];
[array enumerateObjectsUsingBlock:^(IMYAOPBaseInsertBody *_Nonnull obj, NSUInteger idx, BOOL *_Nonnull stop) {
NSInteger section = obj.indexPath.section;
NSInteger row = obj.indexPath.row;
NSMutableArray *rowArray = insertMap[@(section)];
if (!rowArray) {
rowArray = [NSMutableArray array];
[insertMap setObject:rowArray forKey:@(section)];
}
while (YES) {
BOOL hasEqual = NO;
for (NSIndexPath *inserted in rowArray) {
if (inserted.row == row) {
row++;
hasEqual = YES;
break;
}
}
if (hasEqual == NO) {
break;
}
}
NSIndexPath *insertPath = [NSIndexPath indexPathForRow:row inSection:section];
[rowArray addObject:insertPath];
obj.resultIndexPath = insertPath;
}];
self.sectionMap = insertMap;
}
複製程式碼呼叫insertWithIndexPaths插入非業務的廣告資料，這裡插入的資料是位置
///簡單的rows插入
- (void)insertRows {
NSMutableArray<IMYAOPTableViewInsertBody *> *insertBodys = [NSMutableArray array];
///隨機生成了5個要插入的位置
for (int i = 0; i < 5; i++) {
NSIndexPath *indexPath = [NSIndexPath indexPathForRow:arc4random() % 10 inSection:0];
[insertBodys addObject:[IMYAOPTableViewInsertBody insertBodyWithIndexPath:indexPath]];
}
///清空 舊資料
[self.aopUtils insertWithSections:nil];
[self.aopUtils insertWithIndexPaths:nil];
///插入 新資料, 同一個 row 會按陣列的順序 row 進行 遞增
[self.aopUtils insertWithIndexPaths:insertBodys];
///呼叫tableView的reloadData，進行頁面重新整理
[self.aopUtils.tableView reloadData];
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
NSLog(@"%@", self.aopUtils.allModels);
});
}
複製程式碼在demo中使用瞭如上的程式碼呼叫，sectionMap中儲存的資料如下，key為section，value是對應section下所有插入資料的IndexPath陣列，sectionMap資料會用於處理真實資料和業務資料之間的對映

userIndexPathByFeeds方法使用sectionMap處理真實indexPath和業務indexPath之間的變換
// 獲取業務對應的indexPath，該方法的作用是進行indexPath，比如真實的indexPath為(0-5)，前面插入了兩個廣告，會把indexPath修復為業務的indexPath，也就是(0-3)，如果該位置是廣告的位置，那麼返回nil空值
- (NSIndexPath *)userIndexPathByFeeds:(NSIndexPath *)feedsIndexPath {
if (!feedsIndexPath) {
return nil;
}
NSInteger section = feedsIndexPath.section;
NSInteger row = feedsIndexPath.row;
NSMutableArray<NSIndexPath *> *array = self.sectionMap[@(section)];
NSInteger cutCount = 0;
for (NSIndexPath *obj in array) {
if (obj.row == row) {
cutCount = -1;
break;
}
if (obj.row < row) {
cutCount++;
} else {
break;
}
}
if (cutCount < 0) {
return nil;
}
///如果該位置不是廣告， 則轉為邏輯index
section = [self userSectionByFeeds:section];
NSIndexPath *userIndexPath = [NSIndexPath indexPathForRow:row - cutCount inSection:section];
return userIndexPath;
}
複製程式碼AOP代理方法回撥

如上圖所示，IMYAOPTableViewUtils作為中間層承擔了作為TableView的delegate和dataSource的職責，在改類中處理對應事件的轉發到具體的處理者：業務端或者是非業務的廣告端
比如下面的獲取cell的代理方法tableView:cellForRowAtIndexPath:，首先會進行indexPath的修復，然後判斷是業務的還是非業務的，然後使用不同的dataSource進行相應的處理，程式碼段有做了註釋，詳情參加註釋的解釋
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
kAOPUICallingSaved;
kAOPUserIndexPathCode;
UITableViewCell *cell = nil;
if ([dataSource respondsToSelector:@selector(tableView:cellForRowAtIndexPath:)]) {
cell = [dataSource tableView:tableView cellForRowAtIndexPath:indexPath];
}
if (![cell isKindOfClass:[UITableViewCell class]]) {
cell = [UITableViewCell new];
if (dataSource) {
NSAssert(NO, @"Cell is Nil");
}
}
kAOPUICallingResotre;
return cell;
}
// 巨集定義的程式碼段，使用者是判斷該位置是否是業務使用的IndexPath，是的話返回業務的DataSource->origDataSource，否則返回非業務的DataSource->dataSource
#define kAOPUserIndexPathCode \
NSIndexPath *userIndexPath = [self userIndexPathByFeeds:indexPath]; \
id<IMYAOPTableViewDataSource> dataSource = nil; \
if (userIndexPath) { \
dataSource = (id)self.origDataSource; \
indexPath = userIndexPath; \
} else { \
dataSource = self.dataSource; \
isInjectAction = YES; \
} \
if (isInjectAction) { \
self.isUICalling += 1; \
}
// 獲取業務對應的indexPath，該方法的作用是進行indexPath，比如真實的indexPath為(0-5)，前面插入了兩個廣告，會把indexPath修復為業務的indexPath，也就是(0-3)，如果該位置是廣告的位置，那麼返回nil空值
- (NSIndexPath *)userIndexPathByFeeds:(NSIndexPath *)feedsIndexPath {
if (!feedsIndexPath) {
return nil;
}
NSInteger section = feedsIndexPath.section;
NSInteger row = feedsIndexPath.row;
NSMutableArray<NSIndexPath *> *array = self.sectionMap[@(section)];
NSInteger cutCount = 0;
for (NSIndexPath *obj in array) {
if (obj.row == row) {
cutCount = -1;
break;
}
if (obj.row < row) {
cutCount++;
} else {
break;
}
}
if (cutCount < 0) {
return nil;
}
///如果該位置不是廣告， 則轉為邏輯index
section = [self userSectionByFeeds:section];
NSIndexPath *userIndexPath = [NSIndexPath indexPathForRow:row - cutCount inSection:section];
return userIndexPath;
}
複製程式碼結束
就先寫到這了，如果不妥之處敬請賜教