クロージャ(Closures)
最終更新日: 2022/4/26 原文: https://docs.swift.org/swift-book/LanguageGuide/Closures.html
_クロージャ_は、コード内で受け渡して使用できる、ある機能の独立したブロックです。Swift のクロージャは、C 言語や Objective-C のブロック、他のプログラミング言語のラムダに似ています。
クロージャは、定数と変数への参照を、それらを定義したコンテキストから_キャプチャ_して保持できます。これは、これらの定数と変数をスコープに_閉じ込める_と呼ばれます。Swift は、キャプチャに関連した全てのメモリ管理を行います。
NOTE キャプチャの概念に慣れていなくても心配しないでください。これについては、Capturing Values(値のキャプチャ)で詳しく説明します。
Functions(関数)で紹介したグローバル関数やネスト関数は、実際にはクロージャの特殊なケースです。クロージャは、次の 3 つの形式のいずれかを取ります:
  • グローバル関数は、名前があり、値をキャプチャしないクロージャ
  • ネスト関数は、名前があり、囲んでいる関数から値を取得できるクロージャ
  • クロージャ式は、周囲のコンテキストから値をキャプチャできる、軽量な構文で書かれた名前のないクロージャ
Swift のクロージャは、一般的に、簡潔で、混乱のない構文で書くことができるように最適化された、すっきりした明確なスタイルを備えています。最適化には次のものが含まれます:
  • コンテキストからパラメータと戻り値の型を推論します
  • 単一式のクロージャは return キーワードなしで暗黙のリターンをします
  • 引数名を省略することができます
  • 末尾クロージャ構文を使用することができます

クロージャ式(Closure Expressions)

Nested Functions(ネスト関数)で紹介したネスト関数は、より大きな関数の一部として独立したコードブロックに名前を付けて定義するための便利な手段です。ただし、完全な宣言や名前を書かずに、関数のような構造のより短いバージョンを作成できれば便利な場合もあります。これは、1 つ以上の引数を受け取る関数またはメソッドで特に当てはまります。
_クロージャ式_は、簡潔で明瞭にインラインのクロージャを記述する方法です。クロージャ式は、明確さや意図を失うことなく、省略された形式でクロージャを記述するためのいくつかの最適化を行うことができます。下記に出てくるクロージャ式は、複数回使用される sorted(by:) メソッドを、最適化してより簡潔なものに改良した例です。

ソートメソッド(The Sorted Method)

Swift の標準ライブラリは、sorted(by:) と呼ばれるメソッドを提供しています。このメソッドは、指定した並べ替えクロージャの結果に基づいて、その型の値の配列を並べ替えます。並べ替えプロセスが完了すると、sorted(by:) メソッドは、古い配列と同じ型とサイズの新しい配列を返し、その要素は正しい並べ替え順序になります。元の配列は、sorted(by:) メソッドによって変更されません。
下記のクロージャ式の例では、sorted(by:) メソッドを使用して、String の配列をアルファベットの逆順で並べ替えています。並べ替える初期配列は次のとおりです:
1
let names = ["Chris", "Alex", "Ewa", "Barry", "Daniella"]
Copied!
sorted(by:) メソッドは、配列の内容と同じ型の 2 つの引数を取るクロージャを受け入れ、値が並べ替えられた後、最初の値が 2 番目の値の、前に表示されるか後に表示されるか、を示す Bool 値を返します。ソートクロージャは、最初の値が 2 番目の値の前に表示される場合は true を返し、それ以外の場合は false を返す必要があります。
この例では、String の配列を並べ替えているため、並べ替えクロージャは型 (String, String) -> Bool の関数でなければなりません。
ソートクロージャを提供する 1 つの方法は、正しい型の通常の関数を記述し、それを引数として sorted(by:) メソッドに渡すことです。
1
func backward(_ s1: String, _ s2: String) -> Bool {
2
return s1 > s2
3
}
4
var reversedNames = names.sorted(by: backward)
5
// `reversedNames` は ["Ewa", "Daniella", "Chris", "Barry", "Alex"]
Copied!
最初の文字列(s1)が 2 番目の文字列(s2)より大きい場合、backward(_:_:) 関数は true を返し、ソートされた配列で s1s2 の前に表示されることを示します。文字列内の文字の場合、「より大きい」は「アルファベットの後半に現れる」を意味します。これは、文字 "B" が文字 "A" より「大きい」ことを意味し、文字列 "Tom" が文字列 "Tim" よりも大きいことを意味します。これにより、アルファベットの逆順にソートが行われ、"Barry""Alex" の前に配置されます。
ただし、これは本質的に単一式の関数(a > b)を記述するには冗長な方法です。この例では、クロージャ式の構文を使用して、ソートクロージャをインラインで記述する方が望ましいでしょう。

クロージャ式構文(Closure Expression Syntax)

クロージャ式の構文には、次の一般的な形式があります:
クロージャ式構文
クロージャ式構文のパラメータは、in-out パラメータをとることもできますが、デフォルト値を設定することはできません。可変長パラメータに名前を付けると、可変長パラメータを使用できます。タプルも、パラメータの型および戻り値の型として使用できます。
下記の例は、上記の backward(_:_:) 関数のクロージャ式バージョンです。
1
reversedNames = names.sorted(by: { (s1: String, s2: String) -> Bool in
2
return s1 > s2
3
})
Copied!
このインラインクロージャのパラメータと戻り値の宣言は、backward(_:_:) 関数の宣言と同じなことに注目してください。どちらの場合も、(s1: String, s2: String) -> Bool と書きます。ただし、インラインクロージャ式の場合、パラメータと戻り値の型は中括弧({})の外側ではなく、中括弧の内側に記述されます。
クロージャの本文は、in キーワードの後から始まります。このキーワードは、クロージャのパラメータと戻り値の型の定義が完了し、クロージャの本文がまもなく開始されることを示します。
クロージャの本文は非常に短いため、1 行で書くこともできます。
1
reversedNames = names.sorted(by: { (s1: String, s2: String) -> Bool in return s1 > s2 } )
Copied!
これは、sorted(by:) メソッドへの呼び出しがいずれも同じだということを示しています。括弧のペア(())は、メソッドの引数全体をラップしますが、引数はインラインクロージャです。

コンテキストから型の推論(Inferring Type From Context)

ソートクロージャは、引数としてメソッドに渡されるため、Swift はそのパラメータの型と戻り値の型を推論できます。sorted(by:) メソッドは、文字列の配列から呼び出されるため、その引数は (String, String) -> Bool 型の関数だと推論できます。つまり、(String, String) 型と Bool 型は、クロージャ式に記述する必要はありません。全ての型を推論できるため、戻り矢印(->)とパラメータ名を囲む括弧も省略できます。
1
reversedNames = names.sorted(by: { s1, s2 in return s1 > s2 } )
Copied!
インラインクロージャ式としてクロージャを関数またはメソッドに渡す場合、パラメータの型と戻り値の型を推論することは常に可能です。その結果、クロージャが関数またはメソッドの引数として使用される場合、完全な形式でインラインクロージャを記述する必要はありません。
必要に応じて型を明示することもできます。コードのあいまいさを回避できる場合は、そうすることをお勧めします。sorted(by:) メソッドの場合、ソートが行われているという事実から、クロージャの目的は明らかで、文字列の配列を扱っていることから、クロージャは String で機能していると読み手は容易に想像できます。

単一式のクロージャの暗黙的リターン(Implicit Returns from Single-Expression Closures)

上記の例のように、単一式のクロージャは、宣言から return キーワードを省略して結果を暗黙的に返すことができます。
1
reversedNames = names.sorted(by: { s1, s2 in s1 > s2 } )
Copied!
ここで、sorted(by:) メソッドの引数の関数型は、Bool 値がクロージャによって返される必要があることを明確にしています。クロージャの本文は、Bool 値を返す単一式(s1 > s2)のため、あいまいさはなく、return キーワードは省略できます。

省略引数名(Shorthand Argument Names)

Swift は、インラインクロージャに_省略引数名_を自動的に提供しています。これを使用して、クロージャの引数の値を $0$1$2 などの名前で参照できます。
クロージャ式内でこれらの省略引数名を使用する場合は、クロージャの引数リストをその定義から省略できます。省略引数名の型は、期待されている関数型から推論され、最も大きい番号の省略引数で、クロージャが受け取る引数の数が決まります。クロージャ式は本文だけで完全に構築(推論)できているため、in キーワードは省略できます。
1
reversedNames = names.sorted(by: { $0 > $1 } )
Copied!
ここで、$0$1 は、クロージャの最初と 2 番目の文字列引数を指します。$1 は最大数の省略引数のため、クロージャは 2 つの引数を取ることがわかります。ここでの sorted(by:) 関数は、引数が両方とも文字列のクロージャを想定しているため、省略形の引数 $0$1 は両方とも String 型です。

演算子メソッド(Operator Methods)

実際には、上記のクロージャ式を記述するさらに短い方法があります。Swift の String 型は、String 型の 2 つのパラメータを持ち、Bool 型の値を返す、文字列固有の大なり演算子(>)のメソッドを定義しています。これは、sorted(by:) メソッドに必要な型と完全に一致しています。したがって、> 演算子を渡すだけで、Swift は文字列固有の実装を使用していると推論できます。
1
reversedNames = names.sorted(by: >)
Copied!
演算子メソッドの詳細については、Operator Methods(演算子メソッド)を参照ください。

末尾クロージャ(Trailing Closures)

関数の最後の引数としてクロージャ式を関数に渡す必要があり、その式が長い場合、代わりに_末尾クロージャ_として記述すると便利な場合があります。末尾クロージャは関数の引数ですが、関数呼び出しの括弧の後に記述します。末尾クロージャ構文を使用する場合、関数を呼び出すときに、最初の末尾クロージャの引数ラベルは記述しません。複数の末尾クロージャを含めることもできます。ただし、下記の最初のいくつかの例では、1 つの末尾クロージャのみを使用しています。
1
func someFunctionThatTakesAClosure(closure: () -> Void) {
2
// 関数本文
3
}
4
5
// 末尾クロージャを使用せずにこの関数を呼び出す方法は次のとおりです:
6
7
someFunctionThatTakesAClosure(closure: {
8
// クロージャ本文
9
})
10
11
// 代わりに末尾クロージャを使用してこの関数を呼び出す方法は次のとおりです:
12
13
someFunctionThatTakesAClosure() {
14
// クロージャ本文
15
}
Copied!
上記のClosure Expression Syntax(クロージャ式構文)の文字列のソートクロージャは、sorted(by:) メソッドの括弧の外側に末尾クロージャとして記述できます。
1
reversedNames = names.sorted() { $0 > $1 }
Copied!
クロージャ式が関数またはメソッドの唯一の引数で、その式を末尾クロージャにする場合、関数を呼び出すときに関数またはメソッドの名前の後に括弧のペア(())を記述する必要はありません。
1
reversedNames = names.sorted { $0 > $1 }
Copied!
末尾クロージャは、クロージャが長く、1 行にインラインで書き込むことができない場合に特に役に立ちます。例として、Swift の配列型には map(_:) メソッドがあり、単一の引数としてクロージャ式を取ります。クロージャは、配列内のアイテムごとに 1 回呼び出され、そのアイテムからマッピングされた値(おそらく他の型の値)を返します。map(_:) に渡すクロージャ内に、マッピングで何をして、どんな戻り値の型を返すのかを指定します。
クロージャを各配列要素に適用した後、map(_:) メソッドは、元の配列の対応する値と同じ順序で、全ての新しくマッピングされた値を含む新しい配列を返します。
末尾クロージャで map(_:) メソッドを使用して、Int の配列を String の配列に変換する方法は次のとおりです。配列 [16, 58, 510] から、新しい配列 ["OneSix", "FiveEight", "FiveOneZero"] を作成しています。
1
let digitNames = [
2
0: "Zero", 1: "One", 2: "Two", 3: "Three", 4: "Four",
3
5: "Five", 6: "Six", 7: "Seven", 8: "Eight", 9: "Nine"
4
]
5
let numbers = [16, 58, 510]
Copied!
上記のコードは、整数値と英語バージョンの名前をマッピングした辞書を定義しています。また、文字列に変換できる整数の配列も定義しています。
クロージャ式を配列の map(_:) メソッドに末尾クロージャとして渡すことにより、numbers 配列を使用して文字列の配列を作成できます。
1
let strings = numbers.map { (number) -> String in
2
var number = number
3
var output = ""
4
repeat {
5
output = digitNames[number % 10]! + output
6
number /= 10
7
} while number > 0
8
return output
9
}
10
// `strings` は [String] 型に推論されます
11
// 値は ["OneSix", "FiveEight", "FiveOneZero"]
Copied!
map(_:) メソッドは、配列内のアイテムごとにクロージャ式を 1 回呼び出します。マッピングされる型は配列の値から推論できるため、クロージャの入力パラメータ number の型を指定する必要はありません。
この例では、変数 number はクロージャの number パラメータの値で初期化されるため、クロージャ本文内で値を変更できます(関数とクロージャのパラメータは常に定数です)。出力配列に格納されるマッピングされた型を示すために、戻り値の型の String を指定しています。
クロージャ式は、呼び出されるたびに output という文字列を作成します。剰余演算子(number % 10)を使用して number の最後の桁を計算し、この桁を使用して digitNames 辞書で適切な文字列を検索します。クロージャを使用して、ゼロより大きい任意の整数の文字列表現を作成できます。
NOTE 辞書の subscript は、キーが存在しない場合に辞書の検索が失敗する可能性があることを示す オプショナルの値を返すため、digitNames 辞書の subscript の呼び出しの後に感嘆符(!)を付けています。上記の例では、number % 10 が常に digitNames 辞書内に存在する subscript のキーだとが保証されているため、感嘆符を使用して、subscript の オプショナルの値に格納されている String 値を強制アンラップします。
digitNames 辞書から取得した文字列が output の前に追加され、数値の文字列バージョンが逆順に追加されています。(式 number % 10 は、16 の場合は 658 の場合は 8510 の場合は 0 を返します)
次に、number 変数は 10 で除算されます。整数のため、小数部分は切り捨てられます。したがって、161 になり、585 になり、51051 になります。
このプロセスは、number0 になるまで繰り返されます。その時点で、output 文字列がクロージャから返され、map(_:) メソッドによって出力配列に追加されます。
上記の例では、末尾クロージャ構文を使用することで、クロージャを引数に受け取る関数の直後にクロージャの機能をすっきりとカプセル化できます。クロージャ全体を map(_:) メソッドの外側の括弧で囲む必要はありません。
関数が複数のクロージャを受け取る場合は、最初の末尾クロージャの引数ラベルを省略し、残りの末尾クロージャにラベルを付けます。例えば、次の関数はフォトギャラリの画像を読み込みます:
1
func loadPicture(from server: Server, completion: (Picture) -> Void, onFailure: () -> Void) {
2
if let picture = download("photo.jpg", from: server) {
3
completion(picture)
4
} else {
5
onFailure()
6
}
7
}
Copied!
この関数を呼び出して画像をロードするときは、2 つのクロージャを渡します。最初のクロージャは、ダウンロードが成功した後に画像を表示する完了ハンドラです。2 番目のクロージャは、ユーザにエラーを表示するエラーハンドラです。
1
loadPicture(from: someServer) { picture in
2
someView.currentPicture = picture
3
} onFailure: {
4
print("Couldn't download the next picture.")
5
}
Copied!
この例では、loadPicture(from:completion:onFailure:) 関数がネットワークタスクをバックグラウンドにディスパッチし、ネットワークタスクが終了すると 2 つのハンドラのいずれかを呼び出します。このように関数を作成すると、両方の状況を処理する 1 つのクロージャを使用する代わりに、ネットワーク障害の処理を担当するコードと、ダウンロードが成功した後にユーザーインターフェイスを更新するコードを、明確に分けることができます。

値のキャプチャ(Capturing Values)

クロージャは、定義されている周囲のコンテキストから定数と変数を_キャプチャ_できます。クロージャは、定数と変数を定義した元のスコープが存在しなくなった場合でも、本文内からそれらの定数と変数の値を参照および変更できます。
Swift では、値をキャプチャできるクロージャの最もシンプルな形式は、別の関数の本文内に記述されたネスト関数です。ネスト関数は、その外部関数の引数や、外部関数内で定義された定数や変数をキャプチャできます。
これは、makeIncrementer と呼ばれる関数の例です。これには、incrementer と呼ばれるネスト関数が含まれています。incrementer() 関数は、周囲のコンテキストから、runningTotalamount の 2 つの値をキャプチャします。これらの値をキャプチャした後、incrementer は、呼び出されるたびに runningTotalamount 分だけ増加するクロージャとして makeIncrementer によって返されます。
1
func makeIncrementer(forIncrement amount: Int) -> () -> Int {
2
var runningTotal = 0
3
func incrementer() -> Int {
4
runningTotal += amount
5
return runningTotal
6
}
7
return incrementer
8
}
Copied!
makeIncrementer の戻り値の型は () -> Int です。これは、シンプルな値ではなく、関数を返すことを意味します。返される関数にはパラメータがなく、呼び出されるたびに Int 値を返します。関数が他の関数を返す方法については、Function Types as Return Types(戻り値の型としての関数型)を参照ください。
makeIncrementer(forIncrement:) 関数は、runningTotal と呼ばれる整数の変数を定義して、戻り値として返される incrementer の現在の合計を格納します。この変数は値 0 で初期化されます。
makeIncrementer(forIncrement:) 関数には、forIncrement 引数ラベルと amount パラメータ名を持つ 1 つの Int 型のパラメータを持ちます。このパラメータに渡される引数値は、戻り値の incrementer が呼び出されるたびに、runningTotal を増加する量を指定します。makeIncrementer 関数は、実際に値を増加させる incrementer と呼ばれるネスト関数を定義します。この関数は単に runningTotalamount を加算して、結果を返します。
独立して検討すると、ネストされた incrementer() 関数は少し変に見えるかもしれません。
1
func incrementer() -> Int {
2
runningTotal += amount
3
return runningTotal
4
}
Copied!
incrementer() 関数にはパラメータがありませんが、関数本文内から runningTotalamount を参照します。これは、runningTotalamount への参照を周囲の関数からキャプチャし、それらを独自に関数本文内で使用します。参照によるキャプチャにより、makeIncrementer の呼び出しが終了したときに runningTotalamount が解放されないようにし、次に incrementer 関数が呼び出されたときにも runningTotal を使用可能にします。
NOTE 最適化として、Swift は、値がクロージャによって変更されていない場合やクロージャの作成後に値が変更されていない場合、代わりに値のコピーをキャプチャして保存する場合があります。 Swiftは、変数が不要になったときの変数の破棄に関わるメモリ管理を全て行ないます。
makeIncrementer の動作例を次に示します。
1
let incrementByTen = makeIncrementer(forIncrement: 10)
Copied!
この例では、incrementByTen という定数を設定して、呼び出されるたびに runningTotal 変数に 10 を追加する incrementer 関数を参照します。関数を複数回呼び出すと、次のようになります:
1
incrementByTen()
2
// 10 を返します
3
incrementByTen()
4
// 20 を返します
5
incrementByTen()
6
// 30 を返します
Copied!
2 つ目の incrementer 関数を新しく作成すると、別の runningTotal 変数への参照を格納します。
1
let incrementBySeven = makeIncrementer(forIncrement: 7)
2
incrementBySeven()
3
// 7 を返します
Copied!
元の incrementer(incrementByTen)を再度呼び出すと、それ自体の runningTotal 変数が引き続きインクリメントされ、incrementBySeven によってキャプチャされた変数には影響しません。
1
incrementByTen()
2
// 40 を返します
Copied!
NOTE クラスインスタンスのプロパティにクロージャを代入して、クロージャがインスタンスまたはそのメンバを参照して、そのインスタンスをキャプチャする場合、クロージャとインスタンスの間に循環参照(strong reference cycle)が作成されます。Swift は、キャプチャリストを使用して、これらの循環参照を防ぎます。詳細については、 Strong Reference Cycles for Closures(クロージャの強参照循環)を参照ください。

クロージャは参照型(Closures Are Reference Types)

上記の例では、incrementBySevenincrementByTen は定数ですが、これらの定数が参照するクロージャは、キャプチャした runningTotal 変数をインクリメントすることができます。関数とクロージャが参照型だからです。
関数またはクロージャを定数または変数に代入するときはいつでも、実際にはその定数または変数を、関数またはクロージャへの参照として設定しています。上記の例では、クロージャ自体の内容ではなく、incrementByTen が定数を参照するのは、クロージャの選択です。
つまり、2 つの異なる定数または変数にクロージャを代入する場合、それらは同じクロージャを参照することを意味します。
1
let alsoIncrementByTen = incrementByTen
2
alsoIncrementByTen()
3
// 50 を返します
4
5
incrementByTen()
6
// 60 を返します
Copied!
上記の例は、alsoIncrementByTen を呼び出すことは incrementByTen を呼び出すことと同じだということを示しています。どちらも同じクロージャを参照しているため、両方とも同じ runningTotal をインクリメントして結果を返します。

エスケープクロージャ(Escaping Closures)

関数の引数として渡されたクロージャが、関数本文が終了した後に呼び出される場合、関数を_エスケープ_すると呼ばれています。パラメータの 1 つとしてクロージャを受け取る関数を宣言する場合、パラメータの型の前に @escaping を記述して、クロージャがエスケープすることを示すことができます。
クロージャをエスケープする 1 つの方法は、関数の外部で定義された変数に格納することです。例として、非同期操作を開始する多くの関数は、完了ハンドラとしてクロージャ引数を取ります。関数は操作の開始後に戻り値を返しますが、操作が完了するまでクロージャは呼び出されません。そのため、クロージャはエスケープする必要があり、後で呼び出す必要があります。例えば:
1
var completionHandlers = [() -> Void]()
2
func someFunctionWithEscapingClosure(completionHandler: @escaping () -> Void) {
3
completionHandlers.append(completionHandler)
4
}
Copied!
someFunctionWithEscapingClosure(_:) 関数は、引数としてクロージャを取り、関数の外部で宣言されている配列に追加します。この関数のパラメータを @escaping でマークしなかった場合、コンパイルエラーが発生します。
self がクラスのインスタンスを参照する場合、self を参照するエスケープクロージャには特別な考慮が必要です。エスケープクロージャで self をキャプチャすると、誤って循環参照を作りやすくなります。循環参照については、Automatic Reference Counting(自動参照カウント)を参照ください。
通常、クロージャは、本文の変数を使用する際は暗黙的に変数をキャプチャしますが、self がクラスのインスタンスを参照する場合は、明示的に宣言する必要があります。使用するときに self を記述するか、クロージャの_キャプチャリスト_に self を含めます。self を明示的に書くことで、意図を表現でき、循環参照がないことを確認することができます。例えば、下記のコードでは、someFunctionWithEscapingClosure(_:) に渡されたクロージャは self を明示的に参照しています。対照的に、someFunctionWithNonescapingClosure(_:) に渡されるクロージャは、エスケープなしのクロージャです。つまり、暗黙的に self を参照できます。
1
func someFunctionWithNonescapingClosure(closure: () -> Void) {
2
closure()
3
}
4
5
class SomeClass {
6
var x = 10
7
func doSomething() {
8
someFunctionWithEscapingClosure { self.x = 100 }
9
someFunctionWithNonescapingClosure { x = 200 }
10
}
11
}
12
13
let instance = SomeClass()
14
instance.doSomething()
15
print(instance.x)
16
// 200
17
18
completionHandlers.first?()
19
print(instance.x)
20
// 100
Copied!
下記は、クロージャのキャプチャリストに含めることで self をキャプチャし、暗黙的に self を参照する doSomething() のバージョンです。
1
class SomeOtherClass {
2
var x = 10
3
func doSomething() {
4
someFunctionWithEscapingClosure { [self] in x = 100 }
5
someFunctionWithNonescapingClosure { x = 200 }
6
}
7
}
Copied!
selfstruct または enum のインスタンスの場合は、いつでも暗黙的に self を参照できます。ただし、selfstruct または enum のインスタンスの場合、エスケープクロージャは self が変更できてしまうような場合、参照はキャプチャできません。Structures and Enumerations Are Value Types(構造体と列挙型は値型)でも説明されているように、struct または enum は変更可能な値の共有はできません。
1
struct SomeStruct {
2
var x = 10
3
mutating func doSomething() {
4
someFunctionWithNonescapingClosure { x = 200 } // Ok
5
someFunctionWithEscapingClosure { x = 100 } // Error
6
}
7
}
Copied!
上記の例の someFunctionWithEscapingClosure 関数の呼び出しは、mutating メソッド内で self が変更可能なので、エラーとなります。これは、エスケープクロージャが struct の変更可能な self への参照をキャプチャできないというルールに違反します。

自動クロージャ(Autoclosures)

_自動クロージャ_は、関数の引数として渡された式をラップして自動的に作成されるクロージャです。引数はとらず、このクロージャが呼び出されると、ラップされている式の値を返します。この構文は便利で、明示的なクロージャの代わりに通常の式を記述することで、関数のパラメータの中括弧({})を省略できます。
自動クロージャを引数に取る関数を_呼び出す_ことは一般的ですが、そのような関数を_実装する_ことは一般的ではありません。例えば、assert(condition:message:file:line:) 関数は、conditionmessage パラメータを自動クロージャで受け取ります。condition パラメータはデバッグビルドでのみ評価され、message パラメータは conditionfalse の場合にのみ評価されます。
自動クロージャを使用すると、クロージャを呼び出すまで内部のコードが実行されないため、評価を遅らせることができます。遅延評価は、コードがいつ評価されるかを制御できるため、副作用があるコードや計算コストが高いコードを書くときに役に立ちます。下記のコードは、クロージャが評価をどのように遅らせるかを示しています。
1
var customersInLine = ["Chris", "Alex", "Ewa", "Barry", "Daniella"]
2
print(customersInLine.count)
3
// 5
4
5
let customerProvider = { customersInLine.remove(at: 0) }
6
print(customersInLine.count)
7
// 5
8
9
print("Now serving \(customerProvider())!")
10
// Now serving Chris!
11
print(customersInLine.count)
12
// 4
Copied!
customersInLine 配列の最初の要素はクロージャ内のコードによって削除されますが、配列要素はクロージャが実際に呼び出されるまで削除されません。クロージャが呼び出されない場合、クロージャ内の式が評価されることはありません。つまり、配列要素が削除されることはありません。customerProvider の型は String ではなく、() -> String で、文字列を返すパラメータのない関数だということに注意してください。
関数の引数としてクロージャを渡すと、遅延評価と同じ動作が得られます。
1
// customersInLine は ["Alex", "Ewa", "Barry", "Daniella"]
2
func serve(customer customerProvider: () -> String) {
3
print("Now serving \(customerProvider())!")
4
}
5
serve(customer: { customersInLine.remove(at: 0) } )
6
// Now serving Alex!
Copied!
上記のリストの serve(customer:) 関数は、顧客の名前を返す明示的なクロージャを受け取ります。下記のバージョンの serve(customer:) は同じ操作を実行しますが、明示的なクロージャを取得する代わりに、パラメータの型を @autoclosure 属性でマークすることによって自動クロージャを取得します。これで、クロージャの代わりに String 引数を受け取ったかのように関数を呼び出すことができます。customerProvider パラメータの型は @autoclosure 属性でマークされているため、引数は自動的にクロージャに変換されます。
1
// customersInLine は ["Ewa", "Barry", "Daniella"]
2
func serve(customer customerProvider: @autoclosure () -> String) {
3
print("Now serving \(customerProvider())!")
4
}
5
serve(customer: customersInLine.remove(at: 0))
6
// Now serving Ewa!
Copied!
NOTE 自動クロージャを使いすぎると、コードが理解しにくくなる可能性があります。コンテキストと関数名で、遅延評価されていることを明確にする必要があります。
エスケープする自動クロージャが必要な場合は、@autoclosure 属性と @escaping 属性の両方を使用します。@escaping 属性については、上記のEscaping Closures(エスケープクロージャ)で説明しています。
1
// customersInLine は ["Barry", "Daniella"]
2
var customerProviders: [() -> String] = []
3
func collectCustomerProviders(_ customerProvider: @autoclosure @escaping () -> String) {
4
customerProviders.append(customerProvider)
5
}
6
collectCustomerProviders(customersInLine.remove(at: 0))
7
collectCustomerProviders(customersInLine.remove(at: 0))
8
9
print("Collected \(customerProviders.count) closures.")
10
// Collected 2 closures.
11
for customerProvider in customerProviders {
12
print("Now serving \(customerProvider())!")
13
}
14
// Now serving Barry!
15
// Now serving Daniella!
Copied!
上記のコードでは、customerProvider 引数として渡されたクロージャを呼び出す代わりに、collectCustomerProviders(_:) 関数がクロージャを customerProviders 配列に追加します。配列は関数のスコープ外で宣言されています。つまり、配列のクロージャは関数が戻った後に実行される場合があります。その結果、customerProvider 引数の値は、関数のスコープをエスケープできるようにする必要があります。