【OC梳理】多播代理

常見的通訊方式

首先，對OC中常見的通信方式咱們作一個對比（KVC與KVO不在討論範圍）：

	代理	通知	Block
適用範圍	一對一	一對多	一對一
使用方式	方法調用	通知名(字符串)監聽	屬性、方法參數、全局變量
是否容許返回值	YES	NO	YES
是否具備封閉性	YES	NO	YES

假如咱們須要一種能夠一對多，同時又須要有返回值（或者出於安全性考慮不但願公開）的狀況，通知就不適用了，考慮下面的情形：

• 使用一個單例控制藍牙鏈接斷開等狀態，可是有好幾個類都須要監聽藍牙的狀態？
• 但願App可以一鍵切換主題？
• 異步加載多種資源，想獲取總的加載進度？

多播代理

C#中有一種委託形式稱做多播委託，會順序執行多個委託對象的對應函數。 OC中系統並無提供相似的類型讓咱們使用，因此須要本身實現相似的功能。

多播代理相對於通知的優點

	多播代理	通知
接收範圍	定點投放，只有已添加的代理能夠接收到消息	全局均可接收，會暴露實現細節，廣播出的參數中可能包含敏感信息
使用方式	方法調用，使用協議來約束代理者的方法實現	通知名(字符串)監聽，容易出現問題，當項目中大量使用通知之後難以維護，極端狀況會出現通知名重複的問題
是否容許返回值	YES	NO
是否具備封閉性	YES	NO

多播代理的實現思路

1.存儲多個代理對象

OC中常規代理一般使用弱引用來避免循環引用，所以咱們的多播代理中也須要使用可以存儲弱引用對象的容器，這裏有幾種思路：

• 使用NSValue的valueWithNonretainedObject:方法將對象打包，而後將打包後的NSValue對象添加到代理數組中。
• 建立一個新的類，在這個類中對代理對象進行弱引用（實質是對上一個思路的手動實現）。而後再將這個新類的實例添加到代理數組中。
• 使用NSHashTable存儲代理對象，咱們用到一個比較不常見的容器：NSHashTable

NSHashTable

iOS6之後，Foundation框架中新增了容器類：NSHashTable —— 它是可變的，沒有一個不變的類與其對應。它的做用對應於NSMutableSet，可是它能夠經過設置NSPointerFunctionsOptions參數來指定對象的引用類型：

NSHashTableStrongMemory：將容器內的對象引用計數+1一次(即strong)
NSHashTableCopyIn：將添加到容器的對象經過NSCopying中的方法，複製一個新的對象存入容器(即copy)
NSHashTableZeroingWeakMemory：使用weak存儲對象，當對象被銷燬的時候自動將其從集合中移除。(已棄用)
NSHashTableObjectPointerPersonality： 使用移位指針(shifted pointer)來作hash檢測及肯定兩個對象是否相等(而不是使用NSObject中的hash方法)
NSHashTableWeakMemory：不會修改容器內對象元素的引用計數，而且對象釋放後，會被自動移除(即weak)
複製代碼

ps NSHashTableWeakMemory的對象釋放後，NSHashTable中實際上是置空（NSHashTable能夠保存空對象），但遍歷時不會遍歷到該對象，相對於移除了。

2.添加代理對象

基於上面的選擇，咱們使用 NSHashTable 來管理存儲和遍歷代理對象，所以須要公開一個添加代理的方法：

- (void)addDelegate:(id <xxxProtocol>)newDelegate;
複製代碼

3.調用代理方法

調用常規代理時，一般須要寫如下寫法：

