iOS模式分析 使用介面卡模式重構TableView

本文介紹了介面卡模式的定義和概念，以及實際開發中的場景和案例，對應的程式碼可以在AdapterPatternDemo這裡下載到。

1. 定義

什麼是介面卡模式？（電源介面卡、轉接頭）
特點：

• 將一個原始介面轉成客戶端需要的介面
• 原始介面不相容現在新的介面，將它們兩個介面一起工作需要介面卡解決

2. 應用場景

• 介面不相容（介面卡模式）
• 可以重複使用的類，用於與一些彼此之間沒有太大關聯的一些類一起工作（介面卡模式）
• 統一輸出介面，輸入的型別無法確定（介面卡模式）

3. 角色劃分

• 第一個角色：介面卡（最核心關鍵角色）
• 第二個角色：目標介面
• 第三個角色：被適配類（角色）
• 第四個角色：客戶端

4. 案例

4.1 案例說明

將美元(被適配物件—>Adaptee)——>人民幣(目標介面——>Target)
介面卡將美元轉成人民幣(Adaper)

4.2 定義Target協議

#import <Foundation/Foundation.h>

@protocol TargetProtocal <NSObject>

- (NSInteger)getCNY;

@end
複製程式碼

4.3 定義被適配的物件類Adaptee

// USDAdaptee.h
#import <Foundation/Foundation.h>

@interface USDAdaptee : NSObject

- (void)setUSD:(NSInteger)usd;
- (NSInteger)getUSD;

@end


// USDAdaptee.m
#import "USDAdaptee.h"

@interface USDAdaptee ()
@property (nonatomic, assign) NSInteger usd;
@end

@implementation USDAdaptee

- (void)setUSD:(NSInteger)usd {
    _usd = usd;
}

- (NSInteger)getUSD {
    return _usd;
}

@end
複製程式碼

4.4 使用物件介面卡

物件介面卡使用的是組合的模式，介面卡類實現Target協議，並且在介面卡類中定義一個Adaptee的屬性，重寫協議返回對Adaptee屬性物件做相應的轉換操作，來達到讓Adaptee適配Target的目的。

// CNYObjectAdapter.h
#import <Foundation/Foundation.h>
#import "USDAdaptee.h"
#import "TargetProtocal.h"

@interface CNYObjectAdapter : NSObject <TargetProtocal>

@property (nonatomic, strong) USDAdaptee* usd;
- (instancetype)initWithUSD:(USDAdaptee*)usd;

@end

// CNYObjectAdapter.m
#import "CNYObjectAdapter.h"

@implementation CNYObjectAdapter

- (instancetype)initWithUSD:(USDAdaptee*)usd {
    self = [super init];
    if (self) {
        _usd = usd;
    }
    return self;
}

- (NSInteger)getCNY {
    return _usd.getUSD * 6.8;
}

@end
複製程式碼

4.5 使用類介面卡

類介面卡使用的是繼承的模式，介面卡類實現Target協議，並且該介面卡類繼承Adaptee類，在重寫的Target協議方法中使用super呼叫Adaptee的方法做相應的轉換操作，來達到讓Adaptee適配Target的目的。

// CNYClassAdapter.h
#import <Foundation/Foundation.h>
#import "USDAdaptee.h"
#import "TargetProtocal.h"

@interface CNYClassAdapter : USDAdaptee <TargetProtocal>

@end


// CNYClassAdapter.m
#import "CNYClassAdapter.h"

@implementation CNYClassAdapter

- (NSInteger)getCNY {
    return [self getUSD] * 6.8;
}

@end
複製程式碼

4.6 客戶端使用

    // 類介面卡的使用
    CNYClassAdapter* cnyClsAdapter = [CNYClassAdapter new];
    [cnyClsAdapter setUSD:1000];
    NSInteger cny = [cnyClsAdapter getCNY];
    NSLog(@"CNYClassAdapter ==> cny = %@", @(cny));
    
    // 物件介面卡的使用
    USDAdaptee* usd = [USDAdaptee new];
    [usd setUSD:1000];

    CNYObjectAdapter* cnyObjAdapter = [[CNYObjectAdapter alloc] initWithUSD:usd];
    NSInteger cny2 = [cnyObjAdapter getCNY];
    NSLog(@"CNYClassAdapter ==> cny = %@", @(cny2));

    // 結果輸出
    //  CNYClassAdapter ==> cny = 6800
    // CNYClassAdapter ==> cny = 6800    
複製程式碼

5. 真實開發案例

真實的開發案例中，會從一般的開發步驟說起，首先對一般的場景程式碼進行重構，把列表UITableVIewDataSource/UITableViewDelegate獨立為一個簡單的介面卡；然後在此基礎上進行抽象和擴充套件，構建一個更加靈活和易擴充套件的複雜列表介面卡。

5.1 一般的開發步驟

