1、require
在使用OC类之前需要调用require('className')
require('UIView')
var view = UIView.alloc().init()
说明:可以使用逗号分隔,一次性导入多个类,require('UIview','UIColor')或在使用的时候再引入require('UIview').alloc().init()
2、调用OC方法
2.1、调用类方法
var redColor = UIColor.redColor();
2.2、调用实例方法
var view = UIView.alloc().init();
var superView = UIView.alloc().init();
superView.addSubview(view)
2.3、获取/修改属性等价于调用这个属性的getter/setter方法,获取时加上()
view.setBackgroundColor(redColor);
var bgColor = view.backgroundColor;
2.4、多参数方法名使用_分隔
var indexPatch = require('NSIndexPath').indexPathForRow_inSection(0,1);
若原OC方法名包含下划线_,在JS使用双下划线__代替
//OC method:[JPObject _privateMethod]
JPObject.__privateMethod()
3、定义类
defineClass(classDeclaration,[properties],instanceMethods,classMethods)
classDeclaration 字符串,类名/父类名或者Protocol
properties :新增properties,字符串数组
instanceMethods :要添加或覆盖的实例方法
classMethods:要添加或覆盖的类方法
3.1、覆盖方法
在defineClass 里定义OC已存在的方法即可覆盖,方法名规则与调用规则一样,使用_分割
//OC
@implementation JPTableViewController
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath{
}
@end
//JS
defineClass("JPTableViewController",{
tableView_didSelectRowAtIndexPath: function(tableView,indexPath)
...
})
3.2、使用双下划线_代表原OC方法名里的下滑线
//OC
@implementation JPTableViewController
- (NSArray *)_dataSource{
}
@end
//JS
defineClass("JPTableViewController",{
__dataSource:function(){
},
})
3.3、在方法名前加ORIG即可调用未覆盖前的OC原方法
//OC
@implementation JPTableViewController
- (void)viewDidLoad {
}
@end
//JS
defineClass("JPTableViewController",{
viewDidLoad:function(){
self.ORIGviewDidLoad();
},
})
3.4、覆盖类方法
defineClass()第三个参数就是要添加或覆盖的类方法,规则与上述覆盖实例方法一致:
//OC
@implementation JPTestObject
+ (void)shareInstance
{
}
@end
//JS
defineClass("JPTableViewController", {
//实例方法
}, {
//类方法
shareInstance: function() {
...
},
})
3.5、覆盖Category方法
覆盖Category方法与覆盖普通方法一样:
//OC
@implementation UIView (custom)
- (void)methodA {
}
+ (void)clsMethodB {
}
@end
//JS
defineClass('UIView', {
methodA: function() {
}
}, {
clsMethodB: function() {
}
});
3.6、Super
使用self.super()接口代表super关键字,调用super方法:
//JS
defineClass("JPTableViewController", {
viewDidLoad: function() {
self.super().viewDidLoad();
}
})
3.7、Property
获取/修改OC定义的property
用调用getter/setter的方法获取/修改已在OC定义的property:
//OC
@interface JPTableViewController
@property (nonatomic) NSArray *data;
@property (nonatomic) NSString *shareURL;
@property (nonatomic) NSString *shareTitle;
@end
@implementation JPTableViewController
@end
//JS
defineClass("JPTableViewController", {
viewDidLoad: function() {
var data = self.data(); //get property value
self.setData(data.toJS().push("JSPatch")); //set property value
var sel = self;
self.bridge().registerHandler_handler('h5ToNativeShareDialog', block('NSDictionary *',function(data,responseCallback) {
sel.setShareURL(data.objectForKey('url'));
sel.setShareTitle(data.objectForKey('title'));
}));
})
3.8、动态新增Property
可以在defineClass()第二个参数为类新增property,格式为字符串数组,使用时与OC property接口一致
//JS
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()
},
})
3.9、私有成员变量
使用valueForKey()和setValue_forKey()获取/修改私有成员变量
//OC
@implementation JPTableViewController {
NSArray *_data;
}
@end
//JS
defineClass("JPTableViewController", {
viewDidLoad: function() {
var data = self.valueForKey("_data") //get member variables
self.setValue_forKey(["JSPatch"], "_data") //set member variables
},
})
3.10、添加新方法
可以给一个类随意添加OC未定义的方法,单所有的采纳数类型都是id
//OC
@implementation JPTableViewController
- (void)viewDidLoad
{
NSString* data = [self dataAtIndex:@(1)];
NSLog(@"%@", data); //output: Patch
}
@end
//JS
var data = ["JS", "Patch"]
defineClass("JPTableViewController", {
dataAtIndex: function(idx) {
return idx < data.length ? data[idx]: ""
}
})
3.11、Protocol
可以在定义时让一个类实现某些Protocol接口写法跟OC一样
defineClass("JPViewController: UIViewController", {
})
这样做的作用是,当添加Protocol里定义的方法,而类里没有实现的方法时,参数类型不全是id,而是自动转为Protocol里定义的类型
//OC
@protocol UIAlertViewDelegate
...
- (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex;
...
@end
//JS
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)
}
})
4、特殊类型
Struct
JSPatch原生支持CGRect、CGPoint、CGSize、NSRange这四个struct类型,用JS对象表示
//OC
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
var range = {location: 0, length: 1}
4.2、Selector
在JS使用字符串代表Selector
//OC
[self performSelector:@selector(viewWillAppear:) withObject:@(YES)];
//JS
self.performSelector_withObject("viewWillAppear:", 1)
4.3、nil
JS 上的null和undefined都代表OC的nil,如果要表示NSNull,用nsnull代替,如果要表示NULL,也用null代替
//OC
@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
5、NSArray/NSString/NSDictionary
NSArray/NSString/NSDictionary不会自动转换成对应的JS类型,像普通的NSObject一样使用它们
//OC
@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
可以通过.toJS()接口,转为对应的JS类型
//JS
var data = require('JPObject').data().toJS()
data.push("Patch")
var dict = JPObject.dict()
dict.setObject_forKey(data.join(''),'name')
dict = dict.toJS()
console.log(dict['name'])
6、Block
6.1、block传递
当要把JS函数作为block参数给OC时,需要先使用block(paramTypes,function)接口包装:
//OC
@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
@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
{
}
//JS 调用
var blk = require('JPObject').genBlock();
blk({v: "0.0.1"}); //output: I'm JSPatch, version: 0.0.1
//JS 回传
require('JPObject').execBlock(block("id", blk));
6.2、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();
});
}
}
7、__weak/__strong
可以在JS通过__weak()声明一个weak变量,主要用于避免循环引用
//OC
- (void)test {
__weak id weakSelf = self;
[self setCompleteBlock:^(){
[weakSelf blabla];
}]
}
//JS
var weakSelf = __weak(self)
self.setCompleteBlock(block(function(){
weakSelf.blabla();
}))
若在使用的时候需要把他变成strong变量,可以使用__strong()接口
var weakSelf = __weak(self)
self.setCompleteBlock(block(function(){
var strongSelf = __strong(weakSelf)
strongSelf.blabla();
}))
8、GCD
//OC
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
})
9、常量、枚举、宏、全局变量
9.1、常量、枚举
oc里的常量/枚举不能直接在JS上使用,可以直接在JS上用具体值替代
//OC
[btn addTarget:self action:@selector(handleBtn) forControlEvents:UIControlEventTouchUpInside];
//JS
//UIControlEventTouchUpInside的值是1<<6
btn.addTarget_action_forControlEvents(self, "handleBtn", 1<<6);
9.2、宏
获取宏值
OC里的宏是不能直接在JS上使用,若定义的宏是一个值,可以在JS定义同样的全局变量代替,若定义的宏是程序,可以在JS展开宏:
//OC
#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);
若是系统的宏,例如GCFLOAT_MIN,可以通过某个类或实例方法将他返回,或者用添加扩展的方式提供支持
//OC
@implementation JPMacroSupport
+ (void)main:(JSContext *)context
{
context[@"CGFLOAT_MIN"] = ^CGFloat() {
return CGFLOAT_MIN;
}
}
@end
//JS
require('JPEngine').addExtensions(['JPMacroSupport'])
var floatMin = CGFLOAT_MIN();
9.3、全局变量
在类里定义的static全局变量无法在JS上获取到,若要在JS拿到这个变量,需要在OC有类方法或实例方法把他返回
//OC
static NSString *name;
@implementation JPTestObject
+ (NSString *)name {
return name;
}
@end
//JS
var name = JPTestObject.name() //拿到全局变量值
10、加载动态库
对于ios内置的动态库,若原APP里没有加载,可以通过一下方式动态加载,例:SafariServices.framework
var bundle = NSBundle.bundleWithPath("/System/Library/Frameworks/SafariServices.framework");
bundle.load();
11、调试
可以使用consolo.logo()打印一个对象
var view = UIView.alloc().init();
var str = "test";
var num = 1;
console.log(view, str, num)
console.log(str + num); //直接在JS拼接字符串