【Swift】WKWebView でブラウザアプリを作ったときにはまった落とし穴

はじめに

WKWebView を使って、iPhone 向けのブラウザアプリを自分で作っています。WKWebView は、アプリの中にウェブページを表示するための Apple の部品で、Safari と同じ WebKit(ページを表示する仕組み)が中で動いています。

ある日、「再生中のタブを閉じても音が止まらない」ことに気づきました。ついでにほかにも怪しいところが無いか全体を見直したところ、似たような不具合がいくつも見つかりました。どれも「WKWebView に任せておけば勝手にやってくれるだろう」と思っていたところが原因でした。

この記事は、そのとき見つけて直した不具合の、症状・原因・直し方のまとめです。コードは実際のアプリのものではなく、要点だけを抜き出して書き直した例です。

タブを閉じても動画の音が止まらない

症状

動画を再生しているタブを閉じても、音が鳴り続けます。ピクチャ・イン・ピクチャ(PiP、動画を小さな窓で画面の隅に出す機能)も残ったままでした。タブを開いて閉じるたびに、メモリも増えていきます。

原因

原因は 2 つ重なっていました。

1 つめは閉包(クロージャ)の循環参照です。タブが「閉じて」と頼むための閉包の中で、タブ自身を強く持っていました。

// だめな例:tab → onClose → tab の輪になり、どちらも解放されない
tab.onClose = { [weak self] in
    self?.closeTab(tab)
}

self(タブを束ねる側)は weak にしていたのに、tab は強参照のままでした。タブが閉包を持ち、閉包がタブを持つので、一覧から外しても参照が 0 にならず、タブも中の WKWebView も解放されません。WKWebView が生きている限り、ページの動画は鳴り続けます。

2 つめは、閉じるときに stopLoading() しか呼んでいなかったことです。stopLoading() が止めるのはページの読み込みだけで、すでに流れている動画や音声は止まりません。バックグラウンド再生を有効にしているアプリでは、なおさら鳴り続けます。

直し方

閉包ではタブも weak で持ちます。

tab.onClose = { [weak self, weak tab] in
    guard let self, let tab else { return }
    self.closeTab(tab)
}

そのうえで、タブを閉じるときに必ず呼ぶ後片付けを 1 か所にまとめました。

func tearDown() {
    onClose = nil                       // 外へ向いた閉包を切る
    webView.pauseAllMediaPlayback(completionHandler: nil)         // 再生を止める
    webView.closeAllMediaPresentations(completionHandler: nil)    // PiP・全画面を閉じる
    webView.stopLoading()
    webView.configuration.userContentController.removeAllScriptMessageHandlers()
    webView.navigationDelegate = nil
    webView.uiDelegate = nil
    webView.loadHTMLString("", baseURL: nil)                      // 空のページにする
}
  • pauseAllMediaPlayback と closeAllMediaPresentations は WKWebView のメソッドで、ページの中の再生をまとめて止め、PiP や全画面の表示を閉じます
  • スクリプトからのメッセージの受け口(WKScriptMessageHandler)は、空ページへ移る前に外します。移るときにページが出す知らせを、閉じたタブが受けないようにするためです

これを「タブを閉じる」だけでなく、「閲覧データをすべて消す」「モードを切り替えてタブを作り直す」など、タブを捨てる場所すべてから呼ぶようにしました。同じ原因が 3 か所にあったからです。

ひとつ気をつけたのは、ここで webView.removeFromSuperview()(画面から外す)まではしないことです。先に画面から外すと、WebKit がそのページの処理を後回しにするのか、一時停止が遅れることがありました。画面から外すのは SwiftUI に任せています。

確かめ方

解放されたかどうかは、単体テストで弱参照が nil になるかを見ると確かめられます。

func testClosedTabIsReleased() async {
    let model = BrowserModel()
    weak var weakTab: Tab?
    autoreleasepool {
        let tab = model.addTab()
        weakTab = tab
        model.closeTab(tab)
    }
    // WebKit の後片付けを少し待つ
    for _ in 0..<100 where weakTab != nil {
        try? await Task.sleep(for: .milliseconds(20))
    }
    XCTAssertNil(weakTab)
}

直す前のコードでは、このテストが落ちることを先に確かめてから直しました。

動画を止めても他のアプリの音楽が戻らない

症状