一般的，在做一個列表的展示資料的時候，我們習慣的把建立列表、建立列表資料、註冊列表的cell、實現列表的UITableVIewDataSource/UITableViewDelegate方法等步驟放在ViewController來完成，類似如下的程式碼，這種方法在簡單的列表中看不出弊端，如果這個ViewController中新增了其他更多的邏輯、程式碼、這個類就顯得十分龐大了；此外其他的頁面有用到這個一樣的列表只是資料不同，那麼還得重新去實現這個步驟，列表的這部分邏輯不能夠複用，產生了冗餘的程式碼，don't repeat yourself，這很糟糕，所以很有必要重構這段程式碼，讓他能夠很好的進行復用，使用介面卡模式就能夠很好的做到這點。下面會講到一個簡單點的介面卡和一個複雜點的介面卡，來重構我們的程式碼。

@implementation SimpleViewController

- (void)viewDidLoad {
    // 處理UI和資料的步驟省略....
  
    // retister cell
    [self.tableView registerClass:[GameCell class] forCellReuseIdentifier:NSStringFromClass([GameCell class])];
    
}

#pragma mark - ......::::::: UITableViewDelegate :::::::......

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
    return _datas.count;
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
    GameCell* cell = [tableView dequeueReusableCellWithIdentifier:NSStringFromClass([GameCell class])];
    GameModel* gameModel = _datas[indexPath.row];
    [cell loadData:gameModel indexPath:indexPath];
    return cell;
}

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
    [tableView deselectRowAtIndexPath:indexPath animated:YES];
    
    UITableViewCell* cell = [tableView cellForRowAtIndexPath:indexPath];
}
@end
複製程式碼

5.2 簡單的列表介面卡

簡單的列表介面卡就是把和UITableVIewDataSource/UITableViewDelegate相關的程式碼獨立出來，來減輕ViewController，實現起來也很簡單:

// SimpleAdapter.h
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

@interface SimpleAdapter : NSObject <UITableViewDelegate, UITableViewDataSource>
- (instancetype)initWithTableView:(UITableView*)tableView datas:(NSMutableArray*)datas;
@end


// SimpleAdapter.m
#import "SimpleAdapter.h"
#import "GameCell.h"
#import "GameModel.h"

@interface SimpleAdapter ()
@property (nonatomic, strong) NSMutableArray* datas;
@end

@implementation SimpleAdapter

- (instancetype)initWithTableView:(UITableView*)tableView datas:(NSMutableArray*)datas {
    self = [super init];
    if (self) {
        // retister cell
        [tableView registerClass:[GameCell class] forCellReuseIdentifier:NSStringFromClass([GameCell class])];
        _datas = datas;
    }
    return self;
}

- (void)dealloc {
    NSLog(@"=====SimpleAdapter dealloc=====");
}

#pragma mark - ......::::::: UITableViewDelegate :::::::......

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
    return _datas.count;
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
    GameCell* cell = [tableView dequeueReusableCellWithIdentifier:NSStringFromClass([GameCell class])];
    GameModel* gameModel = _datas[indexPath.row];
    [cell loadData:gameModel indexPath:indexPath];
    return cell;
}

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
    [tableView deselectRowAtIndexPath:indexPath animated:YES];
    
    UITableViewCell* cell = [tableView cellForRowAtIndexPath:indexPath];
}

@end
複製程式碼

5.3 簡單列表介面卡的使用

簡單列表介面卡的使用十分的簡單，把TableVIew的delegate和DataSource設定為Adapter物件就行了，並且列表的介面卡複用也變得十分的方便了，當然使用這種方法在一些複雜的場景就不那麼適用了，下面會在簡單列表介面卡的基礎上進行擴充套件，也就是複雜的列表介面卡，適用於更復雜的更一般性的場景，並且具有良好的擴張性。

@implementation SimpleAdapterViewController

- (void)viewDidLoad {
    // 處理UI和資料的步驟省略....
    
    self.adapter = [[SimpleAdapter alloc] initWithTableView:self.tableView datas:datas];
    self.tableView.dataSource = self.adapter;
    self.tableView.delegate = self.adapter;
}
@end
複製程式碼

5.4 複雜的列表介面卡

5.4.1 複雜的列表介面卡層級分析

複雜列表介面卡分為三個層

1. Cell介面卡層
2. Section介面卡層
3. List列表介面卡層

這三個層可以是獨立的存在，同時地底層也可以作為高層的依賴，使用組合的方式實現擴充套件。
對應的建立三個層的協議：

// Cell介面卡層->CellAdapterProtocal
@protocol CellAdapterProtocal <NSObject, UITableViewDelegate, UITableViewDataSource>
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section;
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath;
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;
@end

