訪問控制
本頁內容包括:
訪問控制可以限定其他源文件或模塊中代碼對你代碼的訪問級別。這個特性可以讓我們隱藏功能實現的一些細節,並且可以明確的申明我們提供給其他人的接口中哪些部分是他們可以訪問和使用的。
你可以明確地給單個類型(類、結構體、枚舉)設置訪問級別,也可以給這些類型的屬性、函數、初始化方法、基本類型、下標索引等設置訪問級別。協議也可以被限定在一定的範圍內使用,包括協議裏的全局常量、變量和函數。
在提供了不同訪問級別的同時,Swift還爲某些典型場景提供了默認的訪問級別,這樣就不需要我們在每段代碼中都申明顯式訪問級別。其實,如果只是開發一個單目標應用程序,我們完全可以不用申明代碼的顯式訪問級別。
注意:簡單起見,代碼中可以設置訪問級別的特性(屬性、基本類型、函數等),在下面的章節中我們會以“實體”代替。
模塊和源文件
Swift 中的訪問控制模型基於模塊和源文件這兩個概念。
模塊指的是以獨立單元構建和發佈的Framework
或Application
。在Swift 中的一個模塊可以使用import
關鍵字引入另外一個模塊。
在 Swift 中,Xcode的每個構建目標(比如Framework
或app bundle
)都被當作模塊處理。如果你是爲了實現某個通用的功能,或者是爲了封裝一些常用方法而將代碼打包成獨立的Framework
,這個Framework
在 Swift 中就被稱爲模塊。當它被引入到某個 app 工程或者另外一個Framework
時,它裏面的一切(屬性、函數等)仍然屬於這個獨立的模塊。
源文件指的是 Swift 中的Swift File
,就是編寫 Swift 源代碼的文件,它通常屬於一個模塊。儘管一般我們將不同的類
分別定義在不同的源文件中,但是同一個源文件可以包含多個類
和函數
的定義。
訪問級別
Swift 爲代碼中的實體提供了三種不同的訪問級別。這些訪問級別不僅與源文件中定義的實體相關,同時也與源文件所屬的模塊相關。
public
:可以訪問自己模塊中源文件裏的任何實體,別人也可以通過引入該模塊來訪問源文件裏的所有實體。通常情況下,Framework
中的某個接口是可以被任何人使用時,你可以將其設置爲public
級別。internal
:可以訪問自己模塊中源文件裏的任何實體,但是別人不能訪問該模塊中源文件裏的實體。通常情況下,某個接口或Framework
作爲內部結構使用時,你可以將其設置爲internal
級別。private
:只能在當前源文件中使用的實體,稱爲私有實體。使用private
級別,可以用作隱藏某些功能的實現細節。
public
爲最高級訪問級別,private
爲最低級訪問級別。
注意:Swift中的
private
訪問和其他語言中的private
訪問不太一樣,它的範圍限於整個源文件,而不是聲明。這就意味着,一個類
可以訪問定義該類
的源文件中定義的所有private
實體,但是如果一個類
的擴展是定義在獨立的源文件中,那麼就不能訪問這個類
的private
成員。
訪問級別的使用原則
Swift 中的訪問級別遵循一個使用原則:訪問級別統一性。
比如說:
- 一個
public
訪問級別的變量,不能將它的類型定義爲internal
和private
。因爲變量可以被任何人訪問,但是定義它的類型不可以,所以這樣就會出現錯誤。 - 函數的訪問級別不能高於它的參數、返回類型的訪問級別。因爲如果函數定義爲
public
而參數或者返回類型定義爲internal
或private
,就會出現函數可以被任何人訪問,但是它的參數和返回類型確不可以,同樣會出現錯誤。
默認訪問級別
如果你不爲代碼中的所有實體定義顯式訪問級別,那麼它們默認爲internal
級別。在大多數情況下,我們不需要設置實體的顯式訪問級別。因爲我們一般都是在開發一個app bundle
。
單目標應用程序的訪問級別
當你編寫一個單目標應用程序時,該應用的所有功能都是爲該應用服務,不需要提供給其他應用或者模塊使用,所以我們不需要明確設置訪問級別,使用默認的訪問級別internal
即可。但是如果你願意,你也可以使用private
級別,用於隱藏一些功能的實現細節。
Framework的訪問級別
當你開發Framework
時,就需要把一些對外的接口定義爲public
級別,以便其他人導入該Framework
後可以正常使用其功能。這些被你定義爲public
的接口,就是這個Framework
的API。
注意:
Framework
的內部實現細節依然可以使用默認的internal
級別,或者也可以定義爲private
級別。只有當你想把它作爲 API 的一部分的時候,纔將其定義爲public
級別。
單元測試目標的訪問級別
當你的app有單元測試目標時,爲了方便測試,測試模塊需要能訪問到你app中的代碼。默認情況下只有public
級別的實體纔可以被其他模塊訪問。然而,如果在引入一個生產模塊時使用@testable
註解,然後用帶測試的方式編譯這個生產模塊,單元測試目標就可以訪問所有internal
級別的實體。
訪問控制語法
通過修飾符public
、internal
、private
來聲明實體的訪問級別:
public class SomePublicClass {}
internal class SomeInternalClass {}
private class SomePrivateClass {}
public var somePublicVariable = 0
internal let someInternalConstant = 0
private func somePrivateFunction() {}
除非有特殊的說明,否則實體都使用默認的訪問級別internal
,可以查閱默認訪問級別這一節。這意味着在不使用修飾符聲明顯式訪問級別的情況下,SomeInternalClass
和someInternalConstant
仍然擁有隱式的訪問級別internal
:
class SomeInternalClass {} // 隱式訪問級別 internal
var someInternalConstant = 0 // 隱式訪問級別 internal
自定義類型
如果想爲一個自定義類型申明顯式訪問級別,那麼要明確一點。那就是你要確保新類型的訪問級別和它實際的作用域相匹配。比如說,如果你定義了一個private
類,那這個類就只能在定義它的源文件中當作屬性類型、函數參數或者返回類型使用。
類的訪問級別也可以影響到類成員(屬性、函數、初始化方法等)的默認訪問級別。如果你將類申明爲private
類,那麼該類的所有成員的默認訪問級別也會成爲private
。如果你將類申明爲public
或者internal
類(或者不明確的申明訪問級別,而使用默認的internal
訪問級別),那麼該類的所有成員的訪問級別是internal
。
注意:上面提到,一個
public
類的所有成員的訪問級別默認爲internal
級別,而不是public
級別。如果你想將某個成員申明爲public
級別,那麼你必須使用修飾符明確的聲明該成員。這樣做的好處是,在你定義公共接口API的時候,可以明確的選擇哪些屬性或方法是需要公開的,哪些是內部使用的,可以避免將內部使用的屬性方法公開成公共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 類成員
}
元組類型
元組的訪問級別使用是所有類型的訪問級別使用中最爲嚴謹的。比如說,如果你構建一個包含兩種不同類型元素的元組,其中一個元素類型的訪問級別爲internal
,另一個爲private
級別,那麼這個元組的訪問級別爲private
。也就是說元組的訪問級別與元組中訪問級別最低的類型一致。
注意:元組不同於類、結構體、枚舉、函數那樣有單獨的定義。元組的訪問級別是在它被使用時自動推導出的,而不是明確的申明。
函數類型
函數的訪問級別需要根據該函數的參數類型和返回類型的訪問級別得出。如果根據參數類型和返回類型得出的函數訪問級別不符合默認上下文,那麼就需要明確地申明該函數的訪問級別。
下面的例子定義了一個名爲someFunction
全局函數,並且沒有明確地申明其訪問級別。也許你會認爲該函數應該擁有默認的訪問級別internal
,但事實並非如此。事實上,如果按下面這種寫法,帶埋是無法編譯通過的:
func someFunction() -> (SomeInternalClass, SomePrivateClass) {
// function implementation goes here
}
我們可以看到,這個函數的返回類型是一個元組,該元組中包含兩個自定義的類(可查閱自定義類型)。其中一個類的訪問級別是internal
,另一個的訪問級別是private
,所以根據元組訪問級別的原則,該元組的訪問級別是private
(元組的訪問級別與元組中訪問級別最低的類型一致)。
因爲該函數返回類型的訪問級別是private
,所以你必須使用private
修飾符,明確的聲明該函數:
private func someFunction() -> (SomeInternalClass, SomePrivateClass) {
// function implementation goes here
}
將該函數申明爲public
或internal
,或者使用默認的訪問級別internal
都是錯誤的,因爲如果把該函數當做public
或internal
級別來使用的話,是無法得到private
級別的返回值的。
枚舉類型
枚舉中成員的訪問級別繼承自該枚舉,你不能爲枚舉中的成員單獨申明不同的訪問級別。
比如下面的例子,枚舉CompassPoint
被明確的申明爲public
級別,那麼它的成員North
,South
,East
,West
的訪問級別同樣也是public
:
public enum CompassPoint {
case North
case South
case East
case West
}
原始值和關聯值
枚舉定義中的任何原始值或關聯值的類型都必須有一個訪問級別,這個級別至少要不低於枚舉的訪問級別。比如說,你不能在一個internal
訪問級別的枚舉中定義private
級別的原始值類型。
嵌套類型
如果在private
級別的類型中定義嵌套類型,那麼該嵌套類型就自動擁有private
訪問級別。如果在public
或者internal
級別的類型中定義嵌套類型,那麼該嵌套類型自動擁有internal
訪問級別。如果想讓嵌套類型擁有public
訪問級別,那麼需要明確地申明該嵌套類型的訪問級別。
子類
子類的訪問級別不得高於父類的訪問級別。比如說,父類的訪問級別是internal
,子類的訪問級別就不能申明爲public
。
此外,在滿足子類不高於父類訪問級別以及遵循各訪問級別作用域(即模塊或源文件)的前提下,你可以重寫任意類成員(方法、屬性、初始化方法、下標索引等)。
如果我們無法直接訪問某個類中的屬性或函數等,那麼可以繼承該類,從而可以更容易的訪問到該類的類成員。下面的例子中,類A
的訪問級別是public
,它包含一個函數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
方法中調用super.someMethod()
。
常量、變量、屬性、下標
常量、變量、屬性不能擁有比它們的類型更高的訪問級別。比如說,你定義一個public
級別的屬性,但是它的類型是private
級別的,這是編譯器所不允許的。同樣,下標也不能擁有比索引類型或返回類型更高的訪問級別。
如果常量、變量、屬性、下標索引的定義類型是private
級別的,那麼它們必須要明確的申明訪問級別爲private
:
private var privateInstance = SomePrivateClass()
Getter和Setter
常量、變量、屬性、下標索引的Getters
和Setters
的訪問級別繼承自它們所屬成員的訪問級別。
Setter
的訪問級別可以低於對應的Getter
的訪問級別,這樣就可以控制變量、屬性或下標索引的讀寫權限。在var
或subscript
定義作用域之前,你可以通過private(set)
或internal(set)
先爲它們的寫權限申明一個較低的訪問級別。
注意:這個規定適用於用作存儲的屬性或用作計算的屬性。即使你不明確地申明存儲屬性的
Getter
、Setter
,Swift也會隱式的爲其創建Getter
和Setter
,用於對該屬性進行讀取操作。使用private(set)
和internal(set)
可以改變Swift隱式創建的Setter
的訪問級別。這對計算屬性也同樣適用。
下面的例子中定義了一個名爲TrackedString
的結構體,它記錄了value
屬性被修改的次數:
struct TrackedString {
private(set) var numberOfEdits = 0
var value: String = "" {
didSet {
numberOfEdits++
}
}
}
TrackedString
結構體定義了一個用於存儲String
類型的屬性value
,並將初始化值設爲""
(即一個空字符串)。該結構體同時也定義了另一個用於存儲Int
類型的屬性名numberOfEdits
,它用於記錄屬性value
被修改的次數。這個功能的實現通過屬性value
的didSet
方法實現,每當給value
賦新值時就會調用didSet
方法,然後將numberOfEdits
的值加一。
結構體TrackedString
和它的屬性value
均沒有申明顯式訪問級別,所以它們都擁有默認的訪問級別internal
。但是該結構體的numberOfEdits
屬性使用private(set)
修飾符進行申明,這意味着numberOfEdits
屬性只能在定義該結構體的源文件中賦值。numberOfEdits
屬性的Getter
依然是默認的訪問級別internal
,但是Setter
的訪問級別是private
,這表示該屬性只有在當前的源文件中是可讀寫的,而在當前源文件所屬的模塊中它只是一個可讀的屬性。
如果你實例化TrackedString
結構體,並且多次對value
屬性的值進行修改,你就會看到numberOfEdits
的值會隨着修改次數進行變化:
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"
雖然你可以在其他的源文件中實例化該結構體並且獲取到numberOfEdits
屬性的值,但是你不能對其進行賦值。這樣就能很好的告訴使用者,你只管使用,而不需要知道其實現細節。
如果有必要你可以爲Getter
和Setter
方法設定顯式訪問級別。下面的例子就是明確申明瞭public
訪問級別的TrackedString
結構體。結構體的成員(包括numberOfEdits
屬性)擁有默認的訪問級別internal
。你可以結合public
和private(set)
修飾符把結構體中的numberOfEdits
屬性Getter
方法的訪問級別設置爲public
,而Setter
方法的訪問級別設置爲private
:
public struct TrackedString {
public private(set) var numberOfEdits = 0
public var value: String = "" {
didSet {
numberOfEdits++
}
}
public init() {}
}
初始化
我們可以給自定義的初始化方法申明訪問級別,但是要不高於它所屬類的訪問級別。但必要構造器例外,它的訪問級別必須和所屬類的訪問級別相同。
如同函數或方法參數,初始化方法參數的訪問級別也不能低於初始化方法的訪問級別。
默認初始化方法
Swift爲結構體、類都提供了一個默認的無參初始化方法,用於給它們的所有屬性提供賦值操作,但不會給出具體值。默認初始化方法可以參閱Default Initializers。默認初始化方法的訪問級別與所屬類型的訪問級別相同。
注意:如果一個類型被申明爲
public
級別,那麼默認的初始化方法的訪問級別爲internal
。如果你想讓無參的初始化方法在其他模塊中可以被使用,那麼你必須提供一個具有public
訪問級別的無參初始化方法。
結構體的默認成員初始化方法
如果結構體中的任一存儲屬性的訪問級別爲private
,那麼它的默認成員初始化方法訪問級別就是private
。儘管如此,結構體的初始化方法的訪問級別依然是internal
。
如果你想在其他模塊中使用該結構體的默認成員初始化方法,那麼你需要提供一個訪問級別爲public
的默認成員初始化方法。
協議
如果想爲一個協議明確的申明訪問級別,那麼需要注意一點,就是你要確保該協議只在你申明的訪問級別作用域中使用。
協議中的每一個必須要實現的函數都具有和該協議相同的訪問級別。這樣才能確保該協議的使用者可以實現它所提供的函數。
注意:如果你定義了一個
public
訪問級別的協議,那麼實現該協議提供的必要函數也會是public
的訪問級別。這一點不同於其他類型,比如,public
訪問級別的其他類型,他們成員的訪問級別爲internal
。
協議繼承
如果定義了一個新的協議,並且該協議繼承了一個已知的協議,那麼新協議擁有的訪問級別最高也只和被繼承協議的訪問級別相同。比如說,你不能定義一個public
的協議而去繼承一個internal
的協議。
協議一致性
類可以採用比自身訪問級別低的協議。比如說,你可以定義一個public
級別的類,可以讓它在其他模塊中使用,同時它也可以採用一個internal
級別的協議,並且只能在定義了該協議的模塊中使用。
採用了協議的類的訪問級別取它本身和所採用協議中最低的訪問級別。也就是說如果一個類是public
級別,採用的協議是internal
級別,那麼採用了這個協議後,該類的訪問級別也是internal
。
如果你採用了協議,那麼實現了協議所必須的方法後,該方法的訪問級別遵循協議的訪問級別。比如說,一個public
級別的類,採用了internal
級別的協議,那麼該類實現協議的方法至少也得是internal
。
注意:Swift和Objective-C一樣,協議的一致性保證了一個類不可能在同一個程序中用不同的方法採用同一個協議。
擴展
你可以在條件允許的情況下對類、結構體、枚舉進行擴展。擴展成員應該具有和原始類成員一致的訪問級別。比如你擴展了一個公共類型,那麼你新加的成員應該具有和原始成員一樣的默認的internal
訪問級別。
或者,你可以明確申明擴展的訪問級別(比如使用private extension
)給該擴展內所有成員申明一個新的默認訪問級別。這個新的默認訪問級別仍然可以被單獨成員所申明的訪問級別所覆蓋。
協議的擴展
如果一個擴展采用了某個協議,那麼你就不能對該擴展使用訪問級別修飾符來申明瞭。該擴展中實現協議的方法都會遵循該協議的訪問級別。
泛型
泛型類型或泛型函數的訪問級別取泛型類型、函數本身、泛型類型參數三者中的最低訪問級別。
類型別名
任何你定義的類型別名都會被當作不同的類型,以便於進行訪問控制。一個類型別名的訪問級別不可高於原類型的訪問級別。比如說,一個private
級別的類型別名可以設定給一個public
、internal
、private
的類型,但是一個public
級別的類型別名只能設定給一個public
級別的類型,不能設定給internal
或private
級別的類型。
注意:這條規則也適用於爲滿足協議一致性而給相關類型命名別名的情況。