ミュージックアプリなどで音楽を聴いている途中にブラウザで動画を再生すると、音楽は止まります。ここまでは普通です。ところが、動画を止めても、タブを閉じても、音楽が戻ってきません。

原因

ページで何かが鳴り始めたときに、アプリは音の権利(オーディオセッション)を引き取っていました。

let session = AVAudioSession.sharedInstance()
try? session.setCategory(.playback, mode: .moviePlayback)
try? session.setActive(true)

ところが、返す処理がどこにもありませんでした。AVAudioSession は、一度 setActive(true) したら、アプリが自分で手放すまで持ったままです。

直し方

どのタブも鳴っていなくなったら、.notifyOthersOnDeactivation を付けて手放します。このオプションを付けると、止められていた他のアプリに「もう再生を戻してよい」と知らせが届きます。

try AVAudioSession.sharedInstance()
    .setActive(false, options: .notifyOthersOnDeactivation)

難しかったのは「どのタブも鳴っていない」の見分け方です。ページに仕込んだスクリプトからの知らせだけでは、音声だけの再生を数え漏らしたり、閉じたタブの分が残ったりします。そこで、WKWebView に直接聞くことにしました(iOS 15 から使えます)。

webView.requestMediaPlaybackState { state in
    let isPlaying = (state == .playing)
}

実際に動かすと、ほかにも細かい点がありました。

  • 少し待ってから調べる:広告から本編へ、曲から曲へと、止まってすぐ鳴り直すことがあります。すぐ返すと他のアプリの音楽が一瞬だけ戻ってしまうので、1 秒待ってから調べます
  • 何も読んでいないタブには聞かない:URL が無いタブに聞くと答えが返らないことがありました。念のため、答えが 1 秒で来なければ打ち切ります
  • 返すのに失敗したら試し直す:止めた直後は WebKit 側の音の出口がまだ開いていて、setActive(false) が失敗することがあります。1 秒おきに数回試し直します
  • 調べている間に新しい再生が始まったら返さない:再生が始まるたびに番号を 1 つ進めておき、調べ終わったときに番号が変わっていたら返却を取りやめます

window.open の小窓でログインや決済が終わらない

症状

「Google でログイン」のように小窓を開いてログインするサイトや、カード決済の本人確認(3D セキュア)で、小窓の中の手続きは進むのに、元のページに結果が戻らず先へ進めません。

原因

ページが window.open() で新しい窓を開こうとすると、WKWebView は WKUIDelegate の webView(_:createWebViewWith:for:windowFeatures:) を呼びます。ここでアプリは新しい WKWebView を返すか、nil を返して断るかを選びます。

もとのコードは、ここで nil を返し、URL だけを新しいタブで開き直していました。

// だめな例:ページから見ると「窓は開かなかった」ことになる
func webView(_ webView: WKWebView,
             createWebViewWith configuration: WKWebViewConfiguration,
             for navigationAction: WKNavigationAction,
             windowFeatures: WKWindowFeatures) -> WKWebView? {
    if let url = navigationAction.request.url {
        openNewTab(URLRequest(url: url))
    }
    return nil
}

見た目には新しいタブが開くので動いているように見えますが、ページの側では次のことが起きています。

  • window.open() の戻り値が null になる
  • 開いた小窓から、開いた元の窓(window.opener)が見えない。ログインの結果を元の窓へ渡せない
  • POST で送るはずだった中身が落ちる(URL だけで開き直すため)

直し方

WebKit が渡してきた configuration のまま新しい WKWebView を作り、それを返します。読み込みは WebKit が始めるので、こちらで load はしません(load し直すと POST の中身が落ちます)。

func webView(_ webView: WKWebView,
             createWebViewWith configuration: WKWebViewConfiguration,
             for navigationAction: WKNavigationAction,
             windowFeatures: WKWindowFeatures) -> WKWebView? {
    // 受け口やスクリプトの入れ物は、新しく作り直す(下の注意を参照)
    configuration.userContentController = makeUserContentController()
    let popup = makeTab(configuration: configuration)
    popup.opener = currentTab          // 閉じたら元のタブへ戻るため
    return popup.webView
}

// ページが window.close() したら呼ばれる
func webViewDidClose(_ webView: WKWebView) {
    closeTab(for: webView)
}