// Section介面卡層->SectionAdapterProtocal
@protocol SectionAdapterProtocal <NSObject, UITableViewDelegate, UITableViewDataSource>
- (CGFloat)tableView:(UITableView *)tableView heightForHeaderInSection:(NSInteger)section;
- (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section;
- (UIView *)tableView:(UITableView *)tableView viewForHeaderInSection:(NSInteger)section;
- (CGFloat)tableView:(UITableView *)tableView heightForFooterInSection:(NSInteger)section;
- (UIView *)tableView:(UITableView *)tableView viewForFooterInSection:(NSInteger)section;
@end

// List列表介面卡層->ListAdapterProtocal
@protocol ListAdapterProtocal <NSObject, SectionAdapterProtocal, CellAdapterProtocal>
- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView;
@end
複製程式碼

5.4.2 對應層的Base實現

對應層需要做一個Base的實現，目的是為了把通用的工作放在Base實現類中，把差異的工作放到子類中，這樣達到複用程式碼和減少實現程式碼的目的。

• Cell介面卡層的Base實現

@implementation BaseCellAdapter

- (instancetype)initWithTableView:(UITableView*)tableView datas:(NSMutableArray*)datas {
    self = [super init];
    if (self) {
        // retister cell
        for (Class claz in [self registerCellClasses]) {
            [tableView registerClass:claz forCellReuseIdentifier:NSStringFromClass(claz)];
        }
        _datas = datas;
    }
    return self;
}

#pragma mark - ......::::::: UITableViewDelegate :::::::......
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
    return self.datas.count;
}

#pragma mark - ......::::::: override :::::::......
- (NSArray*)registerCellClasses {
    return nil;
}
@end
複製程式碼

• Section介面卡層的Base實現

Section介面卡層除了做了和列表Section展示有關的工作，還負責做Cell展示相關的工作，所以Section介面卡層依賴了Cell介面卡層，需要把Cell介面卡層用到的內容轉發給Cell介面卡層，轉發這部分使用了OC中的轉發來減少程式碼量，使用的的方法為respondsToSelector和forwardingTargetForSelector，具體可以看下面的程式碼。

// BaseSectionAdapter.h
@interface BaseSectionAdapter : NSObject <SectionAdapterProtocal, CellAdapterProtocal>

@property (nonatomic, strong) NSString* sectionTitle;
@property (nonatomic, assign) NSInteger sectionHeight;
@property (nonatomic, strong) id<CellAdapterProtocal> cellAdapter;

- (instancetype)initWithCellAdapter:(id<CellAdapterProtocal>)cellAdapter sectionTitle:(NSString*)sectionTitle sectionHeight:(NSInteger)sectionHeight;

@end

// BaseSectionAdapter.m
@implementation BaseSectionAdapter

- (instancetype)initWithCellAdapter:(id<CellAdapterProtocal>)cellAdapter sectionTitle:(NSString*)sectionTitle sectionHeight:(NSInteger)sectionHeight {
    self = [super init];
    if (self) {
        _cellAdapter = cellAdapter;
        _sectionTitle = sectionTitle;
        _sectionHeight = sectionHeight;
    }
    return self;
}

#pragma mark - ......::::::: Section Handler :::::::......

- (CGFloat)tableView:(UITableView *)tableView heightForHeaderInSection:(NSInteger)section {
    return self.sectionHeight;
}

