【Swift】Xcode10.3でSwift5で書かれたプロジェクトでデリゲートが呼ばれない

はじめに

こんにちはsuzukiです。Xcode10.3でリリースビルドした際のバグについて備忘と、もし他の方が同じ事象が発生していたら何かヒントになればと思い内容をこちらにまとめさせていただきます。事象としては題名の通りなのですが、問題の事象が起きるにはいくつか条件がありました。対応方法についてははっきりとした原因がわからないため、対処療法的です。

起きた環境

Xcode10.3
Swift5

起きる条件

上記のコード上の条件が全くわからなかったのですが、同じような記事としてこちらの記事（スタックオーバーフロー）がありました。
上記の記事と実証実験を元に問題の起きるデリゲートのパターンの条件を下記と考えています。

コード上の条件

・ベースクラスにデリゲートが追加されている　(デリゲートにOptionalなメソッドが定義されている。)
・ベースクラスでデリゲートのコードは書かれていない
・子クラスでデリゲートのコードが書かれている

ビルド時の条件

・リリースビルドなどの、最適化が行われるビルド時
上記を満たしている際に子クラスで設定したデリゲートメソッドのコードが呼ばれないという事象が発生しました。

再現

先ほどの条件では完璧に再現ができるわけではございませんでした。
発生した際に行っていた作業として下記があります。
・Swift3⇨Swift5にアップデート
・Xcode10.1⇨Xcode10.3にアップデート

テスト用コード

コード上の条件をコード化しただけでこちらのコードで必ず発生するというものではございません。
起きたパターンと近しい実装例程度に思っていただければと思います。

import UIKit
//親クラスTestDelegateを追加
class BaseViewController: UIViewController ,TestDelegate {
    override func viewDidLoad() {
        super.viewDidLoad()
        let timer = TestTimer()
        timer.delegate = self
        timer.startTimer()
        // Do any additional setup after loading the view.
    }
    func normalDelegate() {
        print(#function)
    }
}
//子クラス optionalDelegateを実装
class ChildViewController: BaseViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
    }
    func optionalDelegate() {
        print(#function)
    }
}
//Delegateを繰り返し呼ぶためのタイマー
class TestTimer {
    weak var delegate: TestDelegate?
    func startTimer() {
        Timer.scheduledTimer(withTimeInterval: 3, repeats: true) { _ in
            self.delegate?.normalDelegate()
            self.delegate?.optionalDelegate?()
        }
    }
}
//デリゲート
@objc protocol TestDelegate{
    @objc optional func optionalDelegate()
    func normalDelegate()
}

対応策

下記の対応で自分の環境下では起きなくなりました。
・親クラスでoptionalな関数を実装
・子クラスでoverrideして関数を実装
先ほどのコードに置き換えると、下記のようになります。

class BaseViewController: UIViewController ,TestDelegate {
    override func viewDidLoad() {
        super.viewDidLoad()
        let timer = TestTimer()
        timer.delegate = self
        timer.startTimer()
        // Do any additional setup after loading the view.
    }
    //中身は空でもいいが元クラスで実装しておく、
    func optionalDelegate() {
        //この関数消さないで！！！！！
        print("親クラス" + #function)
    }
    func normalDelegate() {
        print(#function)
    }
}

class ChildViewController: BaseViewController {
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
    }
    //親クラスのoptionalDelegateをオーバーライド
    override func optionalDelegate() {
        print("子クラス" + #function)
    }
}

さいごに

今回の修正方法だと親クラスのリファクタリングしてたら削除しちゃいそうですね。実際に問題が起きて同じ方法で修正された方がいたらコメントはきちんと書いた方がいいと思います。FixMeでXcode10.3でリリースをする場合は消さないで＋Xcode11になったら、無駄なコードなので子クラスのオーバーライド外してこの関数は削除的な、、、もしスケジュール的な余裕があるのであれば暫定的な対応ではなくしっかりとXcode11に対応したかったです。

おすすめ書籍