XCode 9.2 日本語化計画

プロパティ

プロパティ は、特定のクラス、構造体、または列挙型と値を関連付けます。計算されたプロパティが (むしろ格納よりも) 値を計算するのに対して、格納されたプロパティは、インスタンスの一部として定数と変数の値を格納します。計算されたプロパティは、クラス、構造体、列挙型によって提供されます。格納されたプロパティはクラスおよび構造によってのみ提供されます。

格納され、計算されたプロパティは、通常、特定の型のインスタンスと関連付けられています。しかし、プロパティはまた、型自体に関連付けられることもできます。このようなプロパティは、型のプロパティとして知られています。

加えて、カスタム・アクションと共に応答できるプロパティの値の変化を監視するプロパティ・オブザーバーを定義できます。プロパティ・オブザーバーは、あなた自身が定義する格納されたプロパティに追加することができ、サブクラスがそのスーパークラスから継承するプロパティにも、追加できます。

格納されたプロパティ

その最も単純な形態では、格納されたプロパティは、特定のクラスまたは構造体のインスタンスの一部として格納されている定数または変数です。格納されたプロパティは、(var キーワードに引き続き定義された) 変数に格納されたプロパティ または (let キーワードに引き続き定義された) 定数に格納されたプロパティ のいずれかになります。

デフォルトのプロパティ値で説明したように、その定義の一部として格納されたプロパティのデフォルト値を提供できます。また、初期化中に格納されたプロパティの初期値を設定し、変更できます。初期化中に定数プロパティんへの代入で説明したように、これは定数に格納されたプロパティについても正しいです。

以下の例では、FixedLengthRange という構造体を定義し、一旦作成されたら変更できない範囲の長さの整数の範囲を記述しています。

struct FixedLengthRange {

var firstValue: Int

let length: Int

}

var rangeOfThreeItems = FixedLengthRange(firstValue: 0, length: 3)

// the range represents integer values 0, 1, and 2

rangeOfThreeItems.firstValue = 6

// the range now represents integer values 6, 7, and 8

FixedLengthRange のインスタンスには、firstValue という変数に格納されたプロパティと、length という定数に格納されたプロパティがあります。上記の例では、length は新しい範囲が作成された時に初期化され、その後、それが定数プロパティのため変更できません。

定数構造体インスタンスの格納されたプロパティ

構造体のインスタンスを作成し、定数にそのインスタンスを代入した場合、それらが変数プロパティとして宣言された場合でも、インスタンス・プロパティを変更することはできません。

let rangeOfFourItems = FixedLengthRange(firstValue: 0, length: 4)

// this range represents integer values 0, 1, 2, and 3

rangeOfFourItems.firstValue = 6

// this will report an error, even though firstValue is a variable property

rangeOfFourItems は (let キーワードを使った) 定数として宣言されているので、firstValue が変数プロパティであっても、その firstValue プロパティを変更することはできません。

この動作は、値型である構造体に起因しています。値型のインスタンスが定数としてマークされると、すべてのプロパティがそのようになります。

同じことは 参照型 であるクラスの場合、正しくありません。参照型のインスタンスを定数に代入した場合、まだそのインスタンスの変数プロパティを変更することができます。

遅延した格納されたプロパティ

遅延した格納されたプロパティ は、初めて使用されるまではその初期値が計算されないプロパティです。その宣言の前に lazy の修飾子を書くことによって、遅延した格納されたプロパティを示して下さい。

注意： その初期値が、インスタンスの初期化が完了するまで検索されないので、常に、(var キーワードで) 変数として遅延したプロパティを宣言する必要があります。定数プロパティは、初期化が完了する前に、必ず値を持たなければならず、そのため遅延した(lazy)として宣言することはできません。

プロパティの初期値が、インスタンスの初期化が完了するまで知られていない外部の要因に依存している場合、遅延したプロパティが便利です。プロパティの初期値が複雑で計算コストが高く、必要になるまで行われるべきではないセットアップを必要とする場合、遅延したプロパティは便利です。

以下の例は、複雑なクラスの不必要な初期化を避けるために、遅延した格納されたプロパティを使用しています。この例では、２つとも完全には示されていない DataImporter と DataManager と言う２つのクラスを定義しています。

class DataImporter {

DataImporter is a class to import data from an external file.

The class is assumed to take a non-trivial amount of time to initialize.

var fileName = "data.txt"

// the DataImporter class would provide data importing functionality here

}

class DataManager {

lazy var importer = DataImporter()

var data = [String]()

// the DataManager class would provide data management functionality here

}

let manager = DataManager()

manager.data.append("Some data")

manager.data.append("Some more data")

// the DataImporter instance for the importer property has not yet been created

DataManager クラスには、String 値の新しい、空の配列で初期化された data と言う格納されたプロパティがあります。その機能の残りの部分は示されていませんが、この DataManagaer クラスの目的は String データのこの配列へのアクセスを管理し、提供することにあります。

DataManager クラスの機能の一部は、ファイルからデータをインポートする機能です。この機能は、 DataImporter クラスによって提供され、初期化するためには少なくない時間が掛かると仮定されます。これは、 DataImporter インスタンスがファイルを開いて、DataImporter インスタンスが初期化されたときにその内容をメモリに読み込む必要があるからです。

DataManager インスタンスは、ファイルからデータをインポートすることが全くなく、そのデータを管理することが可能であるため、DataManager 自体が作成されても、新しいDataImporter インスタンスを作成する必要はありません。その代わりに、それを最初に使用する際 DataImporter インスタンスを作成するのが、より理にかなっています。

lazy 修飾子でマークされているため、importer プロパティが最初にアクセスされたときに、fileName プロパティが照会されたときのように、importer プロパティの DataImporter インスタンスはその時にのみ作成されます。

print(manager.importer.fileName)

// the DataImporter instance for the importer property has now been created

// prints "data.txt"

注意： lazy 修飾子でマークされたプロパティに複数のスレッドが同時にアクセスし、そのプロパティがまだ初期化されていない場合、そのプロパティが一度しか初期化されないという保証はありません。

格納されたプロパティとインスタンス変数

Objective-C の経験がある場合は、それがクラスインスタンスの一部として値と参照を格納するために２つの方法を提供することを知っているかもしれません。プロパティに加えて、プロパティに格納された値の補助記憶としてインスタンス変数を使用できます。

Swift は、これらの概念を一つのプロパティ宣言に統合します。Swift のプロパティは、対応するインスタンス変数を持っておらず、プロパティの補助記憶には直接アクセスできません。このアプローチは、どう値が異なる文脈でアクセスされたかについての混乱を回避し、一つの、決定的な文にプロパティの宣言を簡素化します。プロパティに関するすべての情報は、その名前、型、およびメモリ管理特性を含め、型の定義の一部として一つの場所で定義されています。

計算されたプロパティ

格納されたプロパティ、クラス、構造体、および列挙型に加えて、実際には値を格納しない、計算されたプロパティ を定義できます。代わりに、それらは間接的に他のプロパティと値を取得し設定するためのゲッタと optional のセッタを提供します。

struct Point {

var x = 0.0, y = 0.0

}

struct Size {

var width = 0.0, height = 0.0

}

struct Rect {

var origin = Point()

var size = Size()

var center: Point {

get {

let centerX = origin.x + (size.width / 2)

let centerY = origin.y + (size.height / 2)

return Point(x: centerX, y: centerY)

}

set(newCenter) {

origin.x = newCenter.x - (size.width / 2)

origin.y = newCenter.y - (size.height / 2)

}

var square = Rect(origin: Point(x: 0.0, y: 0.0),

size: Size(width: 10.0, height: 10.0))

let initialSquareCenter = square.center

square.center = Point(x: 15.0, y: 15.0)

print("square.origin is now at (\(square.origin.x), \(square.origin.y))")

// prints "square.origin is now at (10.0, 10.0)"

この例では、幾何学的形状を操作するため３つの構造体を定義しています。

Point は、座標 (x、y) をカプセル化します。
Size は、width と height をカプセル化します。
Rect は、原点とサイズによって長方形を定義します。

Rect 構造体はまた、center と言う計算されたプロパティも提供しています。Rect の現在の中心位置は、常にその origin と size から決定できるので、明示的な Point 値として中心点を格納する必要はありません。その代わり、Rect は、それが本当の格納されたプロパティであるかのように長方形の center で作業できるよう、center と言う計算された変数のカスタムゲッタとセッタを定義します。

前述の例では、square と言う新しい Rect 変数を作成しています。square 変数は (0,0) の原点で初期化され、幅及び高さは 10 です。この正方形は、下の図の青い四角形で表されています。

square 変数の center プロパティは、現在のプロパティ値を取得するために、ドット構文 (square.center) を介してアクセスされ、center のゲッタの呼び出しを引き起こします。既存の値を返すよりもむしろ、ゲッタは、実際に計算し、正方形の中心を表すために新しい Point を返します。上記から分かるように、ゲッタは正しく (5,5) の中心点を返します。

center プロパティは、下の図ではオレンジ色の正方形で示される新しい位置に、正方形を上、右にに移動する、(15、15) の新しい値に設定されています。center プロパティを設定すると、格納された origin プロパティの x と y の値を変更する center 用セッタを呼び出し、その新しい位置に正方形を移動します。

セッタ宣言の省略形

計算されたプロパティのセッタが設定すべき新しい値の名前を定義していなければ、デフォルトの名前である newValue が使用されます。ここで、この省略形の表記法を利用している、Rect 構造体の別バージョンを示します：

struct AlternativeRect {

var origin = Point()

var size = Size()

var center: Point {

get {

let centerX = origin.x + (size.width / 2)

let centerY = origin.y + (size.height / 2)

return Point(x: centerX, y: centerY)

}

set {

origin.x = newValue.x - (size.width / 2)

origin.y = newValue.y - (size.height / 2)

}

読み取り専用の計算されたプロパティ

ゲッタと計算されたプロパティがあり、セッタがないのは 読み取り専用の計算されたプロパティ として知られています。読み取り専用の計算されたプロパティは常に値を返し、ドット構文を使用してアクセスできますが、別の値に設定することはできません。

注意： それらの値が固定されていないので、計算されたプロパティを、読み取り専用の計算されたプロパティも含め、var キーワードで変数プロパティとして宣言しなければなりません。let キーワードは、インスタンスの初期化の一部として、一度設定されるとその値を変更できないことを示すために、定数のプロパティのためにのみ使用されます。

get キーワードと括弧を除くと、読み取り専用の計算されたプロパティの宣言を単純化できます。

struct Cuboid {

var width = 0.0, height = 0.0, depth = 0.0

var volume: Double {

return width * height * depth

}

let fourByFiveByTwo = Cuboid(width: 4.0, height: 5.0, depth: 2.0)

print("the volume of fourByFiveByTwo is \(fourByFiveByTwo.volume)")

// prints "the volume of fourByFiveByTwo is 40.0"

この例では、width、height、そして depth プロパティがある三次元の長方形の箱を表す Cuboid と言う新しい構造体を定義しています。この構造体にはまた、volume と言う読み取り専用の計算されたプロパティもあり、立方体の現在の体積を計算して返します。これは、width、height そして depth のどの値が、特定の volume の値に使用されるかに関してあいまいなので、 volume が設定可能である事を意味しません。それにも関わらず、Cuboid が現在の計算された体積を外部ユーザーが発見するのを有効にするために読み取り専用の計算されたプロパティを提供するのは、便利です。

プロパティ監視者

プロパティの監視者 は、プロパティの値の変化を監視し、対応します。プロパティの監視者は、新しい値がプロパティの現在の値と同じであっても、プロパティの値が設定されるたびに呼びだされます。

遅延した格納されたプロパティを除いて、全ての定義した格納されたプロパティにプロパティの監視者を追加できます。また、サブクラス内のプロパティをオーバーライドすることで、全ての継承された (格納または計算された) プロパティにプロパティの監視者を追加する事もできます。監視し、計算されたプロパティのセッターの値での変化に対応することができるので、オーバーライドしない計算されたプロパティのプロパティ監視者を定義する必要はありません。プロパティのオーバーライドは、オーバーライド(上書き) で説明しています。

プロパティ上のこれらの監視者のいずれかまたは両方を定義するオプションがあります：

willSet は値が格納される直前に呼び出されます。
didSet は新しい値が格納された直後に呼び出されます。

willSet 監視者を実装する場合、それには定数パラメータとして新しいプロパティ値が渡されます。willSet の実装の一部として、このパラメータの名前を指定できます。実装内でパラメータ名と括弧を書かない場合、パラメータは newValue のデフォルトのパラメータ名で利用できるようになります。

同様に、didSet 監視者を実装した場合、それには古いプロパティ値を含む定数パラメータが渡されます。パラメータに名前を付けるか、またはは oldValue のデフォルトのパラメータ名を使用できます。独自の didSet 監視者内のプロパティに値を割り当てる場合は、割り当てた新しい値は、ちょうど設定されたものを置き換えます。

注意： プロパティがサブクラス内のイニシャライザで設定されている時、スーパークラスのイニシャライザが呼び出された後、スーパークラスのプロパティの willSet と didSet 監視者プロパティが、呼び出されます。スーパークラスのイニシャライザが呼び出される前に、クラスが独自のプロパティを設定している間、彼らは呼び出されません。

イニシャライザのデリゲートの詳細については、値型のイニシャライザデリゲートと、クラス型のイニシャライザデリゲートを参照してください。

ここでアクションの willSet と didSet の例を挙げます。以下の例では、歩きながら人が歩くステップの総数を追跡する StepCounter と言う新しいクラスを定義しています。このクラスは、彼らの日常生活の間に、人の運動を追跡するために、歩数計またはその他の歩数カウンターからの入力データを使用するかもしれません。

class StepCounter {

var totalSteps: Int = 0 {

willSet(newTotalSteps) {

print("About to set totalSteps to \(newTotalSteps)")

}

didSet {

if totalSteps > oldValue {

print("Added \(totalSteps - oldValue) steps")

}

let stepCounter = StepCounter()

stepCounter.totalSteps = 200

// About to set totalSteps to 200

// Added 200 steps

stepCounter.totalSteps = 360

// About to set totalSteps to 360

// Added 160 steps

stepCounter.totalSteps = 896

// About to set totalSteps to 896

// Added 536 steps

StepCounter クラスは、Int 型の totalSteps プロパティを宣言します。これは willSet と didSet 監視者のある格納されたプロパティです。

プロパティが新しい値を代入された時はいつでも totalSteps の willSet と didSet 監視者が呼び出されます。これは、新しい値が現在の値と同じ場合でも同様です。

この例の willSet 監視者は、今後の新しい値のために newTotalSteps と言うカスタムパラメータ名を使用します。この例では、単に設定しようとする値を印刷します。

totalSteps の値が更新された後 didSet 監視者は呼び出されます。それは、古い値に対して totalSteps の新しい値を比較します。総ステップ数が増加していた場合、どれだけ多く新たなステップが踏まれたかを示すためにメッセージが印刷されます。didSet 監視者は、古い値にカスタムパラメータ名を提供しておらず、代わりに oldValue のデフォルト名が使用されます。

注意： in-out パラメータとして関数に監視者を持つプロパティを渡すと、willSet と didSet 監視者が常に呼び出されます。これは、 in-out パラメータの copy-in copy-out メモリモデルのためです。値は常に関数の最後にプロパティに書き戻されます。in-out パラメータの動作についての詳細は、In-Out パラメータを参照してください。

グローバルとローカル変数

計算する、監視するプロパティの、上記の機能はまた グローバル変数 と ローカル変数 にも利用可能です。グローバル変数は全ての関数、メソッド、クロージャ、または型のコンテキストの外で定義されている変数です。ローカル変数は、関数、メソッド、またはクロージャのコンテキスト内で定義されている変数です。

以前の章で遭遇したグローバルとローカル変数は、すべて 格納された変数 です。格納された変数は、格納されたプロパティと同様に、特定の型の値の記憶域を提供し、その値を設定し、取得することを可能にします。

ただし、計算された変数 を定義することもできますし、グローバルまたはローカルの範囲で、格納された変数の監視者も定義できます。計算された変数は、値を格納するよりも計算し、計算されたプロパティと同じように書かれます。

注意： グローバル定数と変数は常に遅延した格納されたプロパティと同様に、遅れて計算されます。遅延した格納されたプロパティとは異なり、グローバル定数と変数は lazy 修飾子でマークする必要はありません。

ローカル定数や変数は遅れて計算されることは決してありません。

型プロパティ

インスタンス・プロパティは、特定の型のインスタンスに属しているプロパティです。その型の新しいインスタンスを作成するたびに、それは他のインスタンスとは別のプロパティ値の独自のセットを持っています。

また、その型のいずれのインスタンスでもない、型自体に属しているプロパティを定義することもできます。その型のインスタンスをどれだけ多く作成したかに関係なく、これらのプロパティのいずれか一つのコピーしかありません。これらの種類のプロパティは、型プロパティ と呼ばれます。

型プロパティは、特定の型の すべての インスタンスへの普遍的な値を定義し、すべてのインスタンスが (C の静的定数のように) 使える定数プロパティのように、またはその型の全てのインスタンスに対するグローバルな値を格納する (C の静的変数のように) 変数プロパティとして、有用です。

格納された型プロパティは、変数や定数にすることができます。計算された型プロパティは常に計算されたインスタンスのプロパティと同じように、変数プロパティとして宣言されます。

注意： 格納されたインスタンスプロパティとは異なり、格納された型プロパティには常にデフォルト値を与えなければなりません。これは、型自体は、初期化される時には格納された型プロパティに値を代入することができるイニシャライザを持っていないためです。
格納された型プロパティはその最初のアクセスで遅れて初期化されます。これらは、同時に複数のスレッドによってアクセスされる場合であっても、一度だけ初期化されることが保証されており、それらは lazy 修飾子でマークする必要はありません。

型プロパティの構文

C と Objective-C では、グローバル 静的変数として型に関連付けられた静的定数と変数を定義できます。Swift では、しかし、型プロパティは、型の外の中括弧の中に、型の定義の一部として書かれ、各々の型プロパティはサポートしている型に明示的にスコープされます。

static キーワードで型プロパティを定義して下さい。クラス型の計算された型プロパティでは、スーパークラスの実装をサブクラスがオーバーライド(上書き)するのを許す代わりに class キーワードを使用できます。以下の例で、格納されたプロパティと、計算された型プロパティの構文を示します。

struct SomeStructure {

static var storedTypeProperty = "Some value."

static var computedTypeProperty: Int {

return 1

}

enum SomeEnumeration {

static var storedTypeProperty = "Some value."

static var computedTypeProperty: Int {

return 6

}

class SomeClass {

static var storedTypeProperty = "Some value."

static var computedTypeProperty: Int {

return 27

}

class var computedTypeProperty: Int {

return 107

}

注意： 上記の計算された型プロパティの例では、読み取り専用の計算された型プロパティですが、計算されたインスタンス・プロパティと同じ構文で、読み・書きのできる、計算された型プロパティも定義できます。

型プロパティの照会と設定

型プロパティは、ちょうどインスタンス・プロパティのように、ドット構文で照会、設定されます。しかし、型プロパティはその型のインスタンスではなく、型により照会、設定されます。例えば：

print(SomeClass.computedTypeProperty)

// prints "Some value"

SomeStructure.storedTypeProperty = "Another value."

print(SomeStructure.storedTypeProperty)

// prints "Another value."

print(SomeEnumeration.computedTypeProperty)

// Prints "6"

print(SomeClass.computedTypeProperty)

// prints "27"

以下の例は、オーディオチャンネル数のオーディオレベルメーターのあるモデルの構造体の一部として格納された２つの型プロパティを使用しています。各チャンネルには、0 から 10 までの整数のオーディオレベルがあります。

下の図は、これらの２つのオーディオチャンネルが、ステレオオーディオ・レベルメーターをモデル化して組み合わせている所を示しています。チャンネルのオーディオレベルが 0 の場合、そのチャンネルの光はいずれも点灯していません。オーディオレベルが 10 の場合、そのチャンネルの光は全て点灯しています。この図では、左チャンネルは現在 9 のレベルであり、右チャンネルは現在 7 のレベルです。

上述のオーディオチャンネルを AudioChannel 構造体のインスタンスによって表わします。

struct AudioChannel {

static let thresholdLevel = 10

static var maxInputLevelForAllChannels = 0

var currentLevel: Int = 0 {

didSet {

if currentLevel > AudioChannel.thresholdLevel {

// cap the new audio level to the threshold level

currentLevel = AudioChannel.thresholdLevel

}

if currentLevel > AudioChannel.maxInputLevelForAllChannels {

// store this as the new overall maximum input level

AudioChannel.maxInputLevelForAllChannels = currentLevel

}

AudioChannel 構造体は、その機能をサポートするために、２つの格納された型プロパティを定義しています。まず、thresholdLevel は、オーディオレベルが取りうる最大の閾値を定義しています。これは、すべての AudioChannel インスタンスに対する 10 の定数値です。オーディオ信号が 10 よりも高い値になる場合には、この閾値にフタをされます (後述)。

第二の型プロパティは、maxInputLevelForAllChannels という変数に格納されたプロパティです。これは、全ての AudioChannel インスタンスによって受信された最大入力値を追跡します。これは、初期値 0 で始まります。

AudioChannel 構造体は、0 から 10 のスケールでチャンネルの現在のオーディオレベルを表す currentLevel という、格納されたインスタンスプロパティも定義しています。

currentLevel プロパティには、それが設定されるたびに currentLevel の値を確認する didSet プロパティの監視者があります。この監視者は２つの確認を実行します。

currentLevel の新しい値が許可された thresholdLevel よりも大きい場合、プロパティの監視者は、currentLevel に thresholdLevel のフタをします。
(すべてにフタをした後) currentLevel の新しい値が 全ての AudioChannel インスタンスによって以前に受信された全ての値よりも高い場合、プロパティの監視者は maxInputLevelForAllChannels の型プロパティに新しい currentLevel 値を格納します。