- (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section {
    return self.sectionTitle;
}

- (UIView *)tableView:(UITableView *)tableView viewForHeaderInSection:(NSInteger)section {
    return nil;
}

- (CGFloat)tableView:(UITableView *)tableView heightForFooterInSection:(NSInteger)section {
    return 0;
}

- (UIView *)tableView:(UITableView *)tableView viewForFooterInSection:(NSInteger)section {
    return nil;
}


#pragma mark - ......::::::: Cell Handler :::::::......
#pragma mark 使用事件轉發處理Cell

- (BOOL)respondsToSelector:(SEL)aSelector
{
    BOOL responds = [super respondsToSelector:aSelector];
    if (!responds && self.cellAdapter != self) {
        responds = [self.cellAdapter respondsToSelector:aSelector];
    }
    return responds;
}

- (id)forwardingTargetForSelector:(SEL)aSelector {
    if ([self.cellAdapter respondsToSelector:aSelector]) {
        return self.cellAdapter;
    }
    return self;
}

@end
複製程式碼

• List列表介面卡層的Base實現

List列表介面卡層主要是做一個整合的實現，需要把對應的事件轉發給對應的Section介面卡層，Section介面卡層再負責把對應的事件轉發給Cell介面卡層。

// BaseListAdapter.h
@interface BaseListAdapter : NSObject <ListAdapterProtocal>
@property (nonatomic, strong) NSMutableArray<id<SectionAdapterProtocal>>* sections;
@end

// BaseListAdapter.m
@implementation BaseListAdapter 

#pragma mark - ......::::::: Section Handler :::::::......

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView {
    return self.sections.count;
}

#pragma mark - ......::::::: Section Handler :::::::......

- (CGFloat)tableView:(UITableView *)tableView heightForHeaderInSection:(NSInteger)section {
    id<SectionAdapterProtocal> sectionAdapter = self.sections[section];
    return [sectionAdapter tableView:tableView heightForHeaderInSection:section];
}

- (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section {
    id<SectionAdapterProtocal> sectionAdapter = self.sections[section];
    return [sectionAdapter tableView:tableView titleForHeaderInSection:section];
}

- (UIView *)tableView:(UITableView *)tableView viewForHeaderInSection:(NSInteger)section {
    id<SectionAdapterProtocal> sectionAdapter = self.sections[section];
    return [sectionAdapter tableView:tableView viewForHeaderInSection:section];
}

- (CGFloat)tableView:(UITableView *)tableView heightForFooterInSection:(NSInteger)section {
    id<SectionAdapterProtocal> sectionAdapter = self.sections[section];
    return [sectionAdapter tableView:tableView heightForFooterInSection:section];
}

- (UIView *)tableView:(UITableView *)tableView viewForFooterInSection:(NSInteger)section {
    id<SectionAdapterProtocal> sectionAdapter = self.sections[section];
    return [sectionAdapter tableView:tableView viewForFooterInSection:section];
}

#pragma mark - ......::::::: Cell Handler :::::::......

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
    id<SectionAdapterProtocal> cellAdapter = self.sections[section];
    return [cellAdapter tableView:tableView numberOfRowsInSection:section];
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
    id<SectionAdapterProtocal> cellAdapter = self.sections[indexPath.section];
    return [cellAdapter tableView:tableView cellForRowAtIndexPath:indexPath];
}

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
    id<SectionAdapterProtocal> cellAdapter = self.sections[indexPath.section];
    return [cellAdapter tableView:tableView didSelectRowAtIndexPath:indexPath];
}

@end
複製程式碼

5.4.3 具體的介面卡

• 具體的Cell介面卡

@implementation GameCellAdapter

#pragma mark - ......::::::: UITableViewDelegate :::::::......

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
    GameCell* cell = [tableView dequeueReusableCellWithIdentifier:NSStringFromClass([GameCell class])];
    GameModel* gameModel = self.datas[indexPath.row];
    [cell loadData:gameModel indexPath:indexPath];
    return cell;
}

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
    [tableView deselectRowAtIndexPath:indexPath animated:YES];
    
    UITableViewCell* cell = [tableView cellForRowAtIndexPath:indexPath];
}


#pragma mark - ......::::::: override :::::::......
- (NSArray*)registerCellClasses {
    return @[[GameCell class]];
}

@end
複製程式碼

• 具體的Section介面卡

簡單的定義了一個GameSectionAdapter繼承了BaseSectionAdapter，沒有更多的擴充套件，實際情況可以在這邊新增更多自定義功能的程式碼，來擴充套件Section的功能。

@interface GameSectionAdapter : BaseSectionAdapter
@end

@implementation GameSectionAdapter
@end
複製程式碼

• 具體的List介面卡
  和GameSectionAdapter一樣，List介面卡一般是比較固定的，一般的可以直接使用BaseListAdapter來完成對應的工作，無需額外的工作，這裡作為Demo還是簡單的繼承BaseListAdapter實現一個自定義的List介面卡，這裡可以直接使用BaseListAdapter達到相同的效果。

@interface GameDetailListAdapter : BaseListAdapter
@end

@implementation GameDetailListAdapter
@end
複製程式碼

5.4.4 複雜介面卡的使用

複雜介面卡需要建立CellAdapter物件、SectionAdapter物件、ListAdapter物件，進行組合，最後用ListAdapter物件作為列表的delegate和dataSource。

@implementation SectionAdapterViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    // 處理UI和資料的步驟省略....
    
    GameCellAdapter* cellAdapter = [[GameCellAdapter alloc] initWithTableView:self.tableView datas:datas];
    GameSectionAdapter* fpsSectionAdapter = [[GameSectionAdapter alloc] initWithCellAdapter:cellAdapter sectionTitle:@"FPS Games" sectionHeight:60];
    GameSectionAdapter* roleSectionAdapter = [[GameSectionAdapter alloc] initWithCellAdapter:cellAdapter sectionTitle:@"Role Play Games" sectionHeight:60];

    self.adapter = [[GameDetailListAdapter alloc] init];
    self.adapter.sections = [@[fpsSectionAdapter, roleSectionAdapter] mutableCopy];
    
    self.tableView.dataSource = self.adapter;
    self.tableView.delegate = self.adapter;
}

@end
複製程式碼

實現的效果如下圖：

6. UML分析

7. Demo

本文的Demo可以在AdapterPatternDemo這裡下載到