iOS原生与JavaScript交互
一. 修改默认User-Agent
在使用原生的API和JavaScript进行交互的时候, 前端需要通过User-Agent字段来判断请求页面展示的来源( 这个H5页面会在公众号和APP端进行展示), 这就需要我们在加载HTML页面的时候去修改User-Agent的内容, 或者在其中添加一个标识:
1.1 全局修改--覆盖原有的值(不建议使用)
如果只是想修改User-Agent的内容, 其原来的默认值被覆盖不会影响使用的话, 可以在应用启动的时候, 按照如下的方式来全局修改, 很简单, 只需:
let dic = ["UserAgent": "ios-app"]
UserDefaults.standard.register(defaults: dic)
UserDefaults.standard.synchronize()
注意: 这样操作会覆盖User-Agent原有的默认值, 其默认值, 再不同设备/操作系统版本会略有不同, 大致长这个样子:
Mozilla/5.0 (iPhone; CPU iPhone OS 11_1_2 like Mac OS X) AppleWebKit/604.3.5 (KHTML, like Gecko) Mobile/15B202
如下图所示, 这样修改后, 直接是ios-app了:
覆盖默认的User-Agent值
1.2 全局修改--在原有值后面追加字段(建议使用)
如果只是想在原有值后面追加一个值作为标识, 不想覆盖原有的值, 就需要先获取原有的值, 然后在其后追加一个字段, 重新赋值给User-Agent:
1.2.1 使用UIWebView
在使用UIWebView的时候, 可以这样来设置:
// 获取默认值
if let oldAgent = UIWebView().stringByEvaluatingJavaScript(from: "navigator.userAgent") {
var newAgent = oldAgent
// 添加自定义的内容
if oldAgent.hasSuffix("/ios-app") == false {
newAgent += "/ios-app"
}
// 设置global User-Agent
let dic = ["UserAgent": newAgent]
UserDefaults.standard.register(defaults: dic)
UserDefaults.standard.synchronize()
}
这里还是设置的全局值, 抓包之后查看这个值, 如下图所示:
追加
这里结尾处是追加的自定义的字段, 前面是保留的原有的内容;
1.2.2 使用WKWebView
使用WKWebView和使用UIWebView一样, 只是调用的方法不同:
WKWebView().evaluateJavaScript("navigator.userAgent") { (info, error) in
// 获取默认值
if var userAgent = info as? String {
// 添加自定义的内容
if userAgent.hasSuffix("/ios-app") == false {
userAgent += "/ios-app"
}
// 设置global User-Agent
let dic = ["UserAgent": userAgent]
UserDefaults.standard.register(defaults: dic)
UserDefaults.standard.synchronize()
}
}
使用这个方法的时候, 有个地方需要注意, 按照这种写法, 虽然和使用UIWebView的原理一样, 但是因为这儿是异步执行的, 所以这样写, 会获取不到userAgent, 并报如下的错误:
Error Domain=WKErrorDomain Code=3 "WKWebView 已失效" UserInfo={NSLocalizedDescription=WKWebView 已失效}
具体原因请参看使用WKWebView获取UserAgent遇到的问题; 所以建议如果在AppDelegate中设置可使用UIWebView替换, 或者在使用WKWebView的地方进行设置, 在使用的地方进行设置的时候需要注意: load(request)方法一定要在回调完成之后, 具体可参考下文: 1.3.2 的内容;
以上方法, 都是全局修改的, 建议将代码写在AppDelegate中, 所有的webView加载网页的时候, 其User-Agent值都会被修改, 如果想只修改某一个的webView的User-Agent的值, 可以单独设置某个webView, 单个设置只能使用WKWebView, UIWebView没有单独设置的方法.
1.3 局部修改
1.3.1 覆盖原有值(不建议使用)
如果是仅仅覆盖原有的值, 可以在WKWebView初始化完成后, 设置属性customUserAgent:
if #available(iOS 9.0, *) {
webView.customUserAgent = "ios-app"
} else {
// Fallback on earlier versions
}
不过, 这个属性在iOS 9之后才有效.
1.3.2 在原有值后追加(建议使用)
同样, 如果不想覆盖原有的值, 可以这样:
webView.evaluateJavaScript("navigator.userAgent") {[weak webView] (info, error) in
// 获取默认值
if var userAgent = info as? String {
// 添加自定义的内容
if userAgent.hasSuffix("/ios-app-cgyc") == false {
userAgent += "/ios-app"
}
if #available(iOS 9.0, *) {
webView?.customUserAgent = userAgent
} else {
// Fallback on earlier versions
}
}
}
这里你会遇到一个问题: 明明这样设置了, 但是获取到的User-Agent的值还是默认的, 这是因为这个方法是异步执行的, 加载HTML的方法, 一定要在给customUserAgent赋值之后:
webView.evaluateJavaScript("navigator.userAgent") {[weak webView] (info, error) in
// 获取默认值
if var userAgent = info as? String {
// 添加自定义的内容
if userAgent.hasSuffix("/ios-app-cgyc") == false {
userAgent += "/ios-app"
}
if #available(iOS 9.0, *) {
webView?.customUserAgent = userAgent
} else {
// Fallback on earlier versions
}
// let dic = ["UserAgent": userAgent]
// UserDefaults.standard.register(defaults: dic)
// UserDefaults.standard.synchronize()
// 加载网页
let request = URLRequest(url: ul)
webView?.load(request)
}
}
这样, 再去查看, 就会发现已经是修改之后的了.
同样这里也可以使用下面的方法解注释来全局设置:
let dic = ["UserAgent": userAgent]
UserDefaults.standard.register(defaults: dic)
UserDefaults.standard.synchronize()
二. JavaScript与原生交互
在使用WKWebView与JavaScript进行交互的时候, 需要遵循协议: WKScriptMessageHandler, 此协议只有一个方法:
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage)
然后创建WKUserContentController对象, 完整的代码为:
let user = WKUserContentController()
// 向js中注入协议, 作为ios和js交互的依据
user.add(self, name: "appProtocol")
let config = WKWebViewConfiguration()
config.userContentController = user
let webView = WKWebView(frame: self.view.bounds, configuration: config)
let url = Bundle.main.url(forResource: "appToJSTest", withExtension: "html")
guard let ul = url else {
return
}
let request = URLRequest(url: ul)
webView.load(request)
然后实现代理方法:
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
// 通过message的name属性来区分我们注入的协议, 分别处理
// 通过message的body属性来获取js端传过来的数据, 可能是String, Number, Array, Dictionary
if message.name == "appProtocol" {
print(message.body)
}
}
最后, 在js中使用下面方法来使用这个协议:
window.webkit.messageHandlers.appProtocol.postMessage({body: 'Alert', num: '123456788', price: '100'});
其中appProtocol 为iOS端注入的协议名称, postMessage内的参数, 即为js端需要发送给iOS的内容, 这里是一个字典.
这样就实现了iOS端与js端的交互.
坑---这里有一点需要注意:
postMessage里的参数, 如果没有参数需要传递给iOS端, 不能这样写postMessage(), 可以写成这样postMessage({}); 不然, 收不到事件!
需要注意, 在页面的deinit方法中, 要移除注入的协议:
webView.configuration.userContentController.removeScriptMessageHandler(forName: "appProtocol")
一个完整的交互, 就完成.
这里有一个严重的问题, 页面的deinit方法没有被调用, 这是因为在使用下面的方法的时候, 出现了内存泄露:
user.add(self, name: "appProtocol")
解决的方法是另外写一个类, 将这个代理使用中间者转换一下:
import UIKit
import WebKit
class LQScriptMessageDelegate: NSObject, WKScriptMessageHandler {
weak var delegate: WKScriptMessageHandler?
init(_ delegate: WKScriptMessageHandler) {
super.init()
self.delegate = delegate
}
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
self.delegate?.userContentController(userContentController, didReceive: message)
}
}
然后这样使用这个类:
// 向js中注入协议, 作为ios和js交互的依据
user.add(LQScriptMessageDelegate.init(self), name: "appProtocol")
这样即可解决内存泄露的问题, 正常释放了页面.
三. HTTPs权限认证
使用WKWebView进行HTTPS的权限认证简单了许多, 只需要实现WKNavigationDelegate代理中的下面这个方法:
// HTTPS安全认证
func webView(_ webView: WKWebView, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) {
if challenge.protectionSpace.authenticationMethod == NSURLAuthenticationMethodServerTrust {
if challenge.previousFailureCount == 0 {
let credential = URLCredential(trust: challenge.protectionSpace.serverTrust!)
completionHandler(URLSession.AuthChallengeDisposition.useCredential, credential)
} else {
completionHandler(URLSession.AuthChallengeDisposition.cancelAuthenticationChallenge, nil)
}
} else {
completionHandler(URLSession.AuthChallengeDisposition.cancelAuthenticationChallenge, nil)
}
}
需要注意的是, 这个方法在iOS8中有个bug: 自建证书的HTTPS链接，不调用此代理方法; 好在iOS 9中做了修复, 但是在iOS8上使用还是会有问题.
