[Swift]AlertControllerでメモリリークが起きた！便利なMemory Graph

1 はじめに
2 今回の問題
- 2.1 deinitの調査
- 2.2 原因の調査
3 解決策
4 Memory Graphについて
5 さいごに
6 おすすめ書籍

はじめに

こんにちは、suzukiです。この記事の結論は２点あります。AlertControllerが悪いわけではなく実装が悪かった。Memory Graphは便利！の２点です。記事の内容自体はアンチパターンとでも思っていただければ幸いです。今後の自分の調査・解析の際にMemory Graphを使用することを考えていこうというだけです。

今回の問題

今回の発症した問題の詳細は割愛させていただきますが、消したはずの画面が通知を受け取っているようなログが表示されていました。。
アプリとしては問題ない遷移と動作がおこなわれていたため気づかず開発をしていました。しかしながらある時ログに気づいてしまったため原因を調べていきました。

deinitの調査

しばらく調べた結果、念のためdeinitが呼ばれていないのではと疑い、deinitにBreakPointとprint()を記述してみたところ
見事に呼ばれていませんでした。便利ですね、deinit、、、、通知の解除を行うコードはここに書かれていたため呼ばれていないことが確定。

 deinit { print("deinit") //通知のオブザーバーの解除とか諸々の処理、、、、、呼ばれていない。 }

deinit {

print("deinit")

//通知のオブザーバーの解除とか諸々の処理、、、、、呼ばれていない。

}

原因の調査

deinitが毎回呼ばれないということは何か明確な問題があるはずと思い。
コードをどんどんコメントアウトしていきました。不幸にもWKWebViewがある画面でDelegateまみれで全部疑わしく見えていました。
地道に確認したところWebViewのJavaScriptのアラートを表示するコードを削除したら、deinitが呼ばれました。
今回問題となった箇所を抜き出すと下記のようなコードとなります。

アラートの表示を行うクラス

 //アラートの処理を行うハンドラー class AlertUIHandler:NSObject, WKUIDelegate{ override init() { super.init() showAlertCallback = nil } //ハンドラ自体にViewControllerを渡さずクロージャで表示を行う。 //多重にダイアログ表示を防ぐため、、、 var showAlertCallback:((UIAlertController,Bool,(()->())?)->())? // display alert dialog func webView(_ webView: WKWebView, runJavaScriptAlertPanelWithMessage message: String, initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping () -> Void) { let alertController = UIAlertController(title: "", message: message, preferredStyle: .alert) let otherAction = UIAlertAction(title: "ok", style: .default) { action in completionHandler() } alertController.addAction(otherAction) //クロージャに作成したアラートを渡す。 showAlertCallback?(alertController,true,nil) } }

//アラートの処理を行うハンドラー

class AlertUIHandler:NSObject, WKUIDelegate{

override init() {

super.init()

showAlertCallback = nil

}

//ハンドラ自体にViewControllerを渡さずクロージャで表示を行う。

//多重にダイアログ表示を防ぐため、、、

var showAlertCallback:((UIAlertController,Bool,(()->())?)->())?

// display alert dialog

func webView(_ webView: WKWebView, runJavaScriptAlertPanelWithMessage message: String, initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping () -> Void) {

let alertController = UIAlertController(title: "", message: message, preferredStyle: .alert)

let otherAction = UIAlertAction(title: "ok", style: .default) { action in

completionHandler()

}

alertController.addAction(otherAction)

//クロージャに作成したアラートを渡す。

showAlertCallback?(alertController,true,nil)

}

上記を実装しているViewController

 class NextViewController: UIViewController { /// アラートの共通処理。。。 fileprivate var alertHandler:AlertUIHandler? override func viewDidLoad() { super.viewDidLoad() alertHandler = AlertUIHandler() alertHandler?.showAlertCallback = {(alert,animated,completeHandler)->() in // 別画面表示中はアラート表示しない if self.presentedViewController == nil{ self.present(alert, animated: animated, completion: completeHandler) } } } deinit { print("deinit") //通知のオブザーバーの解除とか諸々の処理、、、、、呼ばれていない。 } }

class NextViewController: UIViewController {

/// アラートの共通処理。。。

fileprivate var alertHandler:AlertUIHandler?

override func viewDidLoad() {

super.viewDidLoad()

alertHandler = AlertUIHandler()

alertHandler?.showAlertCallback = {(alert,animated,completeHandler)->() in

// 別画面表示中はアラート表示しない

if self.presentedViewController == nil{

self.present(alert, animated: animated, completion: completeHandler)

}

deinit {

print("deinit")

//通知のオブザーバーの解除とか諸々の処理、、、、、呼ばれていない。

}

解決策

ここだけ見ると問題は単純で循環参照が起きてました。
showAlertCallBackに対して[weak self]を記述することにより循環参照が解消されます。

 override func viewDidLoad() { super.viewDidLoad() alertHandler = AlertUIHandler() alertHandler?.showAlertCallback = {[weak self](alert,animated,completeHandler)->() in // 別画面表示中はアラート表示しない if self?.presentedViewController == nil{ self?.present(alert, animated: animated, completion: completeHandler) } } }

override func viewDidLoad() {

super.viewDidLoad()

alertHandler = AlertUIHandler()

alertHandler?.showAlertCallback = {[weak self](alert,animated,completeHandler)->() in

// 別画面表示中はアラート表示しない

if self?.presentedViewController == nil{

self?.present(alert, animated: animated, completion: completeHandler)

}

Memory Graphについて

問題の解決がしたところで、この話をしたところMemory Graphが便利だと聞きました。
循環参照の検知はできたりできなったりですが、インスタンスが破棄されていないことなどは一目でわかります。
問題が起きている状態で試しに動かしたところ下記のようになりました。

プロジェクトをある程度動作させた後にやってみたら、気づかなかったメモリーリークが見つかるかもしれません。
一度使ってみてください。