JSPatch 是一個開源框架,它借助 Objective-C 的 runtime 機制,讓 JavaScript 得以動態呼叫並替換專案中的 Objective-C 方法與屬性。框架體積小、語法簡潔,而且是透過系統自帶的 JavaScriptCore 與 Objective-C 溝通,因此在穩定性與上架風險上相對可控。專案位址:https://github.com/bang590/JSPatch。
以 CocoaPods 匯入後,在 AppDelegate 中啟動引擎並載入 JS 檔:
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 啟動引擎
[JPEngine startEngine];
// 讀取 JS 檔內容
NSString *sourcePath = [[NSBundle mainBundle] pathForResource:@"demo" ofType:@"js"];
NSString *script = [NSString stringWithContentsOfFile:sourcePath
encoding:NSUTF8StringEncoding
error:nil];
// 執行腳本
[JPEngine evaluateScript:script];
self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
self.window.rootViewController = [[ViewController alloc] init];
[self.window addSubview:[self genView]];
[self.window makeKeyAndVisible];
return YES;
}
- (UIView *)genView {
UIView *view = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 320, 320)];
view.backgroundColor = [UIColor redColor];
return view;
}
再新增一個 demo.js,把 genView 換掉:
require('UIView, UIColor, UILabel')
defineClass('AppDelegate', {
// 重新實作 genView
genView: function() {
var view = self.ORIGgenView(); // 呼叫原始實作
view.setBackgroundColor(UIColor.greenColor());
var label = UILabel.alloc().initWithFrame(view.frame());
label.setText("JSPatch");
label.setTextAlignment(1);
view.addSubview(label);
return view;
}
});
執行後可以看到原本紅色的 view 變成綠色,並多了一個文字標籤——genView 已被 JS 版本取代。
JSPatch 支援三種載入腳本的方式:直接執行字串、讀取本機檔案、抓取網路檔案。
用 JS 字串直接彈出一個警示框:
- (void)viewDidLoad {
[super viewDidLoad];
// 反斜線用於換行續寫
[JPEngine evaluateScript:@"\
var alertView = require('UIAlertView').alloc().init();\
alertView.setTitle('Alert');\
alertView.setMessage('AlertView from js');\
alertView.addButtonWithTitle('OK');\
alertView.show();\
"];
}
也可以替既有的類「補上」原本不存在的方法:
- (void)viewDidLoad {
[super viewDidLoad];
self.view.backgroundColor = [UIColor whiteColor];
[JPEngine startEngine];
NSString *sourcePath = [[NSBundle mainBundle] pathForResource:@"demo" ofType:@"js"];
NSString *script = [NSString stringWithContentsOfFile:sourcePath
encoding:NSUTF8StringEncoding
error:nil];
[JPEngine evaluateScript:script];
// 這個方法在 .m 檔案裡完全沒有實作,全靠 JS 提供
[self performSelectorOnMainThread:@selector(creatView)
withObject:nil
waitUntilDone:nil];
}
require('UIView, UIColor, UILabel')
defineClass('ViewController', {
creatView: function() {
var view = UIView.alloc().initWithFrame({x:20, y:20, width:100, height:100});
view.setBackgroundColor(UIColor.greenColor());
var label = UILabel.alloc().initWithFrame({x:0, y:0, width:100, height:100});
label.setText("JSPatch");
label.setTextAlignment(1);
view.addSubview(label);
self.view().addSubview(view);
}
});
執行後並不會崩潰,ViewController 正常跑完 creatView。這也說明了 JSPatch 最主要的用途:App 上線後若發現小缺陷,可以定位到出問題的方法,用一份 JS 檔把它替換掉,完成低成本的 hotfix。
1. 引用 Objective-C 類
JS 中要用到某個 Objective-C 類之前,必須先 require:
require('UIView')
require('UIView, UIColor, UILabel') // 一次引用多個
require('UIView').alloc().init() // 也可以即時引用
2. 呼叫方法
類方法用「類名.方法名()」;實例方法用「物件.方法名()」:
UIColor.redColor() view.addSubview(label)
多參數方法在 Objective-C 中的冒號位置,轉成 JS 後以底線串接,參數依序放入括號並以逗號分隔:
view.setBackgroundColor(UIColor.colorWithRed_green_blue_alpha(0, 0.5, 0.5, 1))
屬性只能透過 getter / setter 存取;若原本的方法名已含底線,在 JS 中要寫成雙底線:
label.setText("JSPatch")
3. 定義與改寫類
/* classDeclaration:類名字串,若不存在則會新建 instanceMethods:要新增或改寫的實例方法 classMethods :要新增或改寫的類方法 */ defineClass(classDeclaration, instanceMethods, classMethods)
defineClass('ViewController', {
newFunc: function() { // 實例方法
self.view().setBackgroundColor(UIColor.redColor())
}
}, {
myLoad: function() { // 類方法
}
});
改寫後若仍要呼叫原實作,加上 ORIG 前綴;要呼叫父類實作則用 self.super():
defineClass('ViewController', {
viewDidLoad: function() {
self.ORIGviewDidLoad() // 呼叫原本的方法
}
});
defineClass('ViewController', {
viewDidLoad: function() {
self.super().viewDidLoad() // 等同 Objective-C 的 [super viewDidLoad]
}
});
需要暫存狀態時,可用 setProp_forKey: 動態掛上屬性,再用 getProp() 取出。注意這些屬性無法用一般 setter / getter 存取:
defineClass('ViewController', {
viewDidLoad: function() {
self.super().viewDidLoad()
self.setProp_forKey("JSPatch", "data")
},
touchesBegan_withEvent: function(touch, id, event) {
self.getProp("data")
self.view().setBackgroundColor(UIColor.redColor())
}
});
宣告遵循的協議,寫法與 Objective-C 一致,直接接在類名後方:
defineClass("ViewController2: UIViewController <UIAlertViewDelegate>", {
viewDidAppear: function(animated) {
var alertView = require('UIAlertView').alloc()
.initWithTitle_message_delegate_cancelButtonTitle_otherButtonTitles(
"Alert", "content", self, "OK", null)
alertView.show()
},
alertView_clickedButtonAtIndex: function(alertView, buttonIndex) {
console.log('clicked index ' + buttonIndex)
}
})
結構體:原生支援 CGPoint、CGSize、CGRect、NSRange,直接用 JS 物件字面值傳入即可。
view.setFrame({x:100, y:100, width:100, height:100})
view.setCenter({x:200, y:200})
var size = {width:200, height:200}
view.setFrame({x:100, y:100, width:size.width, height:size.height})
var range = {location: 0, length: 1}
選擇器:以字串形式表示。
self.performSelector_withObject("func:", 1)
空值:JS 的 null 與 undefined 都對應 Objective-C 的 nil;NSNull 則以 nsnull 表示。
Block 互動:Objective-C 的 block 傳到 JS 會自動變成函數,可直接呼叫:
typedef void(^block)(NSString *str);
-(block)getBlock {
block b = ^(NSString *str) { NSLog(@"%@", str); };
return b;
}
defineClass("ViewController", {
viewDidAppear: function(animated) {
var func = self.getBlock()
func("123")
}
})
反向把 JS 函數當成 block 傳入,則需要用 block() 包裝,第一個參數是型別清單,第二個參數是函式主體:
-(void)run:(void(^)(NSString *str))block {
block(@"123");
}
defineClass("ViewController", {
viewDidAppear: function(animated) {
self.run(block("NSString*", function(str) {
console.log(str)
}))
}
})
block() 包裝的函式內不能直接使用 self,必須先在外部用區域變數承接;弱/強引用則分別以 __weak() 與 __strong 宣告:
defineClass("ViewController", {
viewDidAppear: function(animated) {
var slf = self
self.run(block("NSString*", function(str) {
console.log(str)
slf.log(str)
}))
}
});
var slf = __weak(self)
var strong = __strong(self)
GCD 與列舉:並行 API 有對應的 JS 包裝;Objective-C 的列舉無法直接引用,只能代入其實際數值。
dispatch_after(1.0, function() { }) // 延遲執行
dispatch_async_main(function() { }) // 主執行緒非同步
dispatch_sync_main(function() { }) // 主執行緒同步
dispatch_async_global_queue(function() { }) // 全域佇列
// UIControlEventTouchUpInside 的值為 1 << 6
btn.addTarget_action_forControlEvents(self, "handleBtn", 1 << 6);