//OC 可以在定义时让一个类实现某些 Protocol 接口,写法跟 OC 一样: defineClass("JPViewController: UIViewController", { }) 这样做的作用是,当添加 Protocol 里定义的方法,而类里没有实现的方法时,参数类型不再全是 id,而是自动转为 Protocol 里定义的类型: @protocol UIAlertViewDelegate - (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex; @end //JSPatch defineClass("JPViewController: UIViewController ", { viewDidAppear: function(animated) { var alertView = require('UIAlertView') .alloc() .initWithTitle_message_delegate_cancelButtonTitle_otherButtonTitles( "Alert", self.dataSource().objectAtIndex(indexPath.row()), self, "OK", null ) alertView.show() } alertView_clickedButtonAtIndex: function(alertView, buttonIndex) { console.log('clicked index ' + buttonIndex) } })
1)原来Masonry方法中"_"下划线的要变成两个"__"
2)使用block块包装
3)make中的方法都需要添加()
//OC UIView * view = [UIView new]; view.backgroundColor = [UIColor orangeColor]; [self.view addSubview:view]; [view mas_makeConstraints:^(MASConstraintMaker *make) { make.top.equalTo(self.view).with.offset(15); make.left.equalTo(self.view).with.offset(10); make.right.equalTo(self.view.mas_width); make.height.equalTo(@(50)); }]; //JS var view = UIView.alloc().init(); view.setBackgroundColor(UIColor.redColor()); self.view().addSubview(view); console.log("222"); view.mas__makeConstraints(block('MASConstraintMaker*', function(make) { make.top().equalTo()(self.view()).with().offset()(15); make.left().equalTo()(self.view()).with().offset()(10); make.right().equalTo()(self.view().mas__right()); make.height().equalTo()((50)); }));
// JS
defineClass(“类名”, { //实例方法,不同方法之间使用逗号分隔 }, { //类方法,不同方法之间使用逗号分隔 })
// OC @implementation JPTableViewController - (void)viewDidLoad { } @end // JS defineClass("JPTableViewController", { viewDidLoad: function() { self.ORIGviewDidLoad(); }, })
可以在 defineClass() 第二个参数为类新增 property,格式为字符串数组,使用时与 OC property 接口一致:
defineClass("JPTableViewController", ['data', 'totalCount'], { init: function() { self = self.super().init() self.setData(["a", "b"]) //添加新的 Property (id data) self.setTotalCount(2) return self }, viewDidLoad: function() { var data = self.data() //获取 Property 值 var totalCount = self.totalCount() }, })
偏移量和转字符串
var contentOffSetY = scrollView.contentOffset().y; var string = NSString.stringWithFormat("%@", contentOffSetY); JSPatch原生支持 CGRect / CGPoint / CGSize / NSRange 这四个 struct 类型,用 JS 对象表示: // Obj-C UIView *view = [[UIView alloc] initWithFrame:CGRectMake(20, 20, 100, 100)]; [view setCenter:CGPointMake(10,10)]; [view sizeThatFits:CGSizeMake(100, 100)]; CGFloat x = view.frame.origin.x; NSRange range = NSMakeRange(0, 1); // JS var view = UIView.alloc().initWithFrame({x:20, y:20, width:100, height:100}) view.setCenter({x: 10, y: 10}) view.sizeThatFits({width: 100, height:100}) var x = view.frame().x (orign也是一个结构体) var range = {location: 0, length: 1}
其他 Struct 类型的支持请参照 添加 struct 类型支持
//Obj-C [self performSelector:@selector(viewWillAppear:) withObject:@(YES)]; //JS self.performSelector_withObject("viewWillAppear:", 1)
JS 上的 null 和 undefined 都代表 OC 的 nil,如果要表示 NSNull, 用 nsnull 代替,如果要表示 NULL, 也用 null 代替:
//Obj-C @implemention JPTestObject + (BOOL)testNull(NSNull *null) { return [null isKindOfClass:[NSNull class]] } @end //JS require('JPTestObject').testNull(nsnull) //return 1 require('JPTestObject').testNull(null) //return 0 在JS里面判断是否为空要判断false: var url = ""; var rawData = NSData.dataWithContentsOfURL(NSURL.URLWithString(url)); if (rawData != null) {} //这样判断是错误的 应该如下判断: if (!rawData){} 在JSPatch.js源码里_formatOCToJS方法对undefined,null,isNil转换成了false。
如果使用self.dataArray() ==使用get方法 所以需要有括号 如果直接使用数组 tempArray 不需要括号
NSArray / NSString / NSDictionary 不会自动转成对应的JS类型,像普通 NSObject 一样使用它们:
//Obj-C @implementation JPObject + (NSArray *)data { return @[[NSMutableString stringWithString:@"JS"]] } + (NSMutableDictionary *)dict { return [[NSMutableDictionary alloc] init]; } @end // JS require('JPObject') var ocStr = JPObject.data().objectAtIndex(0) ocStr.appendString("Patch") var dict = JPObject.dict() dict.setObject_forKey(ocStr, 'name') console.log(dict.objectForKey('name')) //output: JSPatch 如果要把 NSArray / NSString / NSDictionary 转为对应的 JS 类型,使用 .toJS() 接口: // JS var data = require('JPObject').data().toJS() //data instanceof Array === true data.push("Patch") var dict = JPObject.dict() dict.setObject_forKey(data.join(''), 'name') dict = dict.toJS() console.log(dict['name']) //output: JSPatch
总结:
1.JS调用OC方法中带有block的需要转换成block()格式.
2.使用OC方法,传入参数为block,JS需要将block()结构
JS 没有 block 类型的变量,OC 的 block 对象传到 JS 会变成 JS function,所有要从 JS 传 block 给 OC 都需要用 block() 接口包装。
3.若使用 block 时出现 crash,最常见的原因是在 block 里使用了 self 变量,应该在 JS 声明另一个变量持有 self,详情见这里。
block 传递
当要把 JS 函数作为 block 参数给 OC时,需要先使用 block(paramTypes, function) 接口包装:
// Obj-C @implementation JPObject + (void)request:(void(^)(NSString *content, BOOL success))callback { callback(@"I'm content", YES); } @end // JS require('JPObject').request(block("NSString *, BOOL", function(ctn, succ) { if (succ) log(ctn) //output: I'm content }))
这里 block 里的参数类型用字符串表示,写上这个 block 各个参数的类型,用逗号分隔。NSObject 对象如 NSString , NSArray 等可以用 id 表示,但 block 对象要用 NSBlock* 表示。
从 OC 返回给 JS 的 block 会自动转为 JS function,直接调用即可:
// Obj-C @implementation JPObject typedef void (^JSBlock)(NSDictionary *dict); + (JSBlock)genBlock { NSString *ctn = @"JSPatch"; JSBlock block = ^(NSDictionary *dict) { NSLog(@"I'm %@, version: %@", ctn, dict[@"v"]) }; return block; } + (void)execBlock:(JSBlock)blk { } @end // JS var blk = require('JPObject').genBlock(); blk({v: "0.0.1"}); //output: I'm JSPatch, version: 0.0.1
若要把这个从 OC 传过来的 block 再传回给 OC,同样需要再用 block() 包装,因为这里 blk 已经是一个普通的 JS function,跟我们上面定义的 JS function 没有区别:
// JS var blk = require('JPObject').genBlock(); blk({v: "0.0.1"}); //output: I'm JSPatch, version: 0.0.1 require('JPObject').execBlock(block("id", blk));
总结:JS 没有 block 类型的变量,OC 的 block 对象传到 JS 会变成 JS function,所有要从 JS 传 block 给 OC 都需要用 block() 接口包装。
block 里使用 self 变量
在 block 里无法使用 self 变量,需要在进入 block 之前使用临时变量保存它:
defineClass("JPViewController", { viewDidLoad: function() { var slf = self; require("JPTestObject").callBlock(block(function(){ //`self` is not available here, use `slf` instead. slf.doSomething(); }); } }
限制
从 JS 传 block 到 OC,有两个限制:
A. block 参数个数最多支持6个。(若需要支持更多,可以修改源码)
B. block 参数类型不能是 double / NSBlock / struct 类型。
另外不支持 JS 封装的 block 传到 OC 再传回 JS 去调用(原因见 issue #155):
- (void)callBlock:(void(^)(NSString *str))block { } defineClass('JPTestObject', { run: function() { self.callBlock(block('NSString*', function(str) { console.log(str); })); }, callBlock: function(blk) { //blk 这个 block 是上面的 run 函数里 JS 传到 OC 再传过来的,无法调用。 blk("test block"); } });
常用例子:
//OC secondVC.buttonBlock = ^(NSString * string) { NSLog(@"原声打印: %@",string); }; //JS var func = function(string) { console.log(string); }; //然后setblock block包装(参数,block块) secondVC.setButtonBlock(block('NSString*',func));
可以在 JS 通过 __weak() 声明一个 weak 变量,主要用于避免循环引用。
例如我们在 OC 里为了避免 block 导致的循环引用,经常这样写:
- (void)test { _weak id weakSelf = self; [self setCompleteBlock:^(){ [weakSelf blabla]; }] }
在 JS 对应的可以这样写:
var weakSelf = __weak(self) self.setCompleteBlock(block(function(){ weakSelf.blabla(); }))
若要在使用 weakSelf 时把它变成 strong 变量,可以用 __strong() 接口:
var weakSelf = __weak(self) self.setCompleteBlock(block(function(){ var strongSelf = __strong(weakSelf) strongSelf.blabla(); }))
使用 dispatch_after() dispatch_async_main() dispatch_sync_main() dispatch_async_global_queue() 接口调用GCD方法:
// Obj-C dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1.0 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{ // do something }); dispatch_async(dispatch_get_main_queue(), ^{ // do something }); // JS dispatch_after(1.0, function(){ // do something }) dispatch_async_main(function(){ // do something }) dispatch_sync_main(function(){ // do something }) dispatch_async_global_queue(function(){ // do something })
Objective-C 里的常量/枚举不能直接在 JS 上使用,可以直接在 JS 上用具体值代替:
//OC [btn addTarget:self action:@selector(handleBtn) forControlEvents:UIControlEventTouchUpInside]; //UIControlEventTouchUpInside的值是1<<6 btn.addTarget_action_forControlEvents(self, "handleBtn", 1<<6); 或者在 JS 上重新定义同名的全局变量: //js var UIControlEventTouchUpInside = 1 << 6; btn.addTarget_action_forControlEvents(self, "handleBtn", UIControlEventTouchUpInside); 有些常量字符串,需要在 OC 用 NSLog 打出看看它的值是什么: //OC [[NSAttributedString alloc].initWithString:@"str" attributes:@{NSForegroundColorAttributeName: [UIColor redColor]]; 上面代码中 NSForegroundColorAttributeName 是一个静态字符串常量,源码里看不出它的值,可以先用 NSLog 打出它的值再直接写在 JS 上: //OC NSLog(@"%@", NSForegroundColorAttributeName) //output 'NSColor' NSAttributedString.alloc().initWithString_attributes("无效啊", {'NSColor': UIColor.redColor()}); NSFontAttributeName == NSFont NSParagraphStyleAttributeName == NSParagraphStyle NSForegroundColorAttributeName == NSColor 例子: var paragraphStyle = NSMutableParagraphStyle.alloc().init(); paragraphStyle.setLineSpacing(2); // 字体的行间距 paragraphStyle.setAlignment(3); paragraphStyle.setLineBreakMode(0); var attributes = { NSFont: UIFont.systemFontOfSize(20), NSParagraphStyle: paragraphStyle, NSColor: UIColor.redColor() }; var attributesString = NSAttributed String.alloc().initWithString_attributes("我就是测试", attributes); self.contentLabel().setAttributedText(attributesString);
获取宏值
Objective-C 里的宏同样不能直接在 JS 上使用。若定义的宏是一个值,可以在 JS 定义同样的全局变量代替,若定义的宏是程序,可以在JS展开宏:
#define TABBAR_HEIGHT 40 #define SCREEN_WIDTH [[UIScreen mainScreen] bounds].size.height [view setWidth:SCREEN_WIDTH height:TABBAR_HEIGHT]; //JS view.setWidth_height(UIScreen.mainScreen().bounds().height, 40);
若宏的值是某些在底层才能获取到的值,例如 CGFLOAT_MIN,可以通过在某个类或实例方法里将它返回,或者用添加扩展的方式提供支持:
@implementation JPMacroSupport + (void)main:(JSContext *)context { context[@"CGFLOAT_MIN"] = ^CGFloat() { return CGFLOAT_MIN; } } @end require('JPEngine').addExtensions(['JPMacroSupport']) var floatMin = CGFLOAT_MIN();
修改宏值
JSPatch 不支持修改宏的值,若要修改,需要替换所有使用到这个宏的方法。例如:
#define VIEW_HEIGHT 40 @implementation JPMethodDemo + (void)func { UIView *view = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 100, VIEW_HEIGHT)]; ... } @end //JS var VIEW_HEIGHT_NEW = 20; defineClass('JPMethodDemo', { func: function() { var view = UIView.alloc().initWithFrame({x:0, y:0, width:100, height:VIEW_HEIGHT_NEW}); ... } });
全局变量
在类里定义的 static 全局变量无法在 JS 上获取到,若要在 JS 拿到这个变量,需要在 OC 有类方法或实例方法把它返回:
static NSString *name; @implementation JPTestObject + (NSString *)name { return name; } @end var name = JPTestObject.name() //拿到全局变量值
JSPatch 支持调用 stringWithFormat,不过所有参数类型都需改为 %@:
//OC [NSString stringWithFormat:@"name:%@, age:%d", @"alex", 12]; //JS NSString.stringWithFormat("name:%@, age:%@", "alex", 12);
虽然支持 stringWithFormat,但还是建议使用 JS 语法拼接字符串:
var ret = "name:" + "alex" + " age:(" + 12 + ")";
NSNumber 与上述四个类型不一样,所有数值类型以及 NSNumber 对象到 JS 后都会变成数值,不能再调用这个数值的任何方法:
//OC @implementation JPTestObject + (NSNumber *)returnNSNumber { return @(42); } + (int)returnInt { return 42; } @end var numFromOC = JPTestObject.returnNumber() var intFromOC = JPTestObject.returnInt() var jsNum = 42 //以上三个变量是相等的: console.log(numFromOC == intFromOC == jsNum) //true //不能调用 NSNumber 方法: numFromOC.isEqualToNumber(42); //crash //所有数值操作都应该在 JS 语法下操作: parseInt(numFromOC); var all = numFromOC + intFromOC + jsNum;
首先从 OC 返回的 NSArray / NSDictionary 对象是不能直接用 for...in 遍历的,需要调用 .toJS() 后才能进行遍历,详情见上文。
然后在遍历数组时,JavaScript 的 for...in 语法定义与 Objective-C 不同:
//OC NSArray *arr = @[@"name", @"age"]; for (var o in arr) { NSLog(@"%@", o); //输出 name age } var arr = ["name", "age"]; for (var o in arr) { console.log(o); //输出 0, 1,表示遍历数组的序号 console.log(arr[o]); //输出 name age,这样才表示数组的值 }
如果一个 OC 对象被 JS 引用,或者在 JS 创建这个对象,这个 OC 对象在退出作用域后不会马上释放,而是会等到 JS 垃圾回收时才释放,这会导致一些 OC 对象延迟释放:
defineClass('JPTestObject', { testObj: function() { var view = UIView.alloc().init(); //函数执行完退出作用域,或者手动把这个变量置为null,这个 OC 对象都不会立即释放 //在 JS 没有变量持有这些对象后,JS 引擎会在垃圾回收时才释放 view = null; } });
没有被 JS 引用过的 OC 对象不受影响。更多讨论见 #69
可以用 JSPatch 为类添加 dealloc 方法,但无法覆盖原 OC 上的 dealloc 方法,在执行完 JS 的 dealloc 后会自动执行 OC 上的 dealloc 方法,因为若不执行 OC 的 dealloc 方法,对象无法正常释放,会产生内存泄漏:
@implementation JPViewController - (void)dealloc { NSLog(@"dealloc from OC"); } @end defineClass('JPViewController', { dealloc: function() { console.log('dealloc from JS'); } } 会输出 dealloc from JS dealloc from OC