iOS

【Swift】WKWebViewのWKUserContentControllerで循環参照

投稿日:

はじめに

こんにちはsuzukiです。今回はwebviewのWKUserContentControllerで起きた循環参照について、備忘もかねて触れていこうと思います。
先に結論から言うとaddしたらremoveしましょうです。
循環参照が起きて実害が起きるまでなかなか気付かないのですが、webView関係は実害が起こりやすい+起こるような実装をしがちな印象があります。

循環参照が起きた原因

WKUserContentControllerを利用してweb側とアプリ側でやりとりをすることができます。
例えばwebで設定したアラートをアプリでダイアログ表示などするとか、web側のイベントを検知し、アプリ側でハンドリングしUIAlertControllerを使うのようなことが可能です。

実装

WKUserContentControllerfunc add(WKScriptMessageHandler, name: String)でjsからメッセージが送られてきた場合のハンドリング先を設定できます。

上記のコードでは”alertAction”と言う名前でwebからメッセージを受け取ったら、下記の関数がよばれます。
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage)

またweb側ではwebkit.messageHandlers.alertAction.postMessage()で上記のメッセージを呼ぶことが可能です。

実装の問題の箇所

今回のコードは設定した内容は問題なく動くのですが、func add(WKScriptMessageHandler, name: String)でselfを渡してしまっているので、循環参照が起きてしまいます。

上記のようにdeinitを記述してもよばれることはありません。
画面を閉じる処理を読んでもメモリリークが発生しインスタンスの破棄が行われなくなってしまいます。

修正方法

結論でも言いましたが、addした内容はremoveしましょう。func removeScriptMessageHandler(forName name: String)を呼ぶことで設定を削除できます。

さいごに

WebView関連では循環参照による不具合がよく起きがちです。しかも検知するのが、アプリではなくweb側だったりするので、調査に苦労します。問題を未然に防ぐためにも変なWebViewのインスタンスは残さないようにしていきましょう。

おすすめ書籍

[改訂新版]Swift実践入門 ── 直感的な文法と安全性を兼ね備えた言語 WEB+DB PRESS plus 詳解 Swift 第4版 [改訂新版]Swiftポケットリファレンス (POCKET REFERENCE)

blog-page_footer_336




blog-page_footer_336




-iOS
-

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA


関連記事

swift

Swift3でMapKitの吹き出し(Callout)タップを取得したい!

1 はじめに2 MapKitでの吹き出しタップ3 吹き出しのみタップしたい!4 さいごに はじめに こんにちは、nukkyです。 今回、iOSのMapKitでGoogleMapのように 吹き出しのタッ ...

swift

[Swift]動画撮影にて好きなサイズでプレビュー表示する

1 はじめに1.1 前提条件2 実装3 さいごに はじめに こんにちは、nukkyです。 今回はメインのビューの右上とかに小窓の様なプレビューにカメラの映像を出して、動画撮影するという機能を作成したの ...

swift

[Swift3] コードで動的にオートレイアウトを変更する

1 はじめに1.1 前提条件2 事前準備3 1.NSLayoutConstraintのActiveを切り替える4 2.NSLayoutConstraintのActiveを切り替える(複数同時)5 3. ...

swift

Swift3でRealmを使ってみる

1 はじめに1.1 前提条件2 事前準備2.1 Realmのインストール・設定2.1.1 Carthageファイルの生成2.1.2 CarhageにてRealmをインストール2.1.3 Realmをイ ...

swift

[Swift]通信状況を取得できるReachability.swiftを使ってみた

1 はじめに2 準備3 実装3.1 通信状況を確認する3.2 通信可能になった時に通知する4 さいごに はじめに こんにちは、nukkyです。 今回は端末の通信状況を取得できるReachability ...

フォロー

blog-page_side_responsive

2022年3月
 12345
6789101112
13141516171819
20212223242526
2728293031  

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。