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返回了一個原生函數的指針JSObjectRef。objCCallbackFunctionForInvocation函數的調用語句如下:
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/
轉載請注明出處!