気をつけた点です。

  • userContentController は作り直す:渡される configuration の userContentController は、開いた元のタブと共有になっています。そのまま使って同じ名前のメッセージの受け口を足すと、二重に登録して落ちます。また、片方のタブを閉じて受け口を外すと、もう片方の受け口まで外れてしまいます
  • webViewDidClose で閉じる:ログインや決済の小窓は、終わると自分で window.close() することがあります。これを受けてタブを閉じ、開いた元のタブへ戻します
  • about:blank や URL 無しの小窓:window.open() で空の窓を開いて document.write で中身を書くページもあります。この場合は読み込みが起きず、読み込みの完了の知らせも来ません。「読み込み中」の表示を出したままにしないよう、最初から中身を見せるようにしました

コンテンツブロッカーの切り替えがすぐ効かない

症状

設定で広告・トラッカーの遮断をオフにしても、開いているタブでは遮断されたままです。逆に、オフの間に開いたタブは、オンに戻しても遮断されません。遮断に使うリストを個別にオン・オフするスイッチも、次にアプリを起動し直すまで効きませんでした。

原因

WKWebView の遮断は、WKContentRuleList(遮断の規則をまとめたもの)を WKUserContentController に足して使います。

config.userContentController.add(ruleList)

これは WKWebView を作るときの設定です。設定を変えても、すでに開いているタブの userContentController には何も起きません。もとのコードは、新しくタブを作るときにしか設定を見ていませんでした。

直し方

設定が変わったら、開いているタブすべての userContentController から規則を外し、付け直します。

func applyBlocking(to webView: WKWebView, lists: [WKContentRuleList], enabled: Bool) {
    let controller = webView.configuration.userContentController
    controller.removeAllContentRuleLists()
    controller.removeAllUserScripts()       // スクリプトは 1 本ずつ外せない
    if enabled {
        lists.forEach { controller.add($0) }
    }
    controller.addUserScript(mediaHookScript)  // 遮断と関係ないスクリプトも入れ直す
}
  • 付け直した規則は次の読み込みから効く:今表示しているページには効かないので、切り替えた直後に結果が見えるよう、表示中のタブだけ読み直します。裏のタブは次に開いたときからで十分としました
  • 付いている規則を読み返す手段が無い:WKWebView には「今どの規則が付いているか」を聞く API がありません。テストで確かめられるよう、付け外ししたときに規則の識別子を自分で覚えておくようにしました
  • ユーザースクリプトは 1 本だけ外せない:removeAllUserScripts() しか無いので、一度全部外して、遮断とは関係ないスクリプトも入れ直します
  • @Published は値が変わる前に流れる:SwiftUI の設定を Combine で見張るとき、@Published の知らせは値が書き換わる直前(willSet)に届きます。知らせの中で設定のプロパティを読み直すと古い値が返るので、流れてきた値を使います

ダウンロードのリンクを押しても何も起きない

症状

zip などのファイルのリンクを押しても、何も起きません。エラーも出ません。

原因

WKWebView は、表示できないファイルを渡されると、ダウンロードの処理を自分で用意していない限り、そのまま黙って失敗します。iOS 14.5 から WKDownload という仕組みが使えますが、アプリの側で「これはダウンロードに回す」と決めてあげる必要があります。

直し方

ダウンロードに回すのは、次の 3 つの場合です。

// 1. <a download> のように、ページが「保存して」と言うもの
func webView(_ webView: WKWebView,
             decidePolicyFor navigationAction: WKNavigationAction,
             decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) {
    decisionHandler(navigationAction.shouldPerformDownload ? .download : .allow)
}

// 2. 表示できない種類のもの  3. 添付(Content-Disposition: attachment)として届いたもの
func webView(_ webView: WKWebView,
             decidePolicyFor navigationResponse: WKNavigationResponse,
             decisionHandler: @escaping (WKNavigationResponsePolicy) -> Void) {
    guard navigationResponse.isForMainFrame else {   // iframe の中は回さない
        decisionHandler(.allow)
        return
    }
    let disposition = (navigationResponse.response as? HTTPURLResponse)?
        .value(forHTTPHeaderField: "Content-Disposition")?.lowercased() ?? ""
    let download = !navigationResponse.canShowMIMEType || disposition.hasPrefix("attachment")
    decisionHandler(download ? .download : .allow)
}

.download を返すと、WKDownload が渡されてきます。これに WKDownloadDelegate を付けて、保存先を決めます。