if ([delegate respondsToSelector:@selector(<#方法名#>:)]) {
    [delegate <#方法名#>:<#參數#>];
}
複製代碼

那麼假如咱們的代理協議中有多個方法，咱們就須要對每一個代理方法都寫一次這樣的代碼，至關繁瑣。 一般的簡化方法是利用OC的消息轉發機制，在方法轉發過程當中進行消息轉發。

簡單的多播代理流程

基於以上的思路，咱們能夠有一個大體的流程圖：

改進方案

上面的方案實現了簡單的多播代理，可是有一些缺陷：

• 若是該MutableDelegate類中有一個方法和代理協議中定義的方法同名，將致使消息轉發的過程不會觸發。
• 若是項目中須要用到多個多播代理，則須要實現屢次上面的方法
• 多線程問題

1. 定義多代理轉發類

這個類用來封裝多代理實現，咱們使用NSProxy子類來實現它：

@interface MulitiDelegate : NSProxy

/**
 建立
 @return MulitiDelegate對象
 */
+ (instancetype)new;

/**
 添加代理
 */
- (void)addDelegate:(id)delegate;

/**
 移除代理
 */
- (void)removeDelete:(id)delegate;

@end
複製代碼

2. 處理多線程同步問題

使用信號量解決多線程集合對象的同步問題:

//...
/// 信號量
@property ( nonatomic, strong ) dispatch_semaphore_t semaphore;
//...

/// 初始化
+ (id)alloc{
    MulitiDelegate *instance = [super alloc];
    if (instance) {
        instance.semaphore = dispatch_semaphore_create(1);
        instance.delegates = [NSHashTable weakObjectsHashTable];
    }
    return instance;
}

/// 添加代理
- (void)addDelegate:(id)delegate{
    dispatch_semaphore_wait(_semaphore, DISPATCH_TIME_FOREVER);
    [_delegates addObject:delegate];
    dispatch_semaphore_signal(_semaphore);
}

/// 移除代理
- (void)removeDelete:(id)delegate{
    dispatch_semaphore_wait(_semaphore, DISPATCH_TIME_FOREVER);
    [_delegates removeObject:delegate];
    dispatch_semaphore_signal(_semaphore);
}

#pragma mark - 消息轉發部分
- (NSMethodSignature *)methodSignatureForSelector:(SEL)selector {
    dispatch_semaphore_wait(_semaphore, DISPATCH_TIME_FOREVER);
    NSMethodSignature *methodSignature;
    for (id delegate in _delegates) {
        if ([delegate respondsToSelector:selector]) {
            methodSignature = [delegate methodSignatureForSelector:selector];
            break;
        }
    }
    dispatch_semaphore_signal(_semaphore);
    if (methodSignature){
        return methodSignature;
    }
    // 未找到方法時，返回默認方法 "- (void)method"，防止崩潰
    return [NSMethodSignature signatureWithObjCTypes:"v@:"];
}

- (void)forwardInvocation:(NSInvocation *)invocation {
    dispatch_semaphore_wait(_semaphore, DISPATCH_TIME_FOREVER);
    // 爲了不形成遞歸死鎖，copy一份delegates而不是直接用信號量將for循環包裹
    NSHashTable *copyDelegates = [_delegates copy];
    dispatch_semaphore_signal(_semaphore);
    
    SEL selector = invocation.selector;
    for (id delegate in copyDelegates) {
        if ([delegate respondsToSelector:selector]) {
            // 異步調用時，拷貝一個Invocation，以避免意外修改target致使crash
            NSInvocation *dupInvocation = [self copyInvocation:invocation];
            dupInvocation.target = delegate;
            // 異步調用多代理方法，以避免響應不及時
            dispatch_async(dispatch_get_global_queue(0, 0), ^{
                [dupInvocation invoke];
            });
        }
    }
}

- (NSInvocation *)copyInvocation:(NSInvocation *)invocation {
    SEL selector = invocation.selector;
    NSMethodSignature *methodSignature = invocation.methodSignature;
    NSInvocation *copyInvocation = [NSInvocation invocationWithMethodSignature:methodSignature];
    copyInvocation.selector = selector;
    
    NSUInteger count = methodSignature.numberOfArguments;
    for (NSUInteger i = 2; i < count; i++) {
        void *value;
        [invocation getArgument:&value atIndex:i];
        [copyInvocation setArgument:&value atIndex:i];
    }
    [copyInvocation retainArguments];
    return copyInvocation;
}

複製代碼

使用方式

這裏用一個簡單的一鍵切換主題的例子來講明多播代理的使用方式：

主題管理器（ThemesManager）

建立一個單例主題管理器來管理咱們的主題顏色，並可以添加和移除代理:

@protocol ThemesDelegate <NSObject>

/// 主題顏色改變
- (void)themesColorChanged:(UIColor *)themesColor;

@end

@interface ThemesManager : NSObject

/// 主題顏色
@property ( nonatomic, copy ) UIColor *themesColor;

/// 獲取單例
+ (instancetype)sharedManager;

/// 添加、移除代理
- (void)addDelegate:(id<ThemesDelegate>)delegate;
- (void)removeDelegate:(id<ThemesDelegate>)delegate;

@end

複製代碼

在.m文件中須要實現單例（單例的代碼建議定義成一個通用的宏定義，方便其餘地方一塊兒使用），而後使用以前定義的多播代理來進行「廣播」:

#import "ThemesManager.h"
#import "MulitiDelegate.h"

@interface ThemesManager()

/// 多播代理
@property ( nonatomic, strong ) MulitiDelegate *delegateProxy;

@end

@implementation ThemesManager
@synthesize themesColor = _themesColor;

static ThemesManager *_manager = nil;

+ (instancetype)sharedManager{
    return [[self alloc]init];
}

+ (instancetype)allocWithZone:(struct _NSZone *)zone{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        if (_manager == nil) {
            _manager = [super allocWithZone:zone];
        }
    });
    return _manager;
}
- (nonnull id)copyWithZone:(nullable NSZone *)zone {
    return _manager;
}

- (nonnull id)mutableCopyWithZone:(nullable NSZone *)zone {
    return _manager;
}

- (MulitiDelegate *)delegateProxy{
    if (!_delegateProxy) {
        _delegateProxy = [MulitiDelegate new];
    }
    return _delegateProxy;
}

- (void)addDelegate:(id<ThemesDelegate>)delegate {
    [self.delegateProxy addDelegate:delegate];
}

- (void)removeDelegate:(id<ThemesDelegate>)delegate {
    [self.delegateProxy removeDelete:delegate];
}

- (void)setThemesColor:(UIColor *)themesColor{
    _themesColor = [themesColor copy];
    [(id<ThemesDelegate>)self.delegateProxy themesColorChanged:_themesColor];
}

- (UIColor *)themesColor{
    if (!_themesColor) {
        // 默認顏色
        _themesColor = [UIColor colorWithWhite:0.8f alpha:1.f];
    }
    return _themesColor;
}

@end
複製代碼

控制器們

一般咱們會有一個專門的改變主題的界面和一些其餘界面，這裏就簡單的使用同一個界面跳轉和改變主題顏色:

#import "ThemesManager.h"

@interface ViewController ()<ThemesDelegate>

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    self.title = [NSString stringWithFormat:@"%d",self.index];
    [[ThemesManager sharedManager]addDelegate:self];
    self.view.backgroundColor = [ThemesManager sharedManager].themesColor;
}

