專案中使用到了JSPatch來實現線上APP bug的hot fix，使用後覺得JSPatch短小精悍並且功能強大，於是想往裡窺探下其實現機制。本文從JSPatch的使用角度去分析原始碼。

JavaScript執行環境建立

JavaScript執行環境的建立很簡單，只需要呼叫一個API即可：

[JPEngine startEngine];

+(void)startEngineAPI的主要工作是建立一個JSContext型別的全域性_context變數，後續JS和OC的互調都是在這個上下文中進行。由於JSContext實現了下面兩個方法，從而可以進行下標操作訪問：

- (JSValue
 
 *)objectForKeyedSubscript:(id)key;
- (void)setObject:(id)object forKeyedSubscript:(NSObject <NSCopying> *)key;

在_contenxt的初始化中，就大量的運用了下標操作符，就是下面這種方式：

context[@"_OC_defineClass"] = ^(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods) {
        return defineClass(classDeclaration, instanceMethods, classMethods);
    };
...
 

通過這種方式，以後就可以在JS中直接使用_OC_defineClass，從而呼叫到OC的defineClass函式。
在初始化最後，直接在_context中執行下jspatch.jsJS程式碼：

    NSString *path = [[NSBundle bundleForClass:[self class]] pathForResource:@"JSPatch" ofType:@"js"];
    NSAssert(path, @"can't find JSPatch.js");
    NSString *jsCore = [[NSString alloc] initWithData:[[NSFileManager defaultManager] contentsAtPath:path] encoding:NSUTF8StringEncoding];

    if ([_context respondsToSelector:@selector(evaluateScript:withSourceURL:)]) {
        [_context evaluateScript:jsCore withSourceURL:[NSURL URLWithString:@"JSPatch.js"]];
    } else {
        [_context evaluateScript:jsCore];
    }
 

jspatch.js中在JS全域性上下文中定義了defineClass、defineProtocol等。

解析JS程式碼

下面是JSPatch Demo裡的一段JS原始碼，該demo通過JS寫了個UITableViewContorller的示例：

// demo.js
defineClass('JPTableViewController : UITableViewController <UIAlertViewDelegate>', {
  dataSource: function() {
    var data = self.getProp('data')
    ...
    self.setProp_forKey(data, 'data')
    return data;
  },
  numberOfSectionsInTableView: function(tableView) {},
  tableView_cellForRowAtIndexPath: function(tableView, indexPath) {},
  ...
})

通過呼叫+ (JSValue *)evaluateScript:(NSString *)script withSourceURL:(NSURL *)resourceURLAPI將該JS程式碼放在之前建立的 _context中執行；在正式執行該JS程式碼前先對JS字串進行了預處理，通過正則表示式 \\.\\s*(\\w+)\\s*\\(找到JS指令碼中的所有函式呼叫，比如demo.js中的self.getProp('data'),將函式名替換成 self.__c("getProp")('data')，即新增一層__c(arg)JS呼叫，這樣呼叫任何方法前，先呼叫__c(arg)方法，這個方法在JSPatch.js中定義，後續詳細講解這個函式的定義。

    NSString *formatedScript = [NSString stringWithFormat:@"try{%@}catch(e){_OC_catch(e.message, e.stack)}", [_regex stringByReplacingMatchesInString:script options:0 range:NSMakeRange(0, script.length) withTemplate:_replaceStr]];

函式替換完成後呼叫 下面方法執行得到的JS指令碼formatedScript。

- (JSValue *)evaluateScript:(NSString *)script;

JSPatch.js中defineClass函式可以動態新增OC類，也可以給類新增類方法、例項方法、屬性。defineClass函式定義如下,主要對傳入的例項方法和類方法呼叫_formatDefineMethods函式進行js格式化，然後再呼叫_OC_defineClass函式處理前者的結果，進行更深入的類定義、類方法以及例項方法解析：

// JSPatch.js
global.defineClass = function(declaration, instMethods, clsMethods) {
    var newInstMethods = {}, newClsMethods = {}
    _formatDefineMethods(instMethods, newInstMethods)
    _formatDefineMethods(clsMethods, newClsMethods)
    var ret = _OC_defineClass(declaration, newInstMethods, newClsMethods)
    return require(ret["cls"])
  }

其中_formatDefineMethods函式定義如下,該函式對傳入的methods字典轉化成一個新的字典，key依然是原來的方法名，value變成一個包含兩個元素的陣列，第一個元素是方法引數個數（不包括self和_cmd引數），第二個元素是基於原js函式重新定義的js函式；重新定義的js函式先儲存原來的全域性self物件，然後將原js方法的第一個引數（即self）賦值給全域性的self物件，並將self引數從引數列表裡移除，利用剩下的引數呼叫原來js方法，並將執行結果返回。

// JSPatch.js
  var _formatDefineMethods = function(methods, newMethods) {
    for (var methodName in methods) {
      (function(){
       var originMethod = methods[methodName]
        newMethods[methodName] = [originMethod.length, function() {
          var args = _formatOCToJS(Array.prototype.slice.call(arguments))
          var lastSelf = global.self
          var ret;
          try {
            global.self = args[0]
            args.splice(0,1)
            ret = originMethod.apply(originMethod, args)
            global.self = lastSelf
          } catch(e) {
            _OC_catch(e.message, e.stack)
          }
          return ret
        }]
      })()
    }
  }

前面例子返回的字典為：

{"dataSource" : [0,func], "numberOfSectionsInTableView" : [1, func], "tableView_cellForRowAtIndexPath" : [2, func]}.

例項方法和類方法字典格式化後，呼叫_OC_defineClass進行進一步解析,_OC_defineClass函式其實是呼叫了OC函式static NSDictionary *defineClass(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods)
,定義如下：

   context[@"_OC_defineClass"] = ^(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods) {
        return defineClass(classDeclaration, instanceMethods, classMethods);
    };

defineClass函式做具體的解析工作, defineClass函式的具體解析步驟如下：

• 掃描classDeclaration，提取出 className， superClassName以及 protocolNames
• 如果className類不存在，則通過執行時方法 objc_allocateClassPair和 objc_registerClassPair建立並註冊className類
• 解析例項方法和類方法，
  
  • 將方法名中的雙下劃線__替換成單連字元-
  • 將單下劃線_替換成冒號:
  • 將單連字元-替換成單下劃線_,這裡其實就是告訴開發者如果方法名中實際包含下劃線，則需要使用雙下劃線
• 比較替換後的方法中冒號:的個數以及_formatDefineMethods返回的方法引數個數，決定替換後的方法名後是否需要增加一個:
• 通過呼叫 class_respondsToSelector判斷className類是否已經定義該方法，如果定義了該方法，則呼叫 overrideMethod重寫該方法，呼叫該方法不需要傳入引數描述。
• 如果className類沒有定義該方法，呼叫 methodTypesInProtocol方法查詢繼承的protocol中有沒有定義該方法，如果定義了該方法，則返回該方法的引數描述，然後將這個引數描述作為引數呼叫overrideMethod
• 如果繼承的protocol裡沒有定義該方法，則根據引數個數構建一個引數描述，這裡的引數個數需要加上self和_cmd引數，並且所有其它引數都是id型別，然後將這個生成的引數描述作為引數呼叫overrideMethod
• 呼叫執行時方法 class_addMethod給className類添加了 getProp和 setProp:forKey:兩個方法，這兩個方法通過關聯物件方式給類例項動態新增屬性，程式碼如下。
• 最後返回字典 {@"cls": className}給require(‘className’)JS方法，該方法將類資訊記錄在JS全域性變數global["className"] = {__isCls : 1, __clsNmae : "className"};

// defineClass函式
class_addMethod(cls, @selector(getProp:), (IMP)getPropIMP, "@@:@");
class_addMethod(cls, @selector(setProp:forKey:), (IMP)setPropIMP, "[email protected]:@@");

static id getPropIMP(id slf, SEL selector, NSString *propName) {
    return objc_getAssociatedObject(slf, propKey(propName));
}
static void setPropIMP(id slf, SEL selector, id val, NSString *propName) {
    objc_setAssociatedObject(slf, propKey(propName), val, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

OC的defineClass函式呼叫了 methodTypesInProtocol方法獲取方法的引數描述符，這個函式通過執行時方法 objc_getProtocol得到協議相關資訊，

    Protocol *protocol = objc_getProtocol([trim(protocolName) cStringUsingEncoding:NSUTF8StringEncoding]);

然後通過執行時方法 protocol_copyMethodDescriptionList獲取到協議中定義的可選（必須）的例項方法或者類方法列表，

    struct objc_method_description *methods = protocol_copyMethodDescriptionList(protocol, isRequired, isInstanceMethod, &selCount);

最後遍歷得到的列表，找到selectorName對應的objc_method_description，並將其引數描述符返回。

從上面分析可知OC方法 defineClass最終其實呼叫overrideMethod將例項方法instanceMethods和類方法classMethods新增到className類的，overrideMethod具體的實現步驟如下：

//overrideMethod函式原型
static void overrideMethod(Class cls, NSString *selectorName, JSValue *function, BOOL isClassMethod, const char *typeDescription)

1. 如果傳入的引數描述符 typeDescription為null，則說明這個方法已經定義過，通過 class_getInstanceMethod從cls類獲取到selectorName對應的Method，再通過 method_getTypeEncoding得到Method的引數描述符。

2. 如果cls類已經實現過selectorName方法，則獲取到原來方法對應的函式實現IMP：

   IMP originalImp = class_respondsToSelector(cls, selector) ? class_getMethodImplementation(cls, selector) : NULL;
   

3. 根據typeDescription可知道方法的返回值是不是結構體，建立selectorName選擇子和 _objc_msgForward（IMP）或者 _objc_msgForward_stret（IMP）的對映關係，

   class_replaceMethod(cls, selector, msgForwardIMP, typeDescription);

4. 將@selector(forwardInvocation:)的IMP設定為 JPForwardInvocation，將@selector(ORIGforwardInvocation:)的IMP設定為@selector(forwardInvocation:)原來的實現

   //overridMethod
   if (class_getMethodImplementation(cls, @selector(forwardInvocation:)) != (IMP)JPForwardInvocation) {
       IMP originalForwardImp = class_replaceMethod(cls, @selector(forwardInvocation:), (IMP)JPForwardInvocation, "[email protected]:@");
       class_addMethod(cls, @selector(ORIGforwardInvocation:), originalForwardImp, "[email protected]:@");
   }

5. 如果cls類原本實現過selectorName方法，則將原來的方法重新命名為ORIGselectorName，即在原來方法名加字首ORIG,

   if (class_respondsToSelector(cls, selector)) {
       NSString *originalSelectorName = [NSString stringWithFormat:@"ORIG%@", selectorName];
       SEL originalSelector = NSSelectorFromString(originalSelectorName);
       if(!class_respondsToSelector(cls, originalSelector)) {
           class_addMethod(cls, originalSelector, originalImp, typeDescription);
       }
   }

6. 通過全域性字典陣列儲存cls、 _JPselectorName、function之間的對映關係:

   _initJPOverideMethods(cls);
   _JSOverideMethods[cls][JPSelectorName] = function;

7. 給cls新增_JPselectorName方法，對映到前面得到的 msgForwardIMP。