[譯]最近正在參與的Swift2.0翻譯工作（Access Control章節(jié)）

2018-06-19 15:09 更新

訪問控制

本頁內(nèi)容包括：

訪問控制可以限定其他源文件或模塊中代碼對你代碼的訪問級別。這個特性可以讓我們隱藏功能實現(xiàn)的一些細節(jié)，并且可以明確的申明我們提供給其他人的接口中哪些部分是他們可以訪問和使用的。

你可以明確地給單個類型（類、結(jié)構(gòu)體、枚舉）設(shè)置訪問級別，也可以給這些類型的屬性、函數(shù)、初始化方法、基本類型、下標(biāo)索引等設(shè)置訪問級別。協(xié)議也可以被限定在一定的范圍內(nèi)使用，包括協(xié)議里的全局常量、變量和函數(shù)。

在提供了不同訪問級別的同時，Swift還為某些典型場景提供了默認(rèn)的訪問級別，這樣就不需要我們在每段代碼中都申明顯式訪問級別。其實，如果只是開發(fā)一個單目標(biāo)應(yīng)用程序，我們完全可以不用申明代碼的顯式訪問級別。

注意：簡單起見，代碼中可以設(shè)置訪問級別的特性（屬性、基本類型、函數(shù)等），在下面的章節(jié)中我們會以“實體”代替。

<a name="modules_and_source_files"></a>

模塊和源文件

Swift 中的訪問控制模型基于模塊和源文件這兩個概念。

模塊指的是以獨立單元構(gòu)建和發(fā)布的Framework或Application。在Swift 中的一個模塊可以使用import關(guān)鍵字引入另外一個模塊。

在 Swift 中，Xcode的每個構(gòu)建目標(biāo)（比如Framework或app bundle）都被當(dāng)作模塊處理。如果你是為了實現(xiàn)某個通用的功能，或者是為了封裝一些常用方法而將代碼打包成獨立的Framework，這個Framework在 Swift 中就被稱為模塊。當(dāng)它被引入到某個 app 工程或者另外一個Framework時，它里面的一切（屬性、函數(shù)等）仍然屬于這個獨立的模塊。

源文件指的是 Swift 中的Swift File，就是編寫 Swift 源代碼的文件，它通常屬于一個模塊。盡管一般我們將不同的類 分別定義在不同的源文件中，但是同一個源文件可以包含多個類和函數(shù) 的定義。

<a name="access_levels"></a>

訪問級別

Swift 為代碼中的實體提供了三種不同的訪問級別。這些訪問級別不僅與源文件中定義的實體相關(guān)，同時也與源文件所屬的模塊相關(guān)。

  • public：可以訪問自己模塊中源文件里的任何實體，別人也可以通過引入該模塊來訪問源文件里的所有實體。通常情況下，Framework 中的某個接口是可以被任何人使用時，你可以將其設(shè)置為public級別。
  • internal：可以訪問自己模塊中源文件里的任何實體，但是別人不能訪問該模塊中源文件里的實體。通常情況下，某個接口或Framework作為內(nèi)部結(jié)構(gòu)使用時，你可以將其設(shè)置為internal級別。
  • private：只能在當(dāng)前源文件中使用的實體，稱為私有實體。使用private級別，可以用作隱藏某些功能的實現(xiàn)細節(jié)。

public為最高級訪問級別，private為最低級訪問級別。

注意：Swift中的private訪問和其他語言中的private訪問不太一樣，它的范圍限于整個源文件，而不是聲明。這就意味著，一個類 可以訪問定義該類 的源文件中定義的所有private實體，但是如果一個類 的擴展是定義在獨立的源文件中，那么就不能訪問這個類 的private成員。

<a name="guiding_principle_of_access_levels"></a>

訪問級別的使用原則

