簡介
● 項目主頁: https://github.com/bang590/JSPatch
● 示例下載: https://github.com/ios122/ios122
JSPatch 可以讓你用 JavaScript 書寫原生 iOS APP。只需在項目引入極小的引擎,就可以使用 JavaScript 調用任何 Objective-C 的原生接口,獲得腳本語言的優勢:爲項目動態添加模塊,或替換項目原生代碼動態修復 bug。
優勢
● 在項目中引入JSPatch,就可以在發現bug時下發JS腳本替換原生方法,可以做到無需更新整個APP即時修復bug!
● JSPatch用iOS內置的 JavaScriptCore.framework作爲引擎;JSPatch也符合蘋果的規則。蘋果不允許動態下發可執行代碼,但通過蘋果 JavaScriptCore.framework 或 WebKit 執行的代碼除外,JS 正是通過 JavaScriptCore.framework 執行的。
● JSPatch非常小巧
實例預覽
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
[JPEngine startEngine];
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 addSubview:[self genView]];
[self.window makeKeyAndVisible];
return YES;
}
- (UIView *)genView
{
return [[UIView alloc] initWithFrame:CGRectMake(0, 0, 320, 320)];
}
@end
// demo.js
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;
}
});
安裝
通過Cocopods安裝
pod 'JSPatch' // 在線更新應用.
手動導入
- 下載https://github.com/bang590/JSPatch並解壓
- 複製JSPatch文件夾到你的工程
使用
objective-C:
- 導入頭文件#import "JPEngine.h"
- 導入本地JS(demo.js)見文首github示例demo(可選,實際項目中,根據自己實際需要進行.)
- 調用[JPEngine startEngine] 加載引擎
- 通過[JPEngine evaluateScript:@""]接口執行 JavaScript。
[JPEngine startEngine];
// 直接執行js
[JPEngine evaluateScript:@"\
var alertView = require('UIAlertView').alloc().init();\
alertView.setTitle('Alert');\
alertView.setMessage('AlertView from js'); \
alertView.addButtonWithTitle('OK');\
alertView.show(); \
"];
// 從網絡拉回js腳本執行
[NSURLConnection sendAsynchronousRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://cnbang.net/test.js"]] queue:[NSOperationQueue mainQueue] completionHandler:^(NSURLResponse *response, NSData *data, NSError *connectionError) {
NSString *script = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
[JPEngine evaluateScript:script];
}];
// 執行本地js文件
NSString *sourcePath = [[NSBundle mainBundle] pathForResource:@"sample" ofType:@"js"];
NSString *script = [NSString stringWithContentsOfFile:sourcePath encoding:NSUTF8StringEncoding error:nil];
[JPEngine evaluateScript:script];
// 另一個例子
// 加載引擎
[JPEngine startEngine];
// 本地JS,動態更新技術就是通過服務器獲取JS更新這個JS
NSString *sourcePath = [[NSBundle mainBundle] pathForResource:@"demo" ofType:@"js"];
NSString *script = [NSString stringWithContentsOfFile:sourcePath encoding:NSUTF8StringEncoding error:nil];
[JPEngine evaluateScript:script];
JavaScript:
基礎使用方式
// 調用require引入要使用的OC類
require('UIView, UIColor, UISlider, NSIndexPath')
// 調用類方法
var redColor = UIColor.redColor();
// 調用實例方法
var view = UIView.alloc().init();
view.setNeedsLayout();
// set proerty
view.setBackgroundColor(redColor);
// get property
var bgColor = view.backgroundColor();
// 多參數方法名用'_'隔開:
// OC:NSIndexPath *indexPath = [NSIndexPath indexPathForRow:0 inSection:1];
var indexPath = NSIndexPath.indexPathForRow_inSection(0, 1);
// 方法名包含下劃線'_',js用雙下劃線表示
// OC: [JPObject _privateMethod];
JPObject.__privateMethod()
// 如果要把 `NSArray` / `NSString` / `NSDictionary` 轉爲對應的 JS 類型,使用 `.toJS()` 接口.
var arr = require('NSMutableArray').alloc().init()
arr.addObject("JS")
jsArr = arr.toJS()
console.log(jsArr.push("Patch").join('')) //output: JSPatch
// 在JS用字典的方式表示 CGRect / CGSize / CGPoint / NSRange
var view = UIView.alloc().initWithFrame({x:20, y:20, width:100, height:100});
var x = view.bounds.x;
// block 從 JavaScript 傳入 Objective-C 時,需要寫上每個參數的類型。
// OC Method: + (void)request:(void(^)(NSString *content, BOOL success))callback
require('JPObject').request(block("NSString *, BOOL", function(ctn, succ) {
if (succ) log(ctn)
}));
// GCD
dispatch_after(function(1.0, function(){
// do something
}))
dispatch_async_main(function(){
// do something
})
詳細文檔請參考wiki頁面:基礎用法
定義類/替換方法
用 defineClass()
定義 Objective-C 的類,對類和實例方法進行動態替換。
// OC
@implementation JPTableViewController
...
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
NSString *content = self.dataSource[[indexPath row]]; //may cause out of bound
JPViewController *ctrl = [[JPViewController alloc] initWithContent:content];
[self.navigationController pushViewController:ctrl];
}
- (NSArray *)dataSource
{
return @[@"JSPatch", @"is"];
}
- (void)customMethod
{
NSLog(@"callCustom method")
}
@end
// JS
defineClass("JPTableViewController", {
// instance method definitions
tableView_didSelectRowAtIndexPath: function(tableView, indexPath) {
var row = indexPath.row()
if (self.dataSource().count() > row) { //fix the out of bound bug here
var content = self.dataSource().objectAtIndex(row);
var ctrl = JPViewController.alloc().initWithContent(content);
self.navigationController().pushViewController(ctrl);
}
},
dataSource: function() {
// get the original method by adding prefix 'ORIG'
var data = self.ORIGdataSource().toJS();
return data.push('Good!');
}
}, {})
詳細文檔請參考wiki頁面:defineClass的用法
擴展
一些自定義的struct類型、C函數調用以及其他功能可以通過擴展實現,調用 +addExtensions:
可以加載擴展接口:
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
[JPEngine startEngine];
//添加擴展
[JPEngine addExtensions:@[@"JPInclude", @"JPCGTransform"]];
NSString *sourcePath = [[NSBundle mainBundle] pathForResource:@"demo" ofType:@"js"];
NSString *script = [NSString stringWithContentsOfFile:sourcePath encoding:NSUTF8StringEncoding error:nil];
[JPEngine evaluateScript:script];
}
include('test.js') //`include()`方法在擴展 JPInclude.m 裏提供
var view = require('UIView').alloc().init()
//struct CGAffineTransform 類型在 JPCGTransform.m 裏提供支持
view.setTransform({a:1, b:0, c:0, d:1, tx:0, ty:100})
擴展可以在JS動態加載,更推薦這種加載方式,在需要用到時才加載:
require('JPEngine').addExtensions(['JPInclude', 'JPCGTransform'])
// `include()` and `CGAffineTransform` is avaliable now.
可以通過新增擴展爲自己項目裏的 struct 類型以及C函數添加支持,詳情請見wiki頁面:添加新擴展
安全性
JSPatch非常強大,因而最好將通過服務器獲取JS的鏈接進行加密,本地JS也最好加密處理。
本文有因爲問題請聯繫
QQ:563699115
Telephone:18341266547