美文网首页
UIWebView 和 H5 交互 二 之 JSExport 协

UIWebView 和 H5 交互 二 之 JSExport 协

作者: 人话博客 | 来源:发表于2018-03-10 17:02 被阅读0次

前一篇文章中,说明了一个比价关键的点。
使用 JavaScriptCore 的核心之一,就是获取 UIWebView 的 JS 上下文执行环境。
当我们拿到了这个 JSContext 执行上下文环境之后,就等于是拿到了 UIWebView 浏览器里的 global / window 全局对象了。

第一步,仍然是先获取 UIWebView 的 JS 执行环境.

- (void)webViewDidFinishLoad:(UIWebView *)webView {
    _context.exceptionHandler = ^(JSContext *context, JSValue *exception) {
        NSLog(@"获取浏览器 JS 执行环境失败:%@",exception);
    };
    // 1. 获取 WebView 的 JS 执行环境
    _context = [webView valueForKeyPath:kWebViewJSContextPath];
}

其中 #define kWebViewJSContextPath @"documentView.webView.mainFrame.javaScriptContext"

获取到JS 执行环境后,我们就可以往 JS 里注入 OC 的数据类型。

//    /**
//     往 JS 中注入 OC 的数据类型有3种方式
//     */
//    
//    // 1. JavaScript 脚本
//    [_context evaluateScript:@"var name = '李四';"];
//    // 2. JSValue
//    JSValue *value = [JSValue valueWithObject:@"尼克拉斯*赵四" inContext:_context];
//    
//    // 3.
//    _context[@"jsVar"] = @"亚洲舞王*尼古拉斯*赵四";
//    
//    // 分别获取
//    NSString *str1 = _context[@"name"].toString;
//    NSString *str2 = value.toString;
//    NSString *str3 = _context[@"jsVar"].toString;
//    NSLog(@"str1: %@ str2: %@ str3:%@",str1,str2,str3);

但有时候,光光只是注入变量或者 block 是不够用的。
有些情况下,需要把 OC 的对象暴露给 JS 使用。
也就是说往 JSContext 中注入的变量、block(OC方法),已经不够用了。
还需要注入一个完成的 OC 对象。(对象包括属性(对应变量注入) & 方法(对应 block 注入))
这样就需要 JSExport 协议的出场了。


JSExport 协议

打开 JSExport 协议,发现这只是一个空的协议。并且也没有显式的继承 NSObject 协议。

UIWebViewDelegate ,UITableViewDelegate 等都显示的继承了 NSObject 协议。

具体做法是:

一、我们首先定一个需要暴露给 JS 的 OC 对象。

@interface Person : NSObject <PersonExport> // 让此类继承这个协议

// 属性
@property (nonatomic,copy) NSString *name;
@property (nonatomic,assign) NSUInteger age;

// 实例方法
- (void)instanceMethod;
- (void)instanceMethodWithParam:(NSString *)param;

// 类方法
+ (void)classMethod;
+ (void)classMethodWithParam:(NSString *)param;

@end

二、 我们需要定一个继承自 JSExport 的自定义协议。

// 定义一个继承自 JSExport 的协议
@protocol PersonExport <JSExport>

三、 在这个协议中,我们需要把 Person 对象要暴露的属性和方法都定义在这个协议里。

// 定义一个继承自 JSExport 的协议
@protocol PersonExport <JSExport>

// 把需要对象暴露出去的属性和方法定义在这个协议里。

// 属性
@property (nonatomic,copy) NSString *name;
@property (nonatomic,assign) NSUInteger age;

// 实例方法
- (void)instanceMethod;
- (void)instanceMethodWithParam:(NSString *)param;

// 类方法
+ (void)classMethod;
+ (void)classMethodWithParam:(NSString *)param;


@end

四、 然后,我们需要让自定义 Person 来继承这个协议。

@interface Person : NSObject <PersonExport> // 让此类继承这个协议

五、 最后,创建这个对象,并把这个对象注入到 JSContext 中。

 // 但有时候,我们需要把一个 OC 对象暴露给 JS 调用。
    Person *p = [Person new];
    p.name = @"张三";
    p.age = 22;
    
    // 把这个 OC 对象注入到 JS 中
    _context[@"person"] = p;

上面的注入操作,等价于在 JS 中写了。

/**
     等价于在 JS 中写了:
     var person = {
        name : "张三",
        age : 22,
        instanceMethod:function() {
            OC的方法。
        },
        instanceMethodWithParam(param) {
            OC的方法
        },
     };
     
     function classMethod() {
        OC的方法
     }
     
     function classMethodWithParam(param) {
        OC 的方法
     }
     */

使用已经注入到 JSContext 中的 OC 对象。

JS获取OC对象的属性

 // 现在通过 JS 访问 OC 的对象属性。
    NSString *name = [_context evaluateScript:@"person.name"].toString;
    NSUInteger age = [_context evaluateScript:@"person.age"].toUInt32;
    NSLog(@"name:%@ age:%zd",name,age);

运行结果:

name:张三 age:22

JS 调用 OC 对象中的实例方法

 // 通过 JS 调用 OC 的方法
    [_context evaluateScript:@"person.instanceMethod();"];
    [_context evaluateScript:@"person.instanceMethodWithParam('呵呵哒')"];

运行结果:

2018-03-10 17:06:56.078 UIWebView & JSExport[40687:8493519] 这是 OC 的实例方法
2018-03-10 17:06:56.078 UIWebView & JSExport[40687:8493519] 这是 OC 的实例方法 参数:呵呵哒

JS 调用 OC 对象中的类方法

因为,我看有些博主说的是 JSExport 会把 OC 对象的类方法声明成 window 对象的全局方法。
所以,调用模式如下。

// 通过 JS 调用 OC 的类方法. 看到有些文章说的是,JSExport 会把类方法生成 JS 的全局对象的方法。
    [_context evaluateScript:@"classMethod()"];
   [_context evaluateScript:@"classMethodWithParam('呵呵哒')"];

但实际测试,发现并没有什么卵用。

    // 发现并没有什么乱用。
    NSString *type = [_context evaluateScript:@"typeof classMethod;"].toString;
    NSLog(@"classMethod Type is :%@",type);

最后的输出结果是: undefined。说明,classMethod 这个 OC 的类方法,并没有声明成 window 全局的函数。

我也不知道解决方案,如果有知道的小伙伴,希望能留言告诉我。


最后总结:

使用 JSExport 协议,是可以把 OC 的对象注入到 JSContext 中的。
我们也可以这么理解。

对于一个 Person 对象的注入: _context[@"person"] = p; 可以认为是在 JS 中等价的写了 var person = {}

相关文章

网友评论

      本文标题:UIWebView 和 H5 交互 二 之 JSExport 协

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