访问控制(Access Control)
访问控制可以限定其他源文件或模块中的代码对你的代码的访问级别。这个特性可以让我们隐藏代码的一些实现细节,并且可以指定一些代码和访问和使用的优先接口。
你可以明确地给单个类型(类、结构体、枚举)设置访问级别,也可以给这些类型的属性、方法、构造器、下标等设置访问级别。协议也可以被限定在一定的范围内使用,包括协议里的全局常量、变量和函数。
Swift不仅提供了多种不同的访问级别,还为某些典型场景提供了默认的访问级别,这样就不需要我们在每段代码中都申明显式访问级别。其实,如果只是开发一个单一目标的应用程序,我们完全可以不用显式声明代码的访问级别。
注意:为了简单起见,对于代码中可以设置访问级别的特性(属性、基本类型、函数等),在下面的章节中我们会称之为“实体”。
你可以明确地给单个类型(类、结构体、枚举)设置访问级别,也可以给这些类型的属性、方法、构造器、下标等设置访问级别。协议也可以被限定在一定的范围内使用,包括协议里的全局常量、变量和函数。
Swift不仅提供了多种不同的访问级别,还为某些典型场景提供了默认的访问级别,这样就不需要我们在每段代码中都申明显式访问级别。其实,如果只是开发一个单一目标的应用程序,我们完全可以不用显式声明代码的访问级别。
注意:为了简单起见,对于代码中可以设置访问级别的特性(属性、基本类型、函数等),在下面的章节中我们会称之为“实体”。
模块和源文件(Modules and Source Files)
Swift中的访问控制模型基于模块和源文件这两个概念。
模块指的是独立的代码单元,框架或应用程序会作为一个独立的模块来构建和发布。在Swift中,一个模块可以使用import关键字导入另外一个模块。
在Swift中,Xcode的每个目标(例如框架或应用程序)都被当作独立的模块处理。如果你是为了实现某个通用的功能,或者是为了封装一些常用方法而将代码打包成独立的框架,这个框架就是Swift中的一个模块。当它被导入到某个应用程序或者其他框架时,框架内容都将属于这个独立的模块。
源文件就是Swift中的源代码文件,它通常属于一个模块,即一个应用程序或者框架。尽管我们一般会将不同的类型分别定义在不同的源文件中,但是同一个源文件也可以包含多个类型、函数之类的定义。
访问级别(Access Levels)
Swift为代码中的实体提供了五种不同的访问级别。这些访问级别不仅与源文件中定义的实体相关,同时也与源文件所属的模块相关。
1:开放访问(openaccess)和公开访问(public access)可以访问同一模块源文件中的任何实体,在模块外也可以通过导入该模块来访问源文件里的所有实体。通常情况下,框架中的某个接口可以被任何人使用时,你可以将其设置为开放(Open)或者公开(public)访问。对于开放(Open)或者公开(public)访问的区别,后面会讲到。
2:内部访问(internal)可以访问同一模块源文件中的任何实体,但是不能从模块外访问该模块源文件中的实体。通常情况下,某个接口只在应用程序或框架内部使用时,你可以将其设置为内部访问。
3:文件私有访问(fileprivate)限制实体只能被所定义的文件内部访问。当需要把这些细节被整个文件使用的时候,使用文件私有访问隐藏了一些特定功能的实现细节。
4:私有访问(private)限制实体只能在所定义的作用域内使用。需要把这些细节被整个作用域使用的时候,使用文件私有访问隐藏了一些特定功能的实现细节。
Swift中的访问控制模型基于模块和源文件这两个概念。
模块指的是独立的代码单元,框架或应用程序会作为一个独立的模块来构建和发布。在Swift中,一个模块可以使用import关键字导入另外一个模块。
在Swift中,Xcode的每个目标(例如框架或应用程序)都被当作独立的模块处理。如果你是为了实现某个通用的功能,或者是为了封装一些常用方法而将代码打包成独立的框架,这个框架就是Swift中的一个模块。当它被导入到某个应用程序或者其他框架时,框架内容都将属于这个独立的模块。
源文件就是Swift中的源代码文件,它通常属于一个模块,即一个应用程序或者框架。尽管我们一般会将不同的类型分别定义在不同的源文件中,但是同一个源文件也可以包含多个类型、函数之类的定义。
访问级别(Access Levels)
Swift为代码中的实体提供了五种不同的访问级别。这些访问级别不仅与源文件中定义的实体相关,同时也与源文件所属的模块相关。
1:开放访问(openaccess)和公开访问(public access)可以访问同一模块源文件中的任何实体,在模块外也可以通过导入该模块来访问源文件里的所有实体。通常情况下,框架中的某个接口可以被任何人使用时,你可以将其设置为开放(Open)或者公开(public)访问。对于开放(Open)或者公开(public)访问的区别,后面会讲到。
2:内部访问(internal)可以访问同一模块源文件中的任何实体,但是不能从模块外访问该模块源文件中的实体。通常情况下,某个接口只在应用程序或框架内部使用时,你可以将其设置为内部访问。
3:文件私有访问(fileprivate)限制实体只能被所定义的文件内部访问。当需要把这些细节被整个文件使用的时候,使用文件私有访问隐藏了一些特定功能的实现细节。
4:私有访问(private)限制实体只能在所定义的作用域内使用。需要把这些细节被整个作用域使用的时候,使用文件私有访问隐藏了一些特定功能的实现细节。
开放访问(openaccess)为最高(限制最少)访问级别,私有访问(private access)为最低(限制最多)访问级别。开放访问(open access)只作用于类类型和类的成员,它和公开访问(public access)的区别如下:
1:公开访问(public access)或者其他更严访问级别的类,只能在它们定义的模块内部被继承。
2:公开访问(public access)或者其他更严访问级别的类成员,只能在它们定义的模块内部的子类中重写。
3:开放访问(open access)的类,可以在它们定义的模块中被继承,也可以在引用它们的模块中被继承。
4:开放访问(open access)的类成员,可以在它们定义的模块中子类中重写,也可以在引用它们的模块中的子类重写。
把一个类标记为开放,显式地表明,你认为其他模块中的代码使用此类作为父类,然后你已经设计好了你的类的代码了。
访问级别基本原则(Guiding Pribciple of Access Levels)
Swift中的访问级别遵循一个基本原则:不可以在某个实体中定义访问级别更低(更严格)的实体。例如:
1:公开访问(public access)或者其他更严访问级别的类,只能在它们定义的模块内部被继承。
2:公开访问(public access)或者其他更严访问级别的类成员,只能在它们定义的模块内部的子类中重写。
3:开放访问(open access)的类,可以在它们定义的模块中被继承,也可以在引用它们的模块中被继承。
4:开放访问(open access)的类成员,可以在它们定义的模块中子类中重写,也可以在引用它们的模块中的子类重写。
把一个类标记为开放,显式地表明,你认为其他模块中的代码使用此类作为父类,然后你已经设计好了你的类的代码了。
访问级别基本原则(Guiding Pribciple of Access Levels)
Swift中的访问级别遵循一个基本原则:不可以在某个实体中定义访问级别更低(更严格)的实体。例如:
1:一个公开访问级别的变量(public variable),其类型的访问级别不能是内部(internal),文件私有(fileprivate)或是私有类型(private)的。因为无法保证变量的类型在使用变量的地方可获取。
2:函数的访问级别不能高于它的参数类型和返回类型的访问级别。因为这样就会出现函数可以在任何地方被访问,但是它的参数类型和返回类型却不可以的情况。
关于此原则的各种情况的具体实现,将在下面的细节中体现。
2:函数的访问级别不能高于它的参数类型和返回类型的访问级别。因为这样就会出现函数可以在任何地方被访问,但是它的参数类型和返回类型却不可以的情况。
关于此原则的各种情况的具体实现,将在下面的细节中体现。
默认访问级别(Default Access Levels)
如果你不为代码中的实体显式指定访问级别,那么它们默认为internal级别(有一些例外情况,稍后会进行说明)。因此,在大多数情况下,我们不需要显式指定实体的访问级别。
单目标应用程序的访问级别(Access LevelsforSingle-Target Apps)
当你编写一个简单的单目标应用程序时,应用的所有功能都是为该应用服务,而不需要提供给其他应用或者模块使用,所以我们不需要明确设置访问级别,使用默认的访问级别internal即可。但是,你也可以使用文件私有访问(fileprivate)或私有访问级别(private),用于隐藏一些功能的实现细节。
框架的访问级别(Access LevelsforFrameworks)
当你开发框架时,就需要把一些对外的接口定义为开放(open)访问或公开(public)访问级别,以便使用者导入该框架后可以正常使用其功能。这些被你定义为对外的接口,就是这个框架的API。
注意:框架依然会使用默认的内部访问级别,也可以指定为文件私有访问或者私有访问级别。当你想把某个实体作为框架的API的时候,需显式为其指定开放访问或公开访问级别。
如果你不为代码中的实体显式指定访问级别,那么它们默认为internal级别(有一些例外情况,稍后会进行说明)。因此,在大多数情况下,我们不需要显式指定实体的访问级别。
单目标应用程序的访问级别(Access LevelsforSingle-Target Apps)
当你编写一个简单的单目标应用程序时,应用的所有功能都是为该应用服务,而不需要提供给其他应用或者模块使用,所以我们不需要明确设置访问级别,使用默认的访问级别internal即可。但是,你也可以使用文件私有访问(fileprivate)或私有访问级别(private),用于隐藏一些功能的实现细节。
框架的访问级别(Access LevelsforFrameworks)
当你开发框架时,就需要把一些对外的接口定义为开放(open)访问或公开(public)访问级别,以便使用者导入该框架后可以正常使用其功能。这些被你定义为对外的接口,就是这个框架的API。
注意:框架依然会使用默认的内部访问级别,也可以指定为文件私有访问或者私有访问级别。当你想把某个实体作为框架的API的时候,需显式为其指定开放访问或公开访问级别。
单元测试目标的访问级别(Access LevelsforUnit Test Targets)
当你的应用程序包含单元测试目标时,为了测试,测试模块需要访问应用程序模块中的代码。默认情况下只有开放访问或公开访问级别级别的实体才可以被其他模块访问。然而,如果在导入应用程序模块的语句前使用@testable特性,然后在允许测试的编译设置(Build Options -> Enable Testability)下编译这个应用程序模块,单元测试目标就可以访问应用程序模块中所有内部级别的实体。
访问控制语法(Access Control Syntax)
通过修饰符open,public,internal,fileprivate,private来声明实体的访问级别:
除非专门指定,否则实体默认的访问级别为内部访问级别,可以查阅默认访问级别这一节。这意味着在不使用修饰符显式声明访问级别的情况下,SomeInternalClass和someInternalConstant仍然拥有隐式的内部访问级别:
当你的应用程序包含单元测试目标时,为了测试,测试模块需要访问应用程序模块中的代码。默认情况下只有开放访问或公开访问级别级别的实体才可以被其他模块访问。然而,如果在导入应用程序模块的语句前使用@testable特性,然后在允许测试的编译设置(Build Options -> Enable Testability)下编译这个应用程序模块,单元测试目标就可以访问应用程序模块中所有内部级别的实体。
访问控制语法(Access Control Syntax)
通过修饰符open,public,internal,fileprivate,private来声明实体的访问级别:
- publicclassSomePublicClass{}@H_301_563@
- internalclassSomeInternalClass{}@H_301_563@
- fileprivateclassSomeFilePrivateClass{}@H_301_563@
- privateclassSomePrivateClass{}@H_301_563@
- @H_301_563@
- varsomePublicVariable=0@H_301_563@
- varsomeInternalConstant=0@H_301_563@
- fileprivatefuncsomeFilePrivateFuncation(){}@H_301_563@
- privatefuncsomePrivateFuncation(){}@H_301_563@
如果想为一个自定义类型指定访问级别,在定义类型时进行指定即可。新类型只能在它的访问级别限制范围内使用。例如,你定义了一个文件私有级别的类,那这个类就只能在定义它的源文件中使用,可以作为属性类型、函数参数类型或者返回类型,等等。
一个类型的访问级别也会影响到类型成员(属性、方法、构造器、下标)的默认访问级别。如果你将类型指定为私有或者文件私有级别,那么该类型的所有成员的默认访问级别也会变成私有或者文件私有级别。如果你将类型指定为公开或者内部访问级别(或者不明确指定访问级别,而使用默认的内部访问级别),那么该类型的所有成员的默认访问级别将是内部访问。重要:上面提到,一个公开类型(public type)的所有成员的访问级别默认为内部访问级别,而不是公开级别。如果你想将某个成员指定为公开访问级别,那么你必须显式指定。这样做的好处是,在你定义公共接口的时候,可以明确地选择哪些接口是需要公开的,哪些是内部使用的,避免不小心将内部使用的接口公开。
//显式公开类@H_301_563@
classSomePublicClass{@H_301_563@
//显示公开类成员@H_301_563@
varsomePublicProperty=0@H_301_563@
//隐式内部类成员@H_301_563@
varsomeInternalProperty=0@H_301_563@
//显式文件私有类成员@H_301_563@
fileprivatefuncsomeFilePrivateMethod(){}@H_301_563@
//显式私有类成员@H_301_563@
privatefuncsomePrivateMethod(){}@H_301_563@
}@H_301_563@
@H_301_563@
//隐式内部类@H_301_563@
classSomeInternalClass{@H_301_563@
//显式文件私有类@H_301_563@
classSomeFilePrivateClass{@H_301_563@
//隐式文件私有类成员@H_301_563@
funcsomeFilePrivateMethod(){}@H_301_563@
//显式私有类@H_301_563@
classSomePrivateClass{@H_301_563@
//隐式私有类成员@H_301_563@
funcsomePrivateMethod(){}@H_301_563@
}@H_301_563@
元组类型(Tuple Types)
元组的访问级别将由元组中访问级别最严格的类型来决定。例如,如果你构建了一个包含两种不同类型的元组,其中一个类型为内部访问级别,另一个类型为私有访问级别,那么这个元组的访问级别为私有访问级别。
注意:元组不同于类、结构体、枚举、函数那样有单独的定义。元组的访问级别是在它被使用时自动推断出的,而无法明确指定。
函数类型(Function Types)
函数的访问级别根据访问级别最严格的参数类型或返回类型的访问级别来决定。但是,如果这种访问级别不符合函数定义所在环境的默认访问级别,那么就需要明确地指定该函数的访问级别。
下面的例子定义了一个名为someFunction()的全局函数,并且没有明确地指定其访问级别。也许你会认为该函数应该拥有默认的访问级别internal,但事实并非如此。事实上,如果按下面这种写法,代码将无法通过编译:
我们可以看到,这个函数的返回类型是一个元组,该元组中包含两个自定义的类(可查阅自定义类型)。其中一个类的访问级别是internal,另一个的访问级别是private,所以根据元组访问级别的原则,该元组的访问级别是private(元组的访问级别与元组中访问级别最低的类型一致)。
因为该函数返回类型的访问级别是private,所以你必须使用private修饰符,明确指定该函数的访问级别:
privatefuncsomeFunction()->(SomeInternalClass,0);background-color:inherit;">}@H_301_563@
元组的访问级别将由元组中访问级别最严格的类型来决定。例如,如果你构建了一个包含两种不同类型的元组,其中一个类型为内部访问级别,另一个类型为私有访问级别,那么这个元组的访问级别为私有访问级别。
注意:元组不同于类、结构体、枚举、函数那样有单独的定义。元组的访问级别是在它被使用时自动推断出的,而无法明确指定。
函数类型(Function Types)
函数的访问级别根据访问级别最严格的参数类型或返回类型的访问级别来决定。但是,如果这种访问级别不符合函数定义所在环境的默认访问级别,那么就需要明确地指定该函数的访问级别。
下面的例子定义了一个名为someFunction()的全局函数,并且没有明确地指定其访问级别。也许你会认为该函数应该拥有默认的访问级别internal,但事实并非如此。事实上,如果按下面这种写法,代码将无法通过编译:
funcsomeFunction()->(SomeInternalClass,SomePrivateClass){@H_301_563@
//此处是函数实现部分@H_301_563@
}@H_301_563@
我们可以看到,这个函数的返回类型是一个元组,该元组中包含两个自定义的类(可查阅自定义类型)。其中一个类的访问级别是internal,另一个的访问级别是private,所以根据元组访问级别的原则,该元组的访问级别是private(元组的访问级别与元组中访问级别最低的类型一致)。
因为该函数返回类型的访问级别是private,所以你必须使用private修饰符,明确指定该函数的访问级别:
privatefuncsomeFunction()->(SomeInternalClass,0);background-color:inherit;">}@H_301_563@
将该函数指定为public或internal,或者使用默认的访问级别internal都是错误的,因为如果把该函数当做public或internal级别来使用的话,可能会无法访问private级别的返回值。