Swift 中的訪問級別遵循一個使用原則：訪問級別統(tǒng)一性。 比如說：

  • 一個public訪問級別的變量，不能將它的類型定義為internal和private。因為變量可以被任何人訪問，但是定義它的類型不可以，所以這樣就會出現(xiàn)錯誤。
  • 函數(shù)的訪問級別不能高于它的參數(shù)、返回類型的訪問級別。因為如果函數(shù)定義為public而參數(shù)或者返回類型定義為internal或private，就會出現(xiàn)函數(shù)可以被任何人訪問，但是它的參數(shù)和返回類型確不可以，同樣會出現(xiàn)錯誤。

<a name="default_access_levels"></a>

默認(rèn)訪問級別

如果你不為代碼中的所有實體定義顯式訪問級別，那么它們默認(rèn)為internal級別。在大多數(shù)情況下，我們不需要設(shè)置實體的顯式訪問級別。因為我們一般都是在開發(fā)一個app bundle。

<a name="access_levels_for_single-target_apps"></a>

單目標(biāo)應(yīng)用程序的訪問級別

當(dāng)你編寫一個單目標(biāo)應(yīng)用程序時，該應(yīng)用的所有功能都是為該應(yīng)用服務(wù)，不需要提供給其他應(yīng)用或者模塊使用，所以我們不需要明確設(shè)置訪問級別，使用默認(rèn)的訪問級別internal即可。但是如果你愿意，你也可以使用private級別，用于隱藏一些功能的實現(xiàn)細節(jié)。

<a name="access_levels_for_frameworks"></a>

Framework的訪問級別

當(dāng)你開發(fā)Framework時，就需要把一些對外的接口定義為public級別，以便其他人導(dǎo)入該Framework后可以正常使用其功能。這些被你定義為public的接口，就是這個Framework的API。

注意：Framework的內(nèi)部實現(xiàn)細節(jié)依然可以使用默認(rèn)的internal級別，或者也可以定義為private級別。只有當(dāng)你想把它作為 API 的一部分的時候，才將其定義為public級別。

<a name="access_levels_for_unit_test_targets"></a>

單元測試目標(biāo)的訪問級別

當(dāng)你的app有單元測試目標(biāo)時，為了方便測試，測試模塊需要能訪問到你app中的代碼。默認(rèn)情況下只有public級別的實體才可以被其他模塊訪問。然而，如果在引入一個生產(chǎn)模塊時使用@testable注解，然后用帶測試的方式編譯這個生產(chǎn)模塊，單元測試目標(biāo)就可以訪問所有internal級別的實體。

<a name="access_control_syntax"></a>

訪問控制語法

通過修飾符public、internal、private來聲明實體的訪問級別：

public class SomePublicClass {}
internal class SomeInternalClass {}
private class SomePrivateClass {}


public var somePublicVariable = 0
internal let someInternalConstant = 0
private func somePrivateFunction() {}

除非有特殊的說明，否則實體都使用默認(rèn)的訪問級別internal，可以查閱默認(rèn)訪問級別這一節(jié)。這意味著在不使用修飾符聲明顯式訪問級別的情況下，SomeInternalClass和someInternalConstant仍然擁有隱式的訪問級別internal：

class SomeInternalClass {}              // 隱式訪問級別 internal
var someInternalConstant = 0            // 隱式訪問級別 internal

<a name="custom_types"></a>

自定義類型

如果想為一個自定義類型申明顯式訪問級別，那么要明確一點。那就是你要確保新類型的訪問級別和它實際的作用域相匹配。比如說，如果你定義了一個private類，那這個類就只能在定義它的源文件中當(dāng)作屬性類型、函數(shù)參數(shù)或者返回類型使用。

類的訪問級別也可以影響到類成員（屬性、函數(shù)、初始化方法等）的默認(rèn)訪問級別。如果你將類申明為private類，那么該類的所有成員的默認(rèn)訪問級別也會成為private。如果你將類申明為public或者internal類（或者不明確的申明訪問級別，而使用默認(rèn)的internal訪問級別），那么該類的所有成員的訪問級別是internal。

