为什么不能runtime创建JSExport类型的Protocol?

JavaScriptCore引入后,js调用OC的方法有了新的实现方式。让一个类遵循一个JSExport的协议,将想要暴露的方法在JSExport协议中声明,即可在js中直接调用到OC的方法。
例如下面的代码:

#import <JavaScriptCore/JavaScriptCore.h>

@protocol NSTestExport <JSExport>
-(NSString *)str;
-(void)setStr:(NSString *)str;
@end

@interface ViewController : UIViewController<NSTestExport>
@property (nonatomic, strong) NSString *str;
@end

@implementation ViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    _str = @"asdf";
        
    context = [[JSContext alloc] init];
    
    context.exceptionHandler = ^(JSContext *context, JSValue *exception) {
        NSLog(@"exception: %@",exception);
    };
    
    context[@"log"] = ^(NSString *msg){
        NSLog(@"log msg: %@",msg);
    };
    
    context[@"viewController"] = self;
    
    [context evaluateScript:@"viewController.setStr('dsfg')"];
    JSValue *string = [context evaluateScript:@"viewController.str()"];

     NSLog(@"log str: %@",[result toString]);
}

但是这样的实现并不灵活,如果我有大量的类和其中的方法要在js中使用,那么我可能需要实现大量的JSExport协议,这样会导致项目中的代码量大大增加。于是想到了可以使用runtime动态创建这些协议,然后添加到class中。

1、首先让我们制作一个扩展JSExport的新协议,假设我们有一个Class class我们要导出的变量:

const char *protocolName = class_getName(class);
    Protocol *protocol = objc_allocateProtocol(protocolName);
    protocol_addProtocol(protocol, objc_getProtocol("JSExport"));

2、然后我们从类中读取方法列表和属性列表,并将它们添加到protocol中:
实例方法:

{
    NSUInteger methodCount, classMethodCount;
    Method *methods, *classMethods;
    methods = class_copyMethodList(class, &methodCount);
    for (NSUInteger methodIndex = 0; methodIndex < methodCount; ++methodIndex) {
        Method method = methods[methodIndex];
        protocol_addMethodDescription(protocol, method_getName(method), method_getTypeEncoding(method), YES, YES);
    }
}

类方法:

{
    classMethods = class_copyMethodList(object_getClass(class), &classMethodCount);
    for (NSUInteger methodIndex = 0; methodIndex < classMethodCount; ++methodIndex) {
        Method method = classMethods[methodIndex];
        protocol_addMethodDescription(protocol, method_getName(method), method_getTypeEncoding(method), YES, NO);
    }
}

属性:
添加属性的方法基本和添加方法相同,但是我们还需要获取每个属性的特性,并添加到协议中

{
    NSUInteger propertyCount;
    objc_property_t *properties;
    properties = class_copyPropertyList(class, &propertyCount);
    for (NSUInteger propertyIndex = 0; propertyIndex < propertyCount; ++propertyIndex) {
        objc_property_t property = properties[propertyIndex];
        NSUInteger attributeCount;
//每个属性的特性
        objc_property_attribute_t *attributes = property_copyAttributeList(property, &attributeCount);
        protocol_addProperty(protocol, property_getName(property), attributes, attributeCount, YES, YES);
        free(attributes);
    }
}

3、将新协议添加到类中

objc_registerProtocol(protocol);
//校验protocol是否遵循JSExport协议
BOOL conform = protocol_conformsToProtocol(protocol, @protocol(JSExport));
NSLog(@"conform: %d",conform);
        
BOOL success = class_addProtocol(class, protocol);

4、然后理论上我们应该是可以在js中使用这个类中的方法了,接下来使用下面的代码测试下。

context = [[JSContext alloc] init];
    
    context.exceptionHandler = ^(JSContext *context, JSValue *exception) {
        NSLog(@"exception: %@",exception);
    };
        
    context[@"viewController"] = self;
    
    [context evaluateScript:@"viewController.setStr('dsfg')"];

然后我们发现,js的执行抛了异常。为什么呢?我们的实现逻辑并没有问题。
这里查看JavaScriptCore源代码。

最后发现原因在与objCCallbackFunctionForMethod方法,改函数通过调用objCCallbackFunctionForInvocation返回了一个原生函数的指针JSObjectRefobjCCallbackFunctionForInvocation函数的调用语句如下:

objCCallbackFunctionForInvocation(context, invocation, isInstanceMethod ? CallbackInstanceMethod : CallbackClassMethod, isInstanceMethod ? cls : nil, _protocol_getMethodTypeEncoding(protocol, sel, YES, isInstanceMethod))。

这里使用了_protocol_getMethodTypeEncoding函数。到ObjcRuntimeExtras.h中看看函数的定义。

// Forward declare some Objective-C runtime internal methods that are not API.
const char *_protocol_getMethodTypeEncoding(Protocol *, SEL, BOOL isRequiredMethod, BOOL isInstanceMethod);

再到https://opensource.apple.com/source/objc4/objc4-551.1/runtime/objc-runtime-new.mm中找到了实现:

/***********************************************************************
 * _protocol_getMethodTypeEncoding
 * Return the @encode string for the requested protocol method.
 * Returns nil if the compiler did not emit any extended @encode data.
 * Locking: acquires runtimeLock
 **********************************************************************/
const char *
_protocol_getMethodTypeEncoding(Protocol *proto_gen, SEL sel,
                                BOOL isRequiredMethod, BOOL isInstanceMethod)
{
    protocol_t *proto = newprotocol(proto_gen);
    if (!proto) return nil;
    fixupProtocolIfNeeded(proto);
    const char *enc;
    rwlock_read(&runtimeLock);
    enc = protocol_getMethodTypeEncoding_nolock(proto, sel,
                                                isRequiredMethod,
                                                isInstanceMethod);
    rwlock_unlock_read(&runtimeLock);
    return enc;
}

函数注释中写名了,Returns nil if the compiler did not emit any extended @encode data.所以我们只能在编译阶段创建好JSExport

本文作者: ctinusdev
原文链接: https://ctinusdev.github.io/2017/08/05/CantnotCreateJSExportAtRuntime/
转载请注明出处!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,347评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,435评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,509评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,611评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,837评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,987评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,730评论 0 267
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,194评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,334评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,944评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2 349

推荐阅读更多精彩内容