- (IBAction)changeThemes:(id)sender {
    [ThemesManager sharedManager].themesColor = [self randomColor];
}

- (UIColor *)randomColor {
    // 生成隨機顏色
    CGFloat hue = arc4random() % 100 / 100.0; //色調：0.0 ~ 1.0
    CGFloat saturation = (arc4random() % 50 / 100) + 0.5; //飽和度：0.5 ~ 1.0
    CGFloat brightness = (arc4random() % 50 / 100) + 0.5; //亮度：0.5 ~ 1.0
    return [UIColor colorWithHue:hue saturation:saturation brightness:brightness alpha:1];
}

- (IBAction)nextVC:(id)sender {
    // 使用Storyboard建立VC
    UIStoryboard *story = [UIStoryboard storyboardWithName:@"Main" bundle:[NSBundle mainBundle]];
    ViewController *newVC = [story instantiateViewControllerWithIdentifier:@"ViewController"];
    newVC.index = self.index + 1;
    [self.navigationController pushViewController:newVC animated:YES];
}

#pragma mark - ThemesDelegate
- (void)themesColorChanged:(UIColor *)themesColor{
    // 須要注意的是這裏是異步調用，改變顏色須要在主線程
    dispatch_async(dispatch_get_main_queue(), ^{
        self.view.backgroundColor = themesColor;
    });
}

@end
複製代碼

調用流程

運行效果

最後加上返回值的獲取代碼，主要就是如何存儲和判斷類型，這裏就不贅述了。

目前已開源到GitHub上，並支持pods使用啦~ 喜歡的能夠給個Star哦