前言
今年项目进行组件化时做了一些技术调研，关于路由最终决定在 Target-Action 和 协议代理 两个方案中选择。因为项目采用 Swift 语言开发，并且 Swift4.0 之后支持了协议扩展，所以选用了后者。具体参考的是 灵活的 Swift 组件解耦和通信工具Lotusoot。之后也会对这个的源码在细读一遍。
因为近期回归 Objective-C，所以这里再阅读一次 CTMediator 的源码实现。
参考文章：
这里只是提供了组件化思路文章的入口，作者 casatwy 这系列的几篇文章，每篇都值得细读多遍。
源码分析
因为 CTMediator 非常的精简，更主要的是代表了一种思路，很多非常细节的点或者业务相关紧密的，都没在源码中处理，但是大都提出了一些建议入口。所以这里会对所有代码进行展示分析。
对外公开方法
#import <UIKit/UIKit.h>
extern NSString * const kCTMediatorParamsKeySwiftTargetModuleName;
@interface CTMediator : NSObject
+ (instancetype)sharedInstance;
// 远程App调用入口
- (id)performActionWithUrl:(NSURL *)url completion:(void(^)(NSDictionary *info))completion;
// 本地组件调用入口
- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget;
- (void)releaseCachedTargetWithTargetName:(NSString *)targetName;
@end
获取单例对象
#pragma mark - public methods
+ (instancetype)sharedInstance
{
static CTMediator *mediator;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
mediator = [[CTMediator alloc] init];
});
return mediator;
}
这里并没有对 alloc 、allocWithZone 等方法补充，只是作为规定，使用 CTMediator 必须使用该单例。关于单例的实现，Swift 语言真的是精简安全太多:
class CTMediator {
// 单例实现
static let shared = CTMediator()
private init() {}
}
远程调用入口
// 远程App调用入口
- (id)performActionWithUrl:(NSURL *)url completion:(void(^)(NSDictionary *info))completion;
远程调用时，是对约定格式的 URL 进行解析，解析完成后，依然执行的是本地组件的调用入口：
/*
scheme://[target]/[action]?[params]
url sample:
aaa://targetA/actionB?id=1234
*/
- (id)performActionWithUrl:(NSURL *)url completion:(void (^)(NSDictionary *))completion
{
NSMutableDictionary *params = [[NSMutableDictionary alloc] init];
NSString *urlString = [url query];
for (NSString *param in [urlString componentsSeparatedByString:@"&"]) {
NSArray *elts = [param componentsSeparatedByString:@"="];
if([elts count] < 2) continue;
[params setObject:[elts lastObject] forKey:[elts firstObject]];
}
// 这里这么写主要是出于安全考虑，防止黑客通过远程方式调用本地模块。这里的做法足以应对绝大多数场景，如果要求更加严苛，也可以做更加复杂的安全逻辑。
NSString *actionName = [url.path stringByReplacingOccurrencesOfString:@"/" withString:@""];
if ([actionName hasPrefix:@"native"]) {
return @(NO);
}
// 这个demo针对URL的路由处理非常简单，就只是取对应的target名字和method名字，但这已经足以应对绝大部份需求。如果需要拓展，可以在这个方法调用之前加入完整的路由逻辑
id result = [self performTarget:url.host action:actionName params:params shouldCacheTarget:NO];
if (completion) {
if (result) {
completion(@{@"result":result});
} else {
completion(nil);
}
}
return result;
}
本地组件调用入口
/// 本地组件调用入口
/// @param targetName 模块的方法所属类名
/// @param actionName 方法名
/// @param params 携带参数
/// @param shouldCacheTarget 是否缓存该模块
- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget;
这个就是该组件化方案的核心方法了。通过传入的模块的方法所属类名、方法名，去对应的模块代码中寻找匹配项。正是使用了反射机制、runtime 等特性，所以才能够彻底分离各个功能业务模块间的相互依赖。
- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget
{
NSString *swiftModuleName = params[kCTMediatorParamsKeySwiftTargetModuleName];
// generate target
NSString *targetClassString = nil;
if (swiftModuleName.length > 0) {
targetClassString = [NSString stringWithFormat:@"%@.Target_%@", swiftModuleName, targetName];
} else {
targetClassString = [NSString stringWithFormat:@"Target_%@", targetName];
}
// 先从缓存字典中查找
NSObject *target = self.cachedTarget[targetClassString];
if (target == nil) {
Class targetClass = NSClassFromString(targetClassString);
target = [[targetClass alloc] init];
}
// generate action
NSString *actionString = [NSString stringWithFormat:@"Action_%@:", actionName];
SEL action = NSSelectorFromString(actionString);
if (target == nil) {
// 这里是处理无响应请求的地方之一，这个demo做得比较简单，如果没有可以响应的target，就直接return了。实际开发过程中是可以事先给一个固定的target专门用于在这个时候顶上，然后处理这种请求的
[self NoTargetActionResponseWithTargetString:targetClassString selectorString:actionString originParams:params];
return nil;
}
if (shouldCacheTarget) {
self.cachedTarget[targetClassString] = target;
}
if ([target respondsToSelector:action]) {
return [self safePerformAction:action target:target params:params];
} else {
// 这里是处理无响应请求的地方，如果无响应，则尝试调用对应target的notFound方法统一处理
SEL action = NSSelectorFromString(@"notFound:");
if ([target respondsToSelector:action]) {
return [self safePerformAction:action target:target params:params];
} else {
// 这里也是处理无响应请求的地方，在notFound都没有的时候，这个demo是直接return了。实际开发过程中，可以用前面提到的固定的target顶上的。
[self NoTargetActionResponseWithTargetString:targetClassString selectorString:actionString originParams:params];
[self.cachedTarget removeObjectForKey:targetClassString];
return nil;
}
}
}
针对这个方法实现，有几点要说的：
- 组件的模块名是有约定规范的。对于
Swift，ModuleTargetName.Target_ActionName。对于Objective-C，Target_ActionName，如果需要针对自己项目特殊化定制，则需要修改这里。 - 关于模块缓存字典
@property (nonatomic, strong) NSMutableDictionary *cachedTarget;，如果模块过于复杂，并且数量多，这里会造成内存上的压力，不过对于中小型项目，应该没问题。个人认为，如果把储存的Target，改为String类型的TargetName，用的时候再转换，应该会好些。标记一下，这里是一个可优化的点。 - 方法中，
target == nil、![target respondsToSelector:action]、![target respondsToSelector:action]都是我们需要根据业务或者产品需求来自定义的地方。
清除缓存字典数据
- (void)releaseCachedTargetWithTargetName:(NSString *)targetName;
其实就是从字典中把对应的模块移除掉：
- (void)releaseCachedTargetWithTargetName:(NSString *)targetName
{
NSString *targetClassString = [NSString stringWithFormat:@"Target_%@", targetName];
[self.cachedTarget removeObjectForKey:targetClassString];
}
私有方法 private methods
没有 Target
/// 没有找到对应的模块实现类
/// @param targetString Target
/// @param selectorString 方法名
/// @param originParams 参数
- (void)NoTargetActionResponseWithTargetString:(NSString *)targetString selectorString:(NSString *)selectorString originParams:(NSDictionary *)originParams
{
SEL action = NSSelectorFromString(@"Action_response:");
NSObject *target = [[NSClassFromString(@"Target_NoTargetAction") alloc] init];
NSMutableDictionary *params = [[NSMutableDictionary alloc] init];
params[@"originParams"] = originParams;
params[@"targetString"] = targetString;
params[@"selectorString"] = selectorString;
[self safePerformAction:action target:target params:params];
}
我们要根据自己的业务和产品需求，自定义自己的响应错误页面和方法。这里可以做个性化设置。
安全实现
- (id)safePerformAction:(SEL)action target:(NSObject *)target params:(NSDictionary *)params
{
NSMethodSignature* methodSig = [target methodSignatureForSelector:action];
if(methodSig == nil) {
return nil;
}
const char* retType = [methodSig methodReturnType];
if (strcmp(retType, @encode(void)) == 0) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
[invocation setArgument:¶ms atIndex:2];
[invocation setSelector:action];
[invocation setTarget:target];
[invocation invoke];
return nil;
}
if (strcmp(retType, @encode(NSInteger)) == 0) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
[invocation setArgument:¶ms atIndex:2];
[invocation setSelector:action];
[invocation setTarget:target];
[invocation invoke];
NSInteger result = 0;
[invocation getReturnValue:&result];
return @(result);
}
if (strcmp(retType, @encode(BOOL)) == 0) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
[invocation setArgument:¶ms atIndex:2];
[invocation setSelector:action];
[invocation setTarget:target];
[invocation invoke];
BOOL result = 0;
[invocation getReturnValue:&result];
return @(result);
}
if (strcmp(retType, @encode(CGFloat)) == 0) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
[invocation setArgument:¶ms atIndex:2];
[invocation setSelector:action];
[invocation setTarget:target];
[invocation invoke];
CGFloat result = 0;
[invocation getReturnValue:&result];
return @(result);
}
if (strcmp(retType, @encode(NSUInteger)) == 0) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
[invocation setArgument:¶ms atIndex:2];
[invocation setSelector:action];
[invocation setTarget:target];
[invocation invoke];
NSUInteger result = 0;
[invocation getReturnValue:&result];
return @(result);
}
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
return [target performSelector:action withObject:params];
#pragma clang diagnostic pop
}
简单来说，就是对于基础数据类型，拿出来安全处理后再返回，防止数据解析错误。
这个方法里，NSMethodSignature 、 NSInvocation 需要特殊说明。这里推荐一篇文章吧 NSMethodSignature、NSInvocation进行消息转发。
多说一点
NSMethodSignature 的头文件实现：
#import <Foundation/NSObject.h>
NS_ASSUME_NONNULL_BEGIN
NS_SWIFT_UNAVAILABLE("NSInvocation and related APIs not available")
@interface NSMethodSignature : NSObject
+ (nullable NSMethodSignature *)signatureWithObjCTypes:(const char *)types;
@property (readonly) NSUInteger numberOfArguments;
- (const char *)getArgumentTypeAtIndex:(NSUInteger)idx NS_RETURNS_INNER_POINTER;
@property (readonly) NSUInteger frameLength;
- (BOOL)isOneway;
@property (readonly) const char *methodReturnType NS_RETURNS_INNER_POINTER;
@property (readonly) NSUInteger methodReturnLength;
@end
NS_ASSUME_NONNULL_END
NSInvocation 的头文件实现：
#import <Foundation/NSObject.h>
#include <stdbool.h>
@class NSMethodSignature;
NS_ASSUME_NONNULL_BEGIN
NS_SWIFT_UNAVAILABLE("NSInvocation and related APIs not available")
@interface NSInvocation : NSObject
+ (NSInvocation *)invocationWithMethodSignature:(NSMethodSignature *)sig;
@property (readonly, retain) NSMethodSignature *methodSignature;
- (void)retainArguments;
@property (readonly) BOOL argumentsRetained;
@property (nullable, assign) id target;
@property SEL selector;
- (void)getReturnValue:(void *)retLoc;
- (void)setReturnValue:(void *)retLoc;
- (void)getArgument:(void *)argumentLocation atIndex:(NSInteger)idx;
- (void)setArgument:(void *)argumentLocation atIndex:(NSInteger)idx;
- (void)invoke;
- (void)invokeWithTarget:(id)target;
@end
其实可以看到 NS_SWIFT_UNAVAILABLE。这些特性在 Swift 中都被抛弃了。我之前尝试用 Swift 重写 CTMediator 然后放到项目中使用，因为发现很多特性不能使用了，也就作罢了。不过作者也详细说明了如何在 Swift 项目中使用该框架： CTMediator的Swift应用。
总结
学以致用，有些源码虽然非常精简，但是却包含了非常多值得思考的之事。譬如 SwiftyJson 仅仅凭借单个文件，千余行代码，就在 github 获取上万 star。 CTMediator 亦是如此。有些源码包罗万象，如 SDWebImage 等，也是学习的绝佳材料。
网友评论