はじめに (対象読者・この記事でわかること)

この記事は、Swiftを学び始めたばかりの方や、クラスの初期化方法について理解を深めたいiOS開発者を対象としています。特に「convenience init」という概念に戸惑っている方々に向けています。

この記事を読むことで、Swiftにおけるconvenience initの基本的な概念と使い方、designated initとの違い、そして実践的な活用法が理解できます。また、カスタムクラスで適切に初期化子を実装するためのベストプラクティスも学べます。Swiftの初期化システムを理解することで、より堅牢で再利用可能なコードを書くことができるようになります。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。 - Swiftの基本的な文法と構文 - クラスと構造体の基本的な概念 - インスタンスの生成方法に関する基礎知識

convenience initとは何か

Swiftには、クラスの初期化方法を柔軟にするための「designated init」と「convenience init」の2種類の初期化子があります。このうち、convenience initは「補助初期化子」とも呼ばれ、主に以下のような目的で使用されます。

  1. 同じクラス内の別の初期化子を呼び出すためのショートカットを提供する
  2. デフォルト値を持つプロパティを簡単に設定する
  3. コードの重複を減らすための初期化パターンを提供する

convenience initは、designated init（主要初期化子）を呼び出す必要があります。これは、convenience initがインスタンスの完全な初期化を完了する責任を持たないためです。この設計により、Swiftはインスタンスの完全な初期化が保証され、部分的に初期化されたインスタンスが生成されることを防ぎます。

convenience initの主な特徴は以下の通りです： - initキーワードの前に「convenience」キーワードを付ける - 同じクラス内の他の初期化子（通常はdesignated init）を呼び出す - 継承関係がある場合、スーパークラスのdesignated initを呼び出すことも可能

convenience initは、特に以下のような場面で有用です： - 複数の初期化パターンを提供したいが、共通の初期化処理がある場合 - デフォルトパラメータ値を使用したいが、一部のパラメータのみ異なる初期化方法が必要な場合 - コードの重複を避けたい場合

convenience initの具体的な使い方

ステップ1：基本的なconvenience initの実装

まずは、基本的なconvenience initの実装方法を見ていきましょう。以下に、Personクラスの例を示します。

Swift

class Person {
    var name: String
    var age: Int
    var email: String?

    // designated init
    init(name: String, age: Int, email: String?) {
        self.name = name
        self.age = age
        self.email = email
    }

    // convenience init - nameとageのみを指定する初期化子
    convenience init(name: String, age: Int) {
        self.init(name: name, age: age, email: nil)
    }

    // convenience init - 名前のみを指定する初期化子（デフォルトの年齢を設定）
    convenience init(name: String) {
        self.init(name: name, age: 0)
    }
}

この例では、3つの初期化子を実装しています。1つ目がdesignated initで、全てのプロパティを初期化します。2つ目と3つ目がconvenience initで、それぞれ異なるパラメータを受け取り、内部でdesignated initを呼び出しています。

このようにすることで、以下のように様々な方法でPersonインスタンスを生成できます：

Swift

// 全てのパラメータを指定
let person1 = Person(name: "Taro", age: 30, email: "taro@example.com")

// emailを省略
let person2 = Person(name: "Hanako", age: 25)

// ageとemailを省略
let person3 = Person(name: "Jiro")

ステップ2：継承とconvenience init

クラスを継承する場合、convenience initの実装には注意が必要です。サブクラスでconvenience initを実装する場合、スーパークラスのdesignated initを呼び出す必要があります。

以下に、EmployeeクラスがPersonクラスを継承する例を示します：

Swift

class Employee: Person {
    var employeeId: String

    // designated init
    init(name: String, age: Int, email: String?, employeeId: String) {
        self.employeeId = employeeId
        super.init(name: name, age: age, email: email)
    }

    // convenience init - employeeIdのみを指定する初期化子
    convenience init(employeeId: String) {
        self.init(name: "Unknown", age: 0, email: nil, employeeId: employeeId)
    }
}

この例では、EmployeeクラスはPersonクラスを継承しています。Employeeクラスのdesignated initでは、まず自身のプロパティ（employeeId）を初期化した後、super.initでスーパークラスのdesignated initを呼び出しています。

また、employeeIdのみを指定するconvenience initも実装しています。このconvenience initは、内部で自身のdesignated initを呼び出しています。

ステップ3：構造体でのconvenience initの使用

構造体でもconvenience initを使用できます。構造体は値型であり、継承できないため、クラスとは若干異なる特性があります。

以下に、Point構造体の例を示します：

Swift

struct Point {
    var x: Double
    var y: Double

    // designated init
    init(x: Double, y: Double) {
        self.x = x
        self.y = y
    }

    // convenience init - 原点からの距離を指定する初期化子
    convenience init(distance: Double) {
        self.init(x: distance, y: 0)
    }

    // convenience init - 角度と距離を指定する初期化子
    convenience init(angle: Double, distance: Double) {
        self.init(x: distance * cos(angle), y: distance * sin(angle))
    }
}

この例では、Point構造体に3つの初期化子を実装しています。1つ目がdesignated initで、xとy座標を直接指定します。2つ目と3つ目がconvenience initで、異なる方法でPointインスタンスを生成できます。

ステップ4：Failable initとの組み合わせ

convenience initは、Failable init（失敗可能な初期化子）と組み合わせることもできます。Failable initは、初期化に失敗した場合にnilを返す初期化子です。

以下に、Userクラスの例を示します：

Swift

class User {
    var username: String
    var age: Int

    init(username: String, age: Int) throws {
        guard !username.isEmpty else {
            throw InitializationError.emptyUsername
        }

        guard age >= 0 else {
            throw InitializationError.invalidAge
        }

        self.username = username
        self.age = age
    }