func webView(_ webView: WKWebView, navigationResponse: WKNavigationResponse,
             didBecome download: WKDownload) {
    download.delegate = self
}

func download(_ download: WKDownload, decideDestinationUsing response: URLResponse,
              suggestedFilename: String) async -> URL? {
    let folder = FileManager.default.temporaryDirectory
        .appendingPathComponent(UUID().uuidString, isDirectory: true)
    try? FileManager.default.createDirectory(at: folder, withIntermediateDirectories: true)
    // 名前に「/」などが入っていても、フォルダの外へは出さない
    let name = (suggestedFilename as NSString).lastPathComponent
    return folder.appendingPathComponent(name.isEmpty ? "download" : name)
}
  • navigationAction 側から来るダウンロード(didBecome download のもう一方)にも、同じように delegate を付けます
  • iframe の中は回さない:最初は iframe の中の表示できないファイルまでダウンロードに回していて、何もしていないのに共有シートが勝手に出ることがありました。主フレーム(isForMainFrame)に限ります
  • 受け取ったファイルは一時フォルダに置き、downloadDidFinish で共有シートを出して渡します。シートを閉じたらフォルダごと消します
  • 失敗したとき(download(_:didFailWithError:resumeData:))は、黙らずに「ダウンロードできませんでした」と出すようにしました

症状

このアプリには、閲覧の記録をディスクに残さないモードがあります。ところが、このモードでタブを全部閉じてから同じサイトを開くと、ログインしたままでした。

原因

記録を残さないために、WKWebsiteDataStore.nonPersistent()(Cookie などをメモリにだけ置く保存領域)を使っていました。ただし、すべてのタブが同じ 1 つの保存領域を共有しています。

let store = WKWebsiteDataStore.nonPersistent()
config.websiteDataStore = store   // どのタブもこの store を使う

nonPersistent() の中身が消えるのは、その保存領域そのものが捨てられたときです。タブを全部閉じても、保存領域はアプリが持ち続けているので、Cookie は残ります。最後のタブを閉じた直後に新しいタブを作るときも、同じ保存領域を渡していました。

直し方

最後のタブを閉じたら、新しい nonPersistent() に差し替えてから次のタブを作ります。前の保存領域は、中身を消してから手放します。

func resetEphemeralStore() {
    let old = dataStore
    dataStore = .nonPersistent()
    Task {
        await old.removeData(ofTypes: WKWebsiteDataStore.allWebsiteDataTypes(),
                             modifiedSince: .distantPast)
    }
}

「タブを全部閉じたら消す」のが正しいかどうかは仕様の決めごとなので、ここは不具合というより作り手が選ぶところです。今回は「全部閉じたら消す」にしました。

おまけ:パスコードの回数制限

WKWebView とは関係ありませんが、同じ見直しで見つかったものです。アプリを開くときのパスコードに、間違えたときの回数制限がありませんでした。

続けて間違えたら、5 回目から 1 分・5 分・15 分・以後 1 時間と待ち時間を延ばし、その間は入力を受け付けないようにしました。失敗の回数と最後に失敗した時刻はキーチェーンに置いているので、アプリを再起動しても回数は戻りません。

まとめ

WKWebView でブラウザを作るときに、見直すとよいところです。

  • タブ(WKWebView を持つもの)が、閉じたあとにちゃんと解放されるか。閉包で自分自身を強く持っていないか
  • タブを閉じるときに pauseAllMediaPlayback と closeAllMediaPresentations で再生を止めているか(stopLoading() だけでは止まらない)
  • 鳴り終わったら setActive(false, options: .notifyOthersOnDeactivation) で音の権利を返しているか
  • createWebViewWith で、渡された configuration から作った WKWebView を返しているか。webViewDidClose を受けているか
  • 遮断の規則やスクリプトを変えたとき、開いているタブにも付け直しているか
  • WKDownload でダウンロードを受けているか。iframe の中まで回していないか
  • nonPersistent() の保存領域を、いつ作り直すか決めてあるか

どれも「WebKit がやってくれるだろう」と思っていたところで、実際にはアプリが自分でやる必要がありました。特に最初の循環参照は、音が鳴り続けるという分かりやすい症状が出たので気づけましたが、音の出ないページなら、メモリが少しずつ増えるだけで気づかなかったと思います。解放されるかどうかを確かめる単体テストを 1 本置いておくと安心です。