JSPatch是GitHub上一個開源的框架,其可以通過Objective-C的run-time機制動態的使用JavaScript調用與替換項目中的Objective-C屬性與方法。其框架小巧,代碼簡潔,並且通過系統的JavaScriptCore框架與Objective-C進行交互,這使其在安全性和審核風險上都有很強的優勢。Git源碼地址:https://github.com/bang590/JSPatch。
一、從一個官方的小demo看起
通過cocoapods將JSPath集成進一個Xcode工程中,在AppDelegate類的中編寫如下代碼:
- (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]; //運行js文件 [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; }
在工程中添加一個js文件,編寫如下:
require('UIView, UIColor, UILabel') //要替換函數的類 defineClass('AppDelegate', { //替換函數 //要替換函數的名稱 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; } });
運行工程,可以看到genView方法被替換成了js文件中的方法,原本紅色的視圖被修改成了綠色。
二、使用JavaScript代碼向Objective-C中修改或添加方法
JSPatch引擎中支持3中方式進行JavaScript代碼的調用,分別是使用JavaScript字符串進行代碼運行,讀取本地的JavaScript文件進行代碼運行和獲取網絡的JavaScript文件進行代碼運行。例如,如果想要通過JavaScript代碼在項目中彈出一個警告框,在Objective-C代碼中插入如下代碼:
- (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(); \ "]; }
開發者也可以動態在Objective-C類文件中添加方法,例如在ViewController類中編寫如下:
- (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]; [self performSelectorOnMainThread:@selector(creatView) withObject:nil waitUntilDone:nil]; }
JavaScript文件代碼如下:
require('UIView, UIColor, UILabel') defineClass('ViewController', { // replace the -genView method 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.m文件中沒有編寫任何其他的方法,運行工程,可以看到程序並沒有崩潰,ViewController執行了creatView方法。
通過上面的示例,我們發現使用JSPatch可以做一些十分有趣的事。對於iOS應用來說,通過官方渠道AppStore進行應用程序的發布要通過人工審核,有時這個審核周期會非常長,如果在開發者在編寫代碼時留下了一些小漏洞,應用一旦上線,若要修改掉這個bug就十分艱難了。有了JSPatch,我們可以想象,如果可以定位到線上應用有問題的方法,使用JS文件來修改掉這個方法,這將是多麼cool的一件事,事實上,JSPatch的主要用途也是可以實現線上應用極小問題的hotfix。
三、JavaScript與Objective-C交互的基礎方法
要使用JSPatch來進行Objective-C風格的方法編寫,需要遵守一些JavaScript與Objective-C交互的規則。
1.在JavaScript文件中使用Objective-C類
在編寫JavaScript代碼時如果需要用到Objective-C的類,必須先對這個類進行require引用,例如,如果需要使用UIView這個類,需要在使用前進行如下引用:
require('UIView')
同樣也可以一次對多個Objective-C類進行引用:
require('UIView, UIColor, UILabel')
還有一種更加簡便的寫法,直接在使用的時候對其進行引用:
require('UIView').alloc().init()
2.在JavaScript文件中進行Objective-C方法的調用
在進行Objective-C方法的調用時,分為兩種,一種是調用類方法,一種是調用類的對象方法。
調用類方法:通過類名打點的方式來調用類方法,格式類似如下,括號內為參數傳遞:
UIColor.redColor()
調用實例方法:通過對象打點的方式調用類的實例方法,格式如下,括號內為參數傳遞:
view.addSubview(label)
對於Objective-C中的多參數方法,轉化為JavaScript將參數分割的位置以_進行分割,參數全部放入後面的括號中,以逗號分割,示例如下:
view.setBackgroundColor(UIColor.colorWithRed_green_blue_alpha(0,0.5,0.5,1))
對於Objective-C類的屬性變量,在JavaScript中只能使用getter與setter方法來訪問,示例如下:
label.setText("JSPatch")
提示:如果原Objective-C的方法中已經包含了_符號,則在JavaScript中使用__代替。
3.在JavaScript中操作與修改Objective-C類
JSPatch的最大應用是在應用運行時動態的操作和修改類。
重寫或者添加類的方法:
在JavaScript中使用defineClass來定義和修改類中的方法,其編寫格式如下所示:
/* classDeclaration:要添加或者重寫方法的類名 字符串 如果此類不存在 則會創建新的類 instanceMethods:要添加或者重寫的實例方法 {} classMethods:要添加或者重寫的類方法 {} */ defineClass(classDeclaration, instanceMethods, classMethods)
示例如下:
defineClass('ViewController', { // replace the -genView method newFunc: function() { //編寫實例方法 self.view().setBackgroundColor(UIColor.redColor()) } },{ myLoad:function(){ //編寫類方法 } } )
如果在重寫了類中的方法後要調用原方法,需要使用ORIG前綴,示例如下:
defineClass('ViewController', { // replace the -genView method viewDidLoad: function() { //編寫實例方法 self.ORIGviewDidLoad() } } )
對於Objective-C中super關鍵字調用的方法,在JavaScript中可以使用self.super()來調用,例如:
defineClass('ViewController', { // replace the -genView method viewDidLoad: function() { //編寫實例方法 self.super().viewDidLoad() } } )
同樣JSPatch也可以為類添加臨時屬性,用於在方法間參數傳遞,使用set_Prop_forKey()來添加屬性,使用getProp()來獲取屬性,注意,JSPatch添加的屬性不能使用Objective-C的setter與getter方法訪問,如下:
defineClass('ViewController', { // replace the -genView method viewDidLoad: function() { //編寫實例方法 self.super().viewDidLoad() self.setProp_forKey("JSPatch", "data") }, touchesBegan_withEvent(id,touch){ 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) } })
四、JavaScript與Objective-C交互的幾種常用類型
1.結構體
在Objective-C代碼中,我們經常會使用到結構體,JSPatch中原生支持的結構體有如下幾種:CGPoint,CGSize,CGRect,NSRange。並且這幾種結構體在進行界面操作時也會經常使用到。
對於CGRect類型,JavaScript使用如下代碼創建:
var view = require('UIView').alloc().init() view.setFrame({x:100,y:100,width:100,height:100})
對於CGPoint類型,JavaScript使用如下代碼創建:
view.setCenter({x:200,y:200})
對於CGSize類型,JavaScript使用如下代碼創建:
var size = {width:200,height:200} view.setFrame({x:100,y:100,width:size.width,height:size.height})
對於NSRange類型,JavaScript使用如下代碼創建:
var range = {location: 0, length: 1}
2.選擇器Selector
對於Objective-C中的方法選擇器Selector,在JavaScript中使用字符串的形式創建,例如:
self.performSelector_withObject("func:", 1)
3.關於空對象
在JavaScript中,null與undefined都對應於Objective-C中的nil,Objective-C中的NSNull空對象,在JavaScript中使用nsnull來代替。
4.在Objective-C與JavaScript中進行block的交互
在JavaScript與Objective-C進行block交互有兩種方式,一種是在JavaScript文件中調用Objective-C中的block,一種是將JavaScript文件中的函數塊作為block參數傳遞給Objective-C。
在JavaScript文件中使用Objective-C中的block十分簡單,因為JavaScript中沒有block的概念,Objective-C會被自動轉換為函數,示例如下:
Objective-C:
typedef void(^block)(NSString * str); @interface ViewController () @end @implementation ViewController -(block)getBlock{ block block = ^(NSString * str){NSLog(@"%@",str);}; return block; } @end
JavaScript:
defineClass("ViewController", { viewDidAppear: function(animated) { var func = self.getBlock() func("123") } })
在JavaScript文件中將func作為參數block傳遞給Objective-C就復雜一些,需要使用block()方法進行包裝,例如:
Objective-C:
@interface ViewController () @end @implementation ViewController -(void)run:(void(^)(NSString * str))block{ block(@"123"); } @end
JavaScript:
defineClass("ViewController", { viewDidAppear: function(animated) { //run 方法中需要傳入一個block self.run(block("NSString*",function(str){console.log(str)})) } })
在使用block()方法對JavaScript中的Func進行包裝時,block(param1,param2)有兩個參數,第1個參數設置func中的參數類型,如果有多個參數,使用逗號分割;第2個參數為func函數體。
注意:在block()包裝的func中不可以使用self指針,如果需要使用self,需要在block外進行臨時變量的轉換,示例如下:
defineClass("ViewController", { viewDidAppear: function(animated) { //run 方法中需要傳入一個block var slf = self self.run(block("NSString*", function(str){ console.log(str) slf.log(str) })) } })
在JavaScript中分別使用__weak()與__strong來聲明弱引用與強引用對象,例如:
var slf = __weak(self) var stgSef = __strong(self)
5.關於GCD與枚舉
在JSPatch中,可以使用如下JavaScript代碼來調用GCD方法:
//阻塞當前線程一定時間 dispatch_after(1.0, function(){ }) //為主線程添加異步任務 dispatch_async_main(function(){ }) //為主線程添加同步任務 dispatch_sync_main(function(){ }) //向全局隊列中添加任務 dispatch_async_global_queue(function(){ }) JSPatch中不可以直接使用Objective-C中定義的枚舉,但是可以用其枚舉的真實值進行傳遞。例如: //UIControlEventTouchUpInside的值是1<<6 btn.addTarget_action_forControlEvents(self, "handleBtn", 1<<6);