虽然NSNotification一直被人所诟病（消息乱飞过于灵活、传值表意不明等），但在一些情况下我们还不得不使用它，准确地说是使用这种一对多且无视视图层级的传值方式。比较典型的如在登录页面登录，然后需要刷新TabBarController中已经存在的页面；再如在一个用户页面点了关注，需要刷新在一个已存在的且无关联的页面中对于该用户的关注按钮状态。
本文即是提供一种思路，使用NSProxy来替代自定义的NSNotification，从而避免开头说到的问题。（为什么说替代自定义的NSNotification，因为系统级的通知如UIKeyboardDidShowNotification等还是必须用NSNotification）。
NSProxy是什么
这里并不会展开介绍，你只要知道它是一个代理，仅用于转发消息就行了，具体可以看下这篇文章。
实现
其实说到转发消息，可能你已经猜到要怎么做了。没错，就是在NSProxy的一个单例里维护一个方法名到接收消息的对象的字典，然后直接用NSProxy的单例调用方法，继而转发给实际接受方法的对象。
接下来建议配合Demo理解。核心代码量比较小，我这里也贴一份。
// XNGNotificationProxy.h
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@interface XNGNotificationProxy : NSProxy
+ (instancetype)sharedProxy;
- (void)registerProtocol:(Protocol *)protocol forObject:(id)obj;
@end
NS_ASSUME_NONNULL_END
// XNGNotificationProxy.m
#import "XNGNotificationProxy.h"
#import <objc/runtime.h>
@interface XNGNotificationProxy ()
// { method1: [obj1, obj2], method2: [obj3, obj4], ... }
@property(nonatomic, strong) NSMutableDictionary<NSString *, NSHashTable *> *methodDictionary;
// for self.methodDictionary thread safty
@property(nonatomic, strong) dispatch_queue_t modificationQueue;
@end
@implementation XNGNotificationProxy
+ (instancetype)sharedProxy {
static XNGNotificationProxy *proxy;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
proxy = [XNGNotificationProxy alloc];
proxy.methodDictionary = [NSMutableDictionary dictionary];
proxy.modificationQueue = dispatch_queue_create("com.notificationProxy.modification", DISPATCH_QUEUE_SERIAL);
});
return proxy;
}
- (void)registerProtocol:(Protocol *)protocol forObject:(id)obj {
NSParameterAssert(protocol);
NSParameterAssert(obj);
NSAssert([obj conformsToProtocol:protocol], @"object %@ does not conform to protocol: %@", obj, protocol);
NSArray *methodNames = [XNGNotificationProxy getAllMethodNamesInProtocol:protocol];
for (NSString *name in methodNames) {
dispatch_sync(self.modificationQueue, ^{
NSHashTable *hashTable = self.methodDictionary[name];
if (!hashTable.anyObject) {
hashTable = [NSHashTable weakObjectsHashTable];
}
[hashTable addObject:obj];
self.methodDictionary[name] = hashTable;
});
}
}
#pragma mark - Override Method
- (NSMethodSignature *)methodSignatureForSelector:(SEL)sel {
for (id obj in [self objectsInHashTableForSelector:sel]) {
if ([obj respondsToSelector:sel]) {
return [obj methodSignatureForSelector:sel];
}
}
// if this method returns nil, a selector not found exception is raised.
// https://github.com/facebookarchive/AsyncDisplayKit/pull/1562
return [NSMethodSignature signatureWithObjCTypes:"@^v^c"];
}
- (void)forwardInvocation:(NSInvocation *)invocation {
for (id obj in [self objectsInHashTableForSelector:invocation.selector]) {
if ([obj respondsToSelector:invocation.selector]) {
[invocation invokeWithTarget:obj];
}
}
}
#pragma mark - Private Method
- (NSArray *)objectsInHashTableForSelector:(SEL)sel {
__block NSArray *objects;
dispatch_sync(self.modificationQueue, ^{
objects = self.methodDictionary[NSStringFromSelector(sel)].allObjects;
});
return objects;
}
+ (void)enumerateMethodsInProtocol:(Protocol *)protocol
isRequired:(BOOL)isRequired
usingBlock:(void (^)(struct objc_method_description method))block {
unsigned int methodsCountInProtocol = 0;
struct objc_method_description *methods = protocol_copyMethodDescriptionList(protocol, isRequired, YES, &methodsCountInProtocol);
for (unsigned int i = 0; i < methodsCountInProtocol; i++) {
struct objc_method_description method = methods[i];
!block ?: block(method);
}
free(methods);
}
+ (NSArray *)getAllMethodNamesInProtocol:(Protocol *)protocol {
NSMutableArray *methodNames = [NSMutableArray array];
[self enumerateMethodsInProtocol:protocol
isRequired:YES
usingBlock:^(struct objc_method_description method) {
[methodNames addObject:NSStringFromSelector(method.name)];
}];
[self enumerateMethodsInProtocol:protocol
isRequired:NO
usingBlock:^(struct objc_method_description method) {
[methodNames addObject:NSStringFromSelector(method.name)];
}];
return [methodNames copy];
}
@end
我会先讲用法，然后才分析代码实现。
怎么用
设想一种常见场景，我在页面VC_U关注了一个用户，然后需要在与VC_U无关联的VC_A和VC_B页面刷新对该用户的关注状态。如果用NSNotification，那么大概会是这样
// VC_U.m
[[NSNotificationCenter defaultCenter] postNotificationName:@"UserDidFollowUser"
object:nil
userInfo:@{@"isFollowed": @(YES), @"userID": @(123456)}];
// VC_A.m or VC_B.m
[[NSNotificationCenter defaultCenter] addObserverForName:@"UserDidFollowUser"
object:nil
queue:nil
usingBlock:^(NSNotification * _Nonnull note) {
BOOL isFollowed = [note.userInfo[@"isFollowed"] boolValue];
NSNumber *userID = note.userInfo[@"userID"];
}];
各种字符串常量，即使我们可以通过定义一些全局字符串常量来缓解这个问题，但想知道userInfo里有什么，还是得扒下postNotification处的代码，非常不直观了。
那么改用XNGNotificationProxy呢？
首先声明一个protocol
@protocol UserActionProtocol <NSObject>
@optional
- (void)userDidFollow:(BOOL)isFollowed userID:(NSNumber *)userID;
@end
然后让XNGNotificationProxy遵循这个protocol，如果你无法改动XNGNotificationProxy的源码，可以采用创建XNGNotificationProxy的category的方法来实现。
// XNGNotificationProxy+Protocol.h
@interface XNGNotificationProxy (Protocol) <UserActionProtocol>
@end
然后
// VC_U.m
[[XNGNotificationProxy sharedProxy] userDidFollow:YES userID:@(123456)];
// VC_A.m
@interface VC_A () <UserActionProtocol>
@end
// -viewDidLoad 或者其他某个地方，来注册这个protocol
[[XNGNotificationProxy sharedProxy] registerProtocol:@protocol(UserActionProtocol) forObject:self];
// 接收到消息
- (void)userDidFollow:(BOOL)isFollowed userID:(NSNumber *)userID {
// do something
}
可以说是非常直观了。甚至还能在Xcode中直接Ctrl+Cmd+左键查看哪些地方接收了这个“消息”，而不是用搜索。
源码分析
首先，XNGNotificationProxy内有一个methodDictionary来维持方法到实际接收者的关系，该字典的key是方法名(NSString)，value是实际接收者的集合(NSHashTable)。为什么集合不用NSSet呢，因为NSSet对包含的对象强持有，我不希望接收者的引用计数被一个代理影响，也不希望接收者还要手动调用unregisterXXX之类的方法，所以使用的可以弱引用对象的NSHashTable。
接收方使用registerProtocol:forObject:将一个对象obj1注册到XNGNotificationProxy的单例中，即在methodDictionary创建了若干条key为protocol中的方法名，value为包含了obj1的NSHashTable的条目，形如{ methodA: [obj1, obj2], methodB: [obj3], ... }。这也就要求在创建protocol的时候注意把握粒度，因为obj1注册一个protocol时会被关联到该protocol的所有方法上，所以如果粒度过粗（一个protocol下有很多方法），那些方法对应的集合就会包含很多在业务上并不需要处理该消息的对象。
当发起方使用XNGNotificationProxy单例调用methodA时，XNGNotificationProxy就会在methodDictionary中查找key为methodA所对应的集合，并通过forwardInvocation:向集合中的所有对象转发消息，实现“通知”功能。
写在最后
XNGNotificationProxy完全可以作为自定义NSNotification的替代品。简书iOS项目也在生产中较长时间使用了这个类，所以可以放心使用。可以通过pod 'XNGNotificationProxy'或直接拖入项目来使用。