    convenience init?(username: String, age: Int) {
        do {
            try self.init(username: username, age: age)
        } catch {
            return nil
        }
    }
}

enum InitializationError: Error {
    case emptyUsername
    case invalidAge
}

この例では、Userクラスに2つの初期化子を実装しています。1つ目がFailable initではない通常の初期化子で、初期化条件を満たさない場合にエラーをスローします。2つ目がconvenience initで、Failable init（init?）として実装されています。このconvenience initは、内部で通常の初期化子を呼び出し、エラーが発生した場合にnilを返します。

ステップ5：プロパティオブサーバーの使用

convenience init内では、プロパティオブサーバー（willSet/didSet）を使用することもできます。これにより、プロパティの値が変更される前後に処理を挿入できます。

以下に、Temperatureクラスの例を示します：

Swift

class Temperature {
    var celsius: Double {
        willSet {
            print("温度が\(celsius)°Cから\(newValue)°Cに変わります")
        }
        didSet {
            print("温度が\(oldValue)°Cから\(celsius)°Cに変わりました")
        }
    }

    init(celsius: Double) {
        self.celsius = celsius
    }

    convenience init(fahrenheit: Double) {
        let celsius = (fahrenheit - 32) * 5 / 9
        self.init(celsius: celsius)
    }

    convenience init(kelvin: Double) {
        let celsius = kelvin - 273.15
        self.init(celsius: celsius)
    }
}

この例では、Temperatureクラスに3つの初期化子を実装しています。1つ目がdesignated initで、摂氏温度を直接指定します。2つ目と3つ目がconvenience initで、華氏温度と絶対温度から摂氏温度を計算し、designated initを呼び出しています。

また、celsiusプロパティにはwillSetとdidSetを実装しており、温度が変更される前後にメッセージが出力されます。

ハマった点やエラー解決

convenience initを使用する際によく遭遇する問題とその解決方法を以下に示します。

問題1：初期化チェーンのループ

convenience init内で、誤って自身の別のconvenience initを呼び出してしまうと、初期化チェーンがループしてしまい、スタックオーバーフローが発生します。

エラー例：

Swift

class MyClass {
    var value: Int

    init(value: Int) {
        self.value = value
    }

    convenience init() {
        self.init(value: 0)  // OK
        // self.init()  // NG: ここでループが発生する
    }
}

解決策： convenience initは、必ず同じクラスのdesignated initを呼び出すようにしてください。上記の例では、コメントアウトされている行がループを引き起こす原因です。

問題2：スーパークラスの初期化子の呼び出し忘れ

サブクラスでconvenience initを実装する際に、スーパークラスのdesignated initを呼び出し忘れると、コンパイルエラーが発生します。

エラー例：

Swift

class SuperClass {
    var value: Int

    init(value: Int) {
        self.value = value
    }
}

class SubClass: SuperClass {
    var extraValue: String

    // このinitはコンパイルエラーになる
    convenience init(value: Int, extraValue: String) {
        self.extraValue = extraValue  // スーパークラスの初期化前にプロパティにアクセス
        // super.init(value: value)  // これが呼び出されていない
    }
}

解決策： サブクラスのconvenience init内では、まず自身のdesignated initを呼び出し、そのdesignated init内でスーパークラスのdesignated initを呼び出すようにしてください。

Swift

class SubClass: SuperClass {
    var extraValue: String

    init(value: Int, extraValue: String) {
        self.extraValue = extraValue
        super.init(value: value)
    }

    convenience init(value: Int, extraValue: String) {
        self.init(value: value, extraValue: extraValue)
    }
}

問題3：非オプショナル型のプロパティの初期化漏れ

convenience init内で、designated initを呼び出す前に非オプショナル型のプロパティに値を設定しないと、コンパイルエラーが発生します。

エラー例：

Swift

class MyClass {
    var value: Int  // 非オプショナル型
    var optionalValue: String?

    init(value: Int, optionalValue: String?) {
        self.value = value
        self.optionalValue = optionalValue
    }

    convenience init(optionalValue: String?) {
        // self.value = 0  // これがないとコンパイルエラーになる
        self.init(value: 0, optionalValue: optionalValue)
    }
}

解決策： convenience init内でdesignated initを呼び出す前に、非オプショナル型のプロパティに値を設定するか、designated initの呼び出し後に設定してください。

Swift

class MyClass {
    var value: Int
    var optionalValue: String?

    init(value: Int, optionalValue: String?) {
        self.value = value
        self.optionalValue = optionalValue
    }

    convenience init(optionalValue: String?) {
        self.value = 0  // ここで値を設定
        self.init(value: self.value, optionalValue: optionalValue)
    }
}

まとめ

本記事では、Swiftのconvenience initの基本的な概念と使い方について解説しました。

  • convenience initは、designated initを補助する初期化子であり、主にコードの重複を減らすために使用される
  • convenience initは、必ず同じクラスのdesignated initを呼び出す必要がある
  • 継承関係がある場合、サブクラスのconvenience initはスーパークラスのdesignated initを呼び出す必要がある
  • convenience initは、Failable initやプロパティオブサーバーと組み合わせて使用できる
  • 初期化チェーンのループやスーパークラスの初期化子の呼び出し忘れなど、よくあるエラーには注意が必要

この記事を通して、Swiftの初期化システムについての理解が深まったことと思います。convenience initを適切に使用することで、より直感的で再利用可能なコードを書くことができるようになります。

今後は、Swiftの高度な初期化パターンや、カスタム初期化子のベストプラクティスについても記事にする予定です。

参考資料