JSPatch原理解析(一)

作者: Cc极生 | 来源:发表于2017-08-04 15:29 被阅读112次

    本篇开始以JSPatch给的demo代码为例按流程讲解JSPatch的实现原理
    首先在iOS的demo中在appdelegate开始看和JSPatch有关的是这几句代码

        [JPEngine startEngine];
        NSString *sourcePath = [[NSBundle mainBundle] pathForResource:@"demo" ofType:@"js"];
        NSString *script = [NSString stringWithContentsOfFile:sourcePath encoding:NSUTF8StringEncoding error:nil];
        [JPEngine evaluateScript:script];
    

    首先启动了JP引擎之后加载了本地的一个demo的js文件之后让JP引擎执行了这个js脚本文件,其实在这里那个启动JP引擎的代码其实是多余的,可能bang大神在更新JSPatch以后没有对这个demo进行更新,去查看startEngine方法的注释就可以发现这个方法被废弃了,在需要执行本地JS脚本的时候回自动调用这个方法启动引擎,在追溯evaluateScript:script方法的调用流程的时候也会发现有这么一串代码,已经自动执行了启动引擎的方法,所以我们只要着重研究evaluateScript这个方法就好了

    一.OC中对JS文件的预处理

    + (JSValue *)_evaluateScript:(NSString *)script withSourceURL:(NSURL *)resourceURL
    {
        if (!script || ![JSContext class]) {
            _exceptionBlock(@"script is nil");
            return nil;
        }
        [self startEngine];
    ...}
    

    之后就根据OC的代码可以看出来进入了JPViewController里面有一个按钮还有这个按钮未实现的接收点击事件的方法handleBtn,把项目跑起来以后会发现点击按钮会跳到一个tableview里面,明明handleBtn没有实现,那它是怎么跳转的呢?答案就在evaluateScript这里,evaluateScript这个方法主要做了几件事:
    1.首先调用了startEngine方法
    1.1初始化JSContext及一些列变量

    + (void)startEngine
    {
        if (![JSContext class] || _context) {
            return;
        }
        
        JSContext *context = [[JSContext alloc] init];
        context[@"_OC_defineClass"] = ^(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods) {
            return defineClass(classDeclaration, instanceMethods, classMethods);
        };
        _nilObj = [[NSObject alloc] init];
        _JSMethodSignatureLock = [[NSLock alloc] init];
        _JSMethodForwardCallLock = [[NSRecursiveLock alloc] init];
        _registeredStruct = [[NSMutableDictionary alloc] init];
        _currInvokeSuperClsName = [[NSMutableDictionary alloc] init];
    

    1.2.创建JS将要调用的OC方法

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

    1.3.如果是iphone的话还要检测内存警告

    #if TARGET_OS_IPHONE
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleMemoryWarning) name:UIApplicationDidReceiveMemoryWarningNotification object:nil];
    #endif
    

    1.4.执行JSPatch.js代码

        NSString *path = [[NSBundle bundleForClass:[self class]] pathForResource:@"JSPatch" ofType:@"js"];
        if (!path) _exceptionBlock(@"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和demo.js的本质关系就相当于在一个网页中先引入了JSPatch.js之后引入了demo.js
    2.修改要执行的JS文件
    _evaluateScript后半段代码是这样的

     if (!_regex) {
            _regex = [NSRegularExpression regularExpressionWithPattern:_regexStr options:0 error:nil];
        }
        NSString *formatedScript = [NSString stringWithFormat:@";(function(){try{\n%@\n}catch(e){_OC_catch(e.message, e.stack)}})();", [_regex stringByReplacingMatchesInString:script options:0 range:NSMakeRange(0, script.length) withTemplate:_replaceStr]];
        @try {
            if ([_context respondsToSelector:@selector(evaluateScript:withSourceURL:)]) {
                NSLog(@"%@",[_context evaluateScript:formatedScript withSourceURL:resourceURL]);
                return [_context evaluateScript:formatedScript withSourceURL:resourceURL];
            } else {
                return [_context evaluateScript:formatedScript];
            }
        }
        @catch (NSException *exception) {
            _exceptionBlock([NSString stringWithFormat:@"%@", exception]);
        }
    
    

    这段代码用了一个正则表达式去把JS中写的所有.方法调用都改成了.__c(方法名),这样就与把所有的方法调用都变成了同一个方法__C然后再通过这个方法进行转发,然后给整个的js代码包裹了一个trycatch用于接受错误信息并在xcode打印出来

    二.JSPatch.js中做的预定义

    JSPatch在刚引入的时候只做了一个一件事,其它的都是定义方法但是没有实际调用,那些方法都是留给介入JSPatch开发者来调用的,而在了解JSPatch过程中的一个难点就是理解它是如何维护oc中的类和js中模拟的oc类两套操作的

    那些留给开发者调用的代码我们日后遇到了再说,先看看JSPatch一引入做了什么事

      var _ocCls = {};
      var _jsCls = {};
    

    首先在文件开头声明了两个数组,一个存储的是oc的class另一个是存储的js的class,实际在后期可以得知这个数组有三层分别是_jsCls[类名][类方法还是实例方法][方法名],就是用这个数组实现了逻辑上的类

      var _customMethods = {
        __c: function(methodName) {... },
        super: function() {...},
        performSelectorInOC: function() {...},
        performSelector: function() {...}
      }
    

    可以很清晰的看出来,定义了一个js对象,然后后面的for循环将这个对象里面的方法挨个绑定在js的object原型上,有点类似使用catagory给NSObject添加方法,重点就在这几个方法中的__C上面,js里面没有iOS的消息转发机制,但是给js的object原型上绑定的这个__C实现了这个机制,至于如何把所有的js方法都转发到__c上处理之后会讲到

        __c: function(methodName) {
          var slf = this
          if (slf instanceof Boolean) {
            return function() {
              return false
            }
          }
    
          if (slf[methodName]) {
            return slf[methodName].bind(slf);
          }
    
          if (!slf.__obj && !slf.__clsName) {
            throw new Error(slf + '.' + methodName + ' is undefined')
          }
          if (slf.__isSuper && slf.__clsName) {
              slf.__clsName = _OC_superClsName(slf.__obj.__realClsName ? slf.__obj.__realClsName: slf.__clsName);
          }
    
          var clsName = slf.__clsName
          if (clsName && _ocCls[clsName]) {
            var methodType = slf.__obj ? 'instMethods': 'clsMethods'
            if (_ocCls[clsName][methodType][methodName]) {
              slf.__isSuper = 0;
              return _ocCls[clsName][methodType][methodName].bind(slf)
            }
          }
          
          return function(){
            var args = Array.prototype.slice.call(arguments)
            return _methodFunc(slf.__obj, slf.__clsName, methodName, args, slf.__isSuper)
          }
        },
    

    __c方法:首先取到这个js对象调用的方法名,然后做了一系列判断以进行方法转发
    a.去查这个js对象有没有这个方法,该对象有该方法名的方法,则直接将该方法绑定到 即将调用的方法上

    b.如果没有就判断一下这个对象存不存在,因为如果是调用被类的方法那就一定会使用defineClass,defineClass会初始化该Class,如果是调用其它类的对象也会用到require()来引入该类,所以如果没有初始化该对象,说明这个对象不存在直接报错没有这个方法定义

    c.如果对象存在但本类又没有这个方法的话判断一下__isSuper是否要去找父类方法比如如果调用时self.method就不需要,如果是super.method就需要从父类去找这个方法(消息转发)

    d.如果需要就调用_OC_superClsName方法让oc在运行时中找一下该类的父类的类名如果有这个类名而且这个方法还在模拟oc类中的方法表ocCls中注册了,就从occls的方发表中找到这个方法去绑定到该调用上

    e.最后如果都没找到就说明这个方法不是在js里面写的,然后调用_methodFunc去oc里面找这个方法,_methodFunc方法很简单,这个方法将js中写的方法名处理成oc中的真实方法名然后将参数传过去,最后将调用oc方法后的返回值格式化成js的对象传回来,这样就完成了消息转发。

    super方法:在__C方法中使用的isSuper和oc中的概念一样,super和self都是指向的本类输出[self class]和[super class]结果相同,只是super有一个标志表明了要求父类寻找方法以下绑定的super方法也证实了这点返回了一个模拟指针与slf的唯一不同点是把isSuper标志改成了1

        super: function() {
          var slf = this
          if (slf.__obj) {
            slf.__obj.__realClsName = slf.__realClsName;
          }
          return {__obj: slf.__obj, __clsName: slf.__clsName, __isSuper: 1}
        },
    

    performSelector方法:与__C方法结尾的查找oc运行时方法同理就不赘述了
    performSelectorInOC方法:描述见这里
    https://github.com/bang590/JSPatch/wiki/performSelectorInOC-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3

    相关文章

      网友评论

        本文标题:JSPatch原理解析(一)

        本文链接:https://www.haomeiwen.com/subject/vzqplxtx.html