访问控制可以限定其他源文件或模块中的代码对你的代码的访问级别。这个特性可以让我们隐藏代码的一些实现细节,并且可以为其他人可以访问和使用的代码提供接口。
你可以明确地给单个类型(类、结构体、枚举)设置访问级别,也可以给这些类型的属性、方法、构造器、下标等设置访问级别。协议也可以被限定在一定的范围内使用,包括协议里的全局常量、变量和函数。
Swift 不仅提供了多种不同的访问级别,还为某些典型场景提供了默认的访问级别,这样就不需要我们在每段代码中都申明显式访问级别。其实,如果只是开发一个单一 target 的应用程序,我们完全可以不用显式申明代码的访问级别。
访问级别
Swift 为代码中的实体提供了三种不同的访问级别。这些访问级别不仅与源文件中定义的实体相关,同时也与源文件所属的模块相关。
-
public
:可以访问同一模块源文件中的任何实体,在模块外也可以通过导入该模块来访问源文件里的所有实体。通常情况下,框架中的某个接口可以被任何人使用时,你可以将其设置为public
级别。 -
internal
:可以访问同一模块源文件中的任何实体,但是不能从模块外访问该模块源文件中的实体。通常情况下,某个接口只在应用程序或框架内部使用时,你可以将其设置为internal
级别。 -
private
:限制实体只能在所在的源文件内部使用。使用private
级别可以隐藏某些功能的实现细节。
public
为最高(限制最少)访问级别,private
为最低(限制最多)访问级别。
ps: Swift 中的
private
访问级别不同于其他语言,它的范围限于源文件,而不是声明范围内。这就意味着,一个类型可以访问其所在源文件中的所有private
实体,但是如果它的扩展定义在其他源文件中,那么它的扩展就不能访问它在这个源文件中定义的private
实体。
访问级别基本原则
Swift 中的访问级别遵循一个基本原则:不可以在某个实体中定义访问级别更高的实体。
例如:
- 一个
public
访问级别的变量,其类型的访问级别不能是internal
或private
。因为无法保证变量的类型在使用变量的地方也具有访问权限。 - 函数的访问级别不能高于它的参数类型和返回类型的访问级别。因为如果函数定义为
public
而参数类型或者返回类型定义为internal
或private
,就会出现函数可以在任何地方被访问,但是它的参数类型和返回类型却不可以。
默认访问级别
如果你不为代码中的实体显式指定访问级别,那么它们默认为 internal
级别(有一些例外情况,稍后会进行说明)。因此,在大多数情况下,我们不需要显式指定实体的访问级别。
框架的访问级别
当你开发框架时,就需要把一些对外的接口定义为 public
级别,以便使用者导入该框架后可以正常使用其功能。这些被你定义为 public
的接口,就是这个框架的 API。
ps: 框架依然会使用默认的
internal
级别,也可以指定为private
级别。当你想把某个实体作为框架的 API 的时候,需显式为其指定public
级别。
单元测试 target 的访问级别
当你的应用程序包含单元测试 target 时,为了测试,测试模块需要访问应用程序模块中的代码。默认情况下只有 public
级别的实体才可以被其他模块访问。然而,如果在导入应用程序模块的语句前使用 @testable
特性,然后在允许测试的编译设置(Build Options -> Enable Testability
)下编译这个应用程序模块,单元测试 target 就可以访问应用程序模块中所有 internal
级别的实体。
语法
public class SomePublicClass {}
internal class SomeInternalClass {}
private class SomePrivateClass {}
public var somePublicVariable = 0
internal let someInternalConstant = 0
private func somePrivateFunction() {}
自定义类型
一个类型的访问级别也会影响到类型成员(属性、方法、构造器、下标)的默认访问级别。如果你将类型指定为 private
级别,那么该类型的所有成员的默认访问级别也会变成 private
。如果你将类型指定为 public
或者 internal
级别(或者不明确指定访问级别,而使用默认的 internal
访问级别),那么该类型的所有成员的默认访问级别将是 internal
。
ps: 上面提到,一个
public
类型的所有成员的访问级别默认为internal
级别,而不是public
级别。如果你想将某个成员指定为public
级别,那么你必须显式指定。这样做的好处是,在你定义公共接口的时候,可以明确地选择哪些接口是需要公开的,哪些是内部使用的,避免不小心将内部使用的接口公开。
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
。
ps: 元组不同于类、结构体、枚举、函数那样有单独的定义。元组的访问级别是在它被使用时自动推断出的,而无法明确指定。
函数类型
函数的访问级别根据访问级别最严格的参数类型或返回类型的访问级别来决定。但是,如果这种访问级别不符合函数定义所在环境的默认访问级别,那么就需要明确地指定该函数的访问级别。
private func someFunction() -> (SomeInternalClass, SomePrivateClass) {
// 此处是函数实现部分
}
将该函数指定为 public
或 internal
,或者使用默认的访问级别 internal
都是错误的,因为如果把该函数当做 public
或 internal
级别来使用的话,可能会无法访问 private
级别的返回值。
枚举类型
枚举成员的访问级别和该枚举类型相同,你不能为枚举成员单独指定不同的访问级别。
枚举定义中的任何原始值或关联值的类型的访问级别至少不能低于枚举类型的访问级别。例如,你不能在一个 internal
访问级别的枚举中定义 private 级别的原始值类型。
嵌套类型
如果在 private
级别的类型中定义嵌套类型,那么该嵌套类型就自动拥有 private
访问级别。如果在 public
或者 internal
级别的类型中定义嵌套类型,那么该嵌套类型自动拥有 internal
访问级别。如果想让嵌套类型拥有 public
访问级别,那么需要明确指定该嵌套类型的访问级别。
子类
子类的访问级别不得高于父类的访问级别。例如,父类的访问级别是 internal
,子类的访问级别就不能是 public
。
可以通过重写为继承来的类成员提供更高的访问级别。
public class A {
private func someMethod() {}
}
internal class B: A {
override internal func someMethod() {
super.someMethod()
}
}
常量、变量、属性、下标
常量、变量、属性不能拥有比它们的类型更高的访问级别。例如,你不能定义一个 public
级别的属性,但是它的类型却是 private
级别的。同样,下标也不能拥有比索引类型或返回类型更高的访问级别。
Getter 和 Setter
常量、变量、属性、下标的 Getters
和 Setters
的访问级别和它们所属类型的访问级别相同。
Setter
的访问级别可以低于对应的 Getter
的访问级别,这样就可以控制变量、属性或下标的读写权限。在 var
或 subscript
关键字之前,你可以通过 private(set)
或 internal(set)
为它们的写入权限指定更低的访问级别。
ps: 这个规则同时适用于存储型属性和计算型属性。即使你不明确指定存储型属性的
Getter
和Setter
,Swift 也会隐式地为其创建Getter
和Setter
,用于访问该属性的后备存储。使用private(set)
和internal(set)
可以改变Setter
的访问级别,这对计算型属性也同样适用。
struct TrackedString {
private(set) var numberOfEdits = 0
var value: String = "" {
didSet {
numberOfEdits++
}
}
}
构造器
自定义构造器的访问级别可以低于或等于其所属类型的访问级别。唯一的例外是必要构造器,它的访问级别必须和所属类型的访问级别相同。
如同函数或方法的参数,构造器参数的访问级别也不能低于构造器本身的访问级别。
默认构造器
默认构造器的访问级别与所属类型的访问级别相同,除非类型的访问级别是 public
。如果一个类型被指定为 public
级别,那么默认构造器的访问级别将为 internal
。如果你希望一个 public
级别的类型也能在其他模块中使用这种无参数的默认构造器,你只能自己提供一个 public
访问级别的无参数构造器。
结构体默认的成员逐一构造器
如果结构体中任意存储型属性的访问级别为 private
,那么该结构体默认的成员逐一构造器的访问级别就是 private
。否则,这种构造器的访问级别依然是 internal
。
协议
如果想为一个协议类型明确地指定访问级别,在定义协议时指定即可。这将限制该协议只能在适当的访问级别范围内被采纳。
协议中的每一个要求都具有和该协议相同的访问级别。你不能将协议中的要求设置为其他访问级别。这样才能确保该协议的所有要求对于任意采纳者都将可用。
ps: 如果你定义了一个
public
访问级别的协议,那么该协议的所有实现也会是public
访问级别。这一点不同于其他类型,例如,当类型是public
访问级别时,其成员的访问级别却只是internal
。
协议继承
如果定义了一个继承自其他协议的新协议,那么新协议拥有的访问级别最高也只能和被继承协议的访问级别相同。例如,你不能将继承自 internal
协议的新协议定义为 public
协议。
协议一致性
一个类型可以采纳比自身访问级别低的协议。例如,你可以定义一个 public
级别的类型,它可以在其他模块中使用,同时它也可以采纳一个 internal
级别的协议,但是只能在该协议所在的模块中作为符合该协议的类型使用。
采纳了协议的类型的访问级别取它本身和所采纳协议两者间最低的访问级别。也就是说如果一个类型是 public
级别,采纳的协议是 internal
级别,那么采纳了这个协议后,该类型作为符合协议的类型时,其访问级别也是 internal
。
如果你采纳了协议,那么实现了协议的所有要求后,你必须确保这些实现的访问级别不能低于协议的访问级别。例如,一个 public
级别的类型,采纳了 internal
级别的协议,那么协议的实现至少也得是 internal
级别。
ps: Swift 和 Objective-C 一样,协议的一致性是全局的,也就是说,在同一程序中,一个类型不可能用两种不同的方式实现同一个协议。
扩展
你可以在访问级别允许的情况下对类、结构体、枚举进行扩展。扩展成员具有和原始类型成员一致的访问级别。例如,你扩展了一个 public
或者 internal
类型,扩展中的成员具有默认的 internal
访问级别,和原始类型中的成员一致 。如果你扩展了一个 private
类型,扩展成员则拥有默认的 private
访问级别。
或者,你可以明确指定扩展的访问级别(例如,private extension
),从而给该扩展中的所有成员指定一个新的默认访问级别。这个新的默认访问级别仍然可以被单独指定的访问级别所覆盖。
通过扩展添加协议一致性
如果你通过扩展来采纳协议,那么你就不能显式指定该扩展的访问级别了。协议拥有相应的访问级别,并会为该扩展中所有协议要求的实现提供默认的访问级别。
泛型
泛型类型或泛型函数的访问级别取决于泛型类型或泛型函数本身的访问级别,还需结合类型参数的类型约束的访问级别,根据这些访问级别中的最低访问级别来确定。
类型别名
你定义的任何类型别名都会被当作不同的类型,以便于进行访问控制。类型别名的访问级别不可高于其表示的类型的访问级别。例如,private
级别的类型别名可以作为 public
、internal
、private
类型的别名,但是 public
级别的类型别名只能作为 public
类型的别名,不能作为 internal
或 private
类型的别名。
ps: 这条规则也适用于为满足协议一致性而将类型别名用于关联类型的情况。
网友评论