注意：上面提到，一個public類的所有成員的訪問級別默認(rèn)為internal級別，而不是public級別。如果你想將某個成員申明為public級別，那么你必須使用修飾符明確的聲明該成員。這樣做的好處是，在你定義公共接口API的時候，可以明確的選擇哪些屬性或方法是需要公開的，哪些是內(nèi)部使用的，可以避免將內(nèi)部使用的屬性方法公開成公共API的錯誤。

public class SomePublicClass {          // 顯式的 public 類
    public var somePublicProperty = 0    // 顯式的 public 類成員
    var someInternalProperty = 0         // 隱式的 internal 類成員
    private func somePrivateMethod() {}  // 顯式的 private 類成員
}


class SomeInternalClass {               // 隱式的 internal 類
    var someInternalProperty = 0         // 隱式的 internal 類成員
    private func somePrivateMethod() {}  // 顯式的 private 類成員
}


private class SomePrivateClass {        // 顯式的 private 類
    var somePrivateProperty = 0          // 隱式的 private 類成員
    func somePrivateMethod() {}          // 隱式的 private 類成員
}

<a name="tuple_types"></a>

元組類型

元組的訪問級別使用是所有類型的訪問級別使用中最為嚴(yán)謹(jǐn)?shù)?。比如說，如果你構(gòu)建一個包含兩種不同類型元素的元組，其中一個元素類型的訪問級別為internal，另一個為private級別，那么這個元組的訪問級別為private。也就是說元組的訪問級別與元組中訪問級別最低的類型一致。

注意：元組不同于類、結(jié)構(gòu)體、枚舉、函數(shù)那樣有單獨的定義。元組的訪問級別是在它被使用時自動推導(dǎo)出的，而不是明確的申明。

<a name="function_types"></a>

函數(shù)類型

函數(shù)的訪問級別需要根據(jù)該函數(shù)的參數(shù)類型和返回類型的訪問級別得出。如果根據(jù)參數(shù)類型和返回類型得出的函數(shù)訪問級別不符合默認(rèn)上下文，那么就需要明確地申明該函數(shù)的訪問級別。

下面的例子定義了一個名為someFunction全局函數(shù)，并且沒有明確地申明其訪問級別。也許你會認(rèn)為該函數(shù)應(yīng)該擁有默認(rèn)的訪問級別internal，但事實并非如此。事實上，如果按下面這種寫法，帶埋是無法編譯通過的：

func someFunction() -> (SomeInternalClass, SomePrivateClass) {
    // function implementation goes here
}

我們可以看到，這個函數(shù)的返回類型是一個元組，該元組中包含兩個自定義的類（可查閱自定義類型）。其中一個類的訪問級別是internal，另一個的訪問級別是private，所以根據(jù)元組訪問級別的原則，該元組的訪問級別是private（元組的訪問級別與元組中訪問級別最低的類型一致）。

因為該函數(shù)返回類型的訪問級別是private，所以你必須使用private修飾符，明確的聲明該函數(shù)：

private func someFunction() -> (SomeInternalClass, SomePrivateClass) {
    // function implementation goes here
}

將該函數(shù)申明為public或internal，或者使用默認(rèn)的訪問級別internal都是錯誤的，因為如果把該函數(shù)當(dāng)做public或internal級別來使用的話，是無法得到private級別的返回值的。

<a name="enumeration_types"></a>

枚舉類型

枚舉中成員的訪問級別繼承自該枚舉，你不能為枚舉中的成員單獨申明不同的訪問級別。

比如下面的例子，枚舉CompassPoint被明確的申明為public級別，那么它的成員North，South，East，West的訪問級別同樣也是public：

public enum CompassPoint {
    case North
    case South
    case East
    case West
}

<a name="raw_values_and_associated_values"></a>

原始值和關(guān)聯(lián)值

枚舉定義中的任何原始值或關(guān)聯(lián)值的類型都必須有一個訪問級別，這個級別至少要不低于枚舉的訪問級別。比如說，你不能在一個internal訪問級別的枚舉中定義private級別的原始值類型。

<a name="nested_types"></a>

嵌套類型

如果在private級別的類型中定義嵌套類型，那么該嵌套類型就自動擁有private訪問級別。如果在public或者internal級別的類型中定義嵌套類型，那么該嵌套類型自動擁有internal訪問級別。如果想讓嵌套類型擁有public訪問級別，那么需要明確地申明該嵌套類型的訪問級別。

<a name="subclassing"></a>

子類

子類的訪問級別不得高于父類的訪問級別。比如說，父類的訪問級別是internal，子類的訪問級別就不能申明為public。

此外，在滿足子類不高于父類訪問級別以及遵循各訪問級別作用域（即模塊或源文件）的前提下，你可以重寫任意類成員（方法、屬性、初始化方法、下標(biāo)索引等）。

如果我們無法直接訪問某個類中的屬性或函數(shù)等，那么可以繼承該類，從而可以更容易的訪問到該類的類成員。下面的例子中，類A的訪問級別是public，它包含一個函數(shù)someMethod，訪問級別為private。類B繼承類A，并且訪問級別申明為internal，但是在類B中重寫了類A中訪問級別為private的方法someMethod，并重新申明為internal級別。通過這種方式，我們就可以訪問到某類中private級別的類成員，并且可以重新申明其訪問級別，以便其他人使用：

public class A {
    private func someMethod() {}
}


internal class B: A {
    override internal func someMethod() {}
}

只要滿足子類不高于父類訪問級別以及遵循各訪問級別作用域的前提下（即private的作用域在同一個源文件中，internal的作用域在同一個模塊下），我們甚至可以在子類中，用子類成員訪問父類成員，哪怕父類成員的訪問級別比子類成員的要低：

public class A {
    private func someMethod() {}
}


internal class B: A {
    override internal func someMethod() {
        super.someMethod()
    }
}

因為父類A和子類B定義在同一個源文件中，所以在類B中可以在重寫的someMethod方法中調(diào)用super.someMethod()。

<a name="constants_variables_properties_subscripts"></a>

常量、變量、屬性、下標(biāo)

常量、變量、屬性不能擁有比它們的類型更高的訪問級別。比如說，你定義一個public級別的屬性，但是它的類型是private級別的，這是編譯器所不允許的。同樣，下標(biāo)也不能擁有比索引類型或返回類型更高的訪問級別。

如果常量、變量、屬性、下標(biāo)索引的定義類型是private級別的，那么它們必須要明確的申明訪問級別為private：

private var privateInstance = SomePrivateClass()

<a name="getters_and_setters"></a>

Getter和Setter

常量、變量、屬性、下標(biāo)索引的Getters和Setters的訪問級別繼承自它們所屬成員的訪問級別。

Setter的訪問級別可以低于對應(yīng)的Getter的訪問級別，這樣就可以控制變量、屬性或下標(biāo)索引的讀寫權(quán)限。在var或subscript定義作用域之前，你可以通過private(set)或internal(set)先為它們的寫權(quán)限申明一個較低的訪問級別。

注意：這個規(guī)定適用于用作存儲的屬性或用作計算的屬性。即使你不明確地申明存儲屬性的Getter、Setter，Swift也會隱式的為其創(chuàng)建Getter和Setter，用于對該屬性進行讀取操作。使用private(set)和internal(set)可以改變Swift隱式創(chuàng)建的Setter的訪問級別。這對計算屬性也同樣適用。

下面的例子中定義了一個名為TrackedString的結(jié)構(gòu)體，它記錄了value屬性被修改的次數(shù)：

struct TrackedString {
    private(set) var numberOfEdits = 0
    var value: String = "" {
    didSet {
        numberOfEdits++
    }
    }
}

TrackedString結(jié)構(gòu)體定義了一個用于存儲String類型的屬性value，并將初始化值設(shè)為""（即一個空字符串）。該結(jié)構(gòu)體同時也定義了另一個用于存儲Int類型的屬性名numberOfEdits，它用于記錄屬性value被修改的次數(shù)。這個功能的實現(xiàn)通過屬性value的didSet方法實現(xiàn)，每當(dāng)給value賦新值時就會調(diào)用didSet方法，然后將numberOfEdits的值加一。

結(jié)構(gòu)體TrackedString和它的屬性value均沒有申明顯式訪問級別，所以它們都擁有默認(rèn)的訪問級別internal。但是該結(jié)構(gòu)體的numberOfEdits屬性使用private(set)修飾符進行申明，這意味著numberOfEdits屬性只能在定義該結(jié)構(gòu)體的源文件中賦值。numberOfEdits屬性的Getter依然是默認(rèn)的訪問級別internal，但是Setter的訪問級別是private，這表示該屬性只有在當(dāng)前的源文件中是可讀寫的，而在當(dāng)前源文件所屬的模塊中它只是一個可讀的屬性。

如果你實例化TrackedString結(jié)構(gòu)體，并且多次對value屬性的值進行修改，你就會看到numberOfEdits的值會隨著修改次數(shù)進行變化：

var stringToEdit = TrackedString()
stringToEdit.value = "This string will be tracked."
stringToEdit.value += " This edit will increment numberOfEdits."
stringToEdit.value += " So will this one."
println("The number of edits is \(stringToEdit.numberOfEdits)")
// prints "The number of edits is 3"

雖然你可以在其他的源文件中實例化該結(jié)構(gòu)體并且獲取到numberOfEdits屬性的值，但是你不能對其進行賦值。這樣就能很好的告訴使用者，你只管使用，而不需要知道其實現(xiàn)細節(jié)。

如果有必要你可以為Getter和Setter方法設(shè)定顯式訪問級別。下面的例子就是明確申明了public訪問級別的TrackedString結(jié)構(gòu)體。結(jié)構(gòu)體的成員（包括numberOfEdits屬性）擁有默認(rèn)的訪問級別internal。你可以結(jié)合public和private(set)修飾符把結(jié)構(gòu)體中的numberOfEdits屬性Getter方法的訪問級別設(shè)置為public，而Setter方法的訪問級別設(shè)置為private：

public struct TrackedString {
    public private(set) var numberOfEdits = 0
    public var value: String = "" {
        didSet {
            numberOfEdits++
        }
    }
    public init() {}
}

<a name="initializers"></a>

初始化

我們可以給自定義的初始化方法申明訪問級別，但是要不高于它所屬類的訪問級別。但必要構(gòu)造器例外，它的訪問級別必須和所屬類的訪問級別相同。

如同函數(shù)或方法參數(shù)，初始化方法參數(shù)的訪問級別也不能低于初始化方法的訪問級別。

<a name="default_initializers"></a>

默認(rèn)初始化方法

Swift為結(jié)構(gòu)體、類都提供了一個默認(rèn)的無參初始化方法，用于給它們的所有屬性提供賦值操作，但不會給出具體值。默認(rèn)初始化方法可以參閱Default Initializers。默認(rèn)初始化方法的訪問級別與所屬類型的訪問級別相同。

注意：如果一個類型被申明為public級別，那么默認(rèn)的初始化方法的訪問級別為internal。如果你想讓無參的初始化方法在其他模塊中可以被使用，那么你必須提供一個具有public訪問級別的無參初始化方法。

<a name="default_memberwise_initializers_for_structure_types"></a>

結(jié)構(gòu)體的默認(rèn)成員初始化方法

如果結(jié)構(gòu)體中的任一存儲屬性的訪問級別為private，那么它的默認(rèn)成員初始化方法訪問級別就是private。盡管如此，結(jié)構(gòu)體的初始化方法的訪問級別依然是internal。

如果你想在其他模塊中使用該結(jié)構(gòu)體的默認(rèn)成員初始化方法，那么你需要提供一個訪問級別為public的默認(rèn)成員初始化方法。

<a name="protocols"></a>

協(xié)議

如果想為一個協(xié)議明確的申明訪問級別，那么需要注意一點，就是你要確保該協(xié)議只在你申明的訪問級別作用域中使用。

協(xié)議中的每一個必須要實現(xiàn)的函數(shù)都具有和該協(xié)議相同的訪問級別。這樣才能確保該協(xié)議的使用者可以實現(xiàn)它所提供的函數(shù)。

注意：如果你定義了一個public訪問級別的協(xié)議，那么實現(xiàn)該協(xié)議提供的必要函數(shù)也會是public的訪問級別。這一點不同于其他類型，比如，public訪問級別的其他類型，他們成員的訪問級別為internal。

<a name="protocol_inheritance"></a>

協(xié)議繼承

如果定義了一個新的協(xié)議，并且該協(xié)議繼承了一個已知的協(xié)議，那么新協(xié)議擁有的訪問級別最高也只和被繼承協(xié)議的訪問級別相同。比如說，你不能定義一個public的協(xié)議而去繼承一個internal的協(xié)議。

<a name="protocol_conformance"></a>

協(xié)議一致性

類可以采用比自身訪問級別低的協(xié)議。比如說，你可以定義一個public級別的類，可以讓它在其他模塊中使用，同時它也可以采用一個internal級別的協(xié)議，并且只能在定義了該協(xié)議的模塊中使用。

采用了協(xié)議的類的訪問級別取它本身和所采用協(xié)議中最低的訪問級別。也就是說如果一個類是public級別，采用的協(xié)議是internal級別，那么采用了這個協(xié)議后，該類的訪問級別也是internal。

如果你采用了協(xié)議，那么實現(xiàn)了協(xié)議所必須的方法后，該方法的訪問級別遵循協(xié)議的訪問級別。比如說，一個public級別的類，采用了internal級別的協(xié)議，那么該類實現(xiàn)協(xié)議的方法至少也得是internal。

注意：Swift和Objective-C一樣，協(xié)議的一致性保證了一個類不可能在同一個程序中用不同的方法采用同一個協(xié)議。

<a name="extensions"></a>

擴展

你可以在條件允許的情況下對類、結(jié)構(gòu)體、枚舉進行擴展。擴展成員應(yīng)該具有和原始類成員一致的訪問級別。比如你擴展了一個公共類型，那么你新加的成員應(yīng)該具有和原始成員一樣的默認(rèn)的internal訪問級別。

或者，你可以明確申明擴展的訪問級別（比如使用private extension）給該擴展內(nèi)所有成員申明一個新的默認(rèn)訪問級別。這個新的默認(rèn)訪問級別仍然可以被單獨成員所申明的訪問級別所覆蓋。

<a name="adding_protocol_conformance_with_an_extension"></a>

協(xié)議的擴展

如果一個擴展采用了某個協(xié)議，那么你就不能對該擴展使用訪問級別修飾符來申明了。該擴展中實現(xiàn)協(xié)議的方法都會遵循該協(xié)議的訪問級別。

<a name="generics"></a>

泛型

泛型類型或泛型函數(shù)的訪問級別取泛型類型、函數(shù)本身、泛型類型參數(shù)三者中的最低訪問級別。

<a name="type_aliases"></a>

類型別名

任何你定義的類型別名都會被當(dāng)作不同的類型，以便于進行訪問控制。一個類型別名的訪問級別不可高于原類型的訪問級別。比如說，一個private級別的類型別名可以設(shè)定給一個public、internal、private的類型，但是一個public級別的類型別名只能設(shè)定給一個public級別的類型，不能設(shè)定給internal或private 級別的類型。

注意：這條規(guī)則也適用于為滿足協(xié)議一致性而給相關(guān)類型命名別名的情況。

以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號