Latest 0.1.4
Homepage https://github.com/yuantiku/YTKWebView-iOS
License MIT
Platforms ios 7.0
Dependencies YTKJsBridge
Authors

CI Status
Version
License
Platform

YTKWebView 是什么

YTKWebView是对UIWebView更高层级的封装一个工具类,给UIWebView封装了生命周期、JS注入通信的能力,生命周期概念包括:init初始化、loading加载中、succeed加载完毕、failed加载失败、close关闭,主要依赖UIWebViewDelegate、runtime、YTKJSBridge来实现的。

YTKWebView 提供了哪些功能

  • 支持生命周期概念。
  • 支持自动或者手动管理生命周期。
  • 支持生命周期变化通知,包括Protocol、Notification的通知方式。
  • 支持向webView注入JS方法。
  • 支持调用webView提供的js方法。

哪些项目适合使用 YTKWebView

YTKWebView 适合ObjectC实现的项目,并且项目中使用UIWebView作为网页展示的容器,并且有较多的JS通信需求。

如果你的项目使用了YTKWebView,将会提升WebView的加载速度以及用户使用体验,节省JS通信的开发成本提高开发效率。

YTKWebView 的基本思想

YTKWebView 的基本思想是给UIWebView封装上一个生命周期的概念。

对于webView的UIWebViewDelegate的回调不会产生影响,生命周期状态发生变化会通过protocol或notification的方式通知使用方,使用方可以根据状态变化做一些事情,例如:loading状态的时候显示native loading 的UI,这样webView没有渲染完毕之前,用户不会看到一个空白页面之类的;close状态的时候清理webView资源等。

通过JSContext注入的方式实现JS同步、异步调用native的方法,从而实现JS与native之间互相调用。

安装

你可以在Podfile中加入下面一行代码来使用YTKWebView

pod 'YTKWebView'

安装要求

YTKWebView 版本 最低 iOS Target 注意
0.1.0 iOS 7 要求 Xcode 7 以上

例子

clone当前repo, 到Example目录下执行pod install命令,就可以运行例子工程

使用方法

生命周期使用方法,看是否需要主动管理YTKWebView的生命周期,如果不需要管理,则只需要监听生命周期变化通知即可;如果需要主动管理YTKWebView生命周期,则需要通过业务代码来管理YTKWebView的生命周期,一个典型的例子就是JS控制YTKWebView的生命周期,例如显示loading UI等,然后通知native来做一些事情,如下所示:

// 手动管理生命周期
UIWebView *webView = [UIWebView new];
YTKWebView *ytkWebView = [[YTKWebView alloc] initWithWebView:webView];
ytkWebView.lifecycleDelegate = self;

// 监听YTKWebView生命周期变化通知,支持protocol以及notification的方式,这里以protocol为例
#pragma mark - YTKWebViewLifecycleDelegate
- (void)webViewLifecycle:(YTKWebViewLifecycle *)lifecycle webView:(UIWebView *)webView lifecycleStateDidChange:(YTKWebViewLifecycleState)state {
    NSLog(@"lifecycle did change: %@", @(state));
}

JS与native互调使用方法,native向JS注入方法,需要创建一个注入方法实现类,下面就是向JS注入同步syncSayHello以及异步asyncSayHello的方法例子,方法功能是弹出alert,标题通过JS指定,注意:方法是在异步线程执行的,如下所示:

@interface YTKAlertHandler : NSObject

@end

@implementation YTKAlertHandler

// 同步方法syncSayHello
- (void)syncSayHello:(nullable NSDictionary *)msg {
    dispatch_async(dispatch_get_main_queue(), ^{
        NSString *title = [msg objectForKey:@"title"];
        UIAlertView *av = [[UIAlertView alloc] initWithTitle: title
                                                     message: nil
                                                    delegate: nil
                                           cancelButtonTitle: @"OK"
                                           otherButtonTitles: nil];
        [av show];
    });
}

// 异步方法asyncSayHello,带有异步方法回调completion
- (void)asyncSayHello:(nullable NSDictionary *)msg completion:(void(^)(NSError *error, id value))completion {
    dispatch_async(dispatch_get_main_queue(), ^{
        NSString *title = [msg objectForKey:@"title"];
        UIAlertView *av = [[UIAlertView alloc] initWithTitle: title
                                                     message: nil
                                                    delegate: nil
                                           cancelButtonTitle: @"OK"
                                           otherButtonTitles: nil];
        [av show];
        if (completion) {
            completion(nil, nil);
        }
    });
}

@end

向JS注入sayHello方法,如下所示:

UIWebView *webView = [UIWebView new];
YTKWebView *ytkWebView = [[YTKWebView alloc] initWithWebView:webView];
// 向JS注入在命名空间yuantiku之下的sayHello方法
[ytkWebView addJsCommandHandlers:@[[YTKAlertHandler new]] namespace:@"yuantiku"];

JS调用native注入的方法,下面就是JS调用native来异步执行yuantiku命名空间下的asyncSayHello方法的代码,客户端注入的asyncSayHello方法需要title参数,如下所示:

// 准备要传给客户端异步方法asyncSayHello的数据,包括指令,数据,回调等,
var data = {
    methodName:"yuantiku.asyncSayHello", // 带有命名空间的方法名
    args:{title:"async: hello world"},  // 参数
    callId:123  // callId为-1表示同步调用,否则为异步调用
};
// 直接使用这个客户端注入的全局YTKJsBridge方法调用yuantiku命名空间下的asyncSayHello方法执行
YTKJsBridge(data);

下面就是JS调用native来同步执行yuantiku命名空间下的syncSayHello方法的代码,客户端注入的syncSayHello方法需要title参数,如下所示:

// 准备要传给客户端同步方法syncSayHello的数据,包括指令,数据,回调等,
var data = {
    methodName:"yuantiku.syncSayHello", // 带有命名空间的方法名
    args:{title:"sync: hello world"},  // 参数
    callId:-1  // callId为-1表示同步调用,否则为异步调用
};
// 直接使用这个客户端注入的全局YTKJsBridge方法调用yuantiku命名空间下的syncSayHello方法执行
YTKJsBridge(data);

native调用JS方法,下面就是native调用JS执行名为alert的JS方法,带有三个参数message,cancelTitle,confirmTitle,分别代表alert提示的文案、取消按钮文案、确认按钮文案,如下所示:

UIWebView *webView = [UIWebView new];
// webView加载代码省略...
YTKWebView *ytkWebView = [[YTKWebView alloc] initWithWebView:webView];
// 准备传入JS的数据,包括指令,数据等
NSDictionary *parameter = @{@"message" : @"hello, world",
                        @"cancelTitle" : @"cancel",
                       @"confirmTitle" : @"confirm"};
// 客户端调用网页的alert方法,弹出alert弹窗
[ytkWebView callJsCommandName:@"alert" argument:@[parameter]];

作者

YTKWebView 的主要作者是:

lihc, https://github.com/xiaochun0618

协议

YTKWebView 被许可在 MIT 协议下使用。查阅 LICENSE 文件来获得更多信息。

Latest podspec

{
    "name": "YTKWebView",
    "version": "0.1.4",
    "summary": "YTKWebView is used for UIWebview javascript function injection and call javascript code.",
    "description": "YTKWebView use JavascriptCore for ObjectC function js injection, use UIWebView stringByEvaluatingJavaScriptFromString selector for call javascript code. The implementation code all in the YTKWebViewJSManager.",
    "homepage": "https://github.com/yuantiku/YTKWebView-iOS",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "lihc": "[email protected]"
    },
    "source": {
        "git": "https://github.com/yuantiku/YTKWebView-iOS.git",
        "tag": "0.1.4"
    },
    "platforms": {
        "ios": "7.0"
    },
    "source_files": "YTKWebView/Classes/**/*",
    "dependencies": {
        "YTKJsBridge": [
            "0.1.4"
        ]
    }
}

Pin It on Pinterest

Share This