swift 访问控制(open、public、internal、fileprivate、private)

1,674 阅读8分钟

这是我参与更文挑战的第26天,活动详情查看: 更文挑战

访问控制

  • 访问控制:用来控制代码是否需要暴露给调用方的一种设置,比如可以隐藏一些代码的实现细节等等
  • 可以为类、结构体、枚举中的属性、方法、构造器等设置访问级别
  • Swift 为某些典型场景提供了默认的访问级别,这样就不需要我们在每段代码中都申明显式访问级别

注意
为了简单起见,我们用“实体”来形容被访问级别控制的内容(如属性、函数、类等)


模块和源文件

Swift中的访问控制是基于 模块源文件 这两个概念

  • 模块:一个单独的代码分发单元。比如一个能被其它模块通过import 关键字导入的framework程序

  • 源文件:模块内的一个 Swift 源代码文件(实际上是应用程序或框架内的一个文件)。虽然在单独的源文件中定义单个类型很常见,但是单个源文件可以包含多个类型、函数等的定义


访问级别

  • Swift 为代码中的实体提供了五种不同的访问级别

    open 为最高访问级别(限制最少)
    private 为最低访问级别(限制最多)

内容说明
Open所修饰的属性或方法在源代码所在的整个模块都可以访问。只能作用于类和类的成员,可以被任何人使用,包括重写和继承
Public可以被任何人使用。但其他模块中不可以被重写和继承,而在本模块内可以被重写和继承
Internal所修饰的属性或方法在源代码所在的整个模块都可以访问。如果是框架或者库代码,则在整个框架内部都可以访问,框架由外部代码所引用时,则不可以访问。如果是App代码,也是在整个App代码,也是在整个App内部可以访问
File-private所修饰的属性或者方法在当前的源文件里可以访问
Private所修饰的属性或者方法只能在当前类里访问
  • 单个target应用程序的访问级别 当你编写一个单个的Target APP时,应用的所有功能都是为该应用服务,而不需要提供给其他应用或者模块使用,所以我们不需要明确设置访问级别,使用默认的访问级别 Internal 即可。但是,你也可以使用 fileprivate 访问或 private 访问级别,用于隐藏一些功能的实现细节

  • 框架的访问级别 当你开发框架时,就需要把一些对外的接口定义为 OpenPublic,以便使用者导入该框架后可以正常使用其功能。这些被你定义为对外的接口,就是这个框架的 API 框架依然会使用默认的 internal ,也可以指定为 fileprivate 访问或者 private 访问级别。当你想把某个实体作为框架的 API 的时候,需显式为其指定开放访问或公开访问级别

  • 单元测试 target 的访问级别 当你的应用程序包含单元测试 target 时,为了测试,测试模块需要访问应用程序模块中的代码。默认情况下只有 openpublic 级别的实体才可以被其他模块访问。然而,如果在导入应用程序模块的语句前使用 @testable 特性,然后在允许测试的编译设置(Build Options -> Enable Testability)下编译这个应用程序模块,单元测试目标就可以访问应用程序模块中所有内部级别的实体


访问控制语法

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

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

自定义类型

  • 如果想为一个自定义的类指定访问级别,在定义类时进行指定即可。新建的类只能在它的访问级别限制范围内使用
fileprivate class SomeFilePrivateClass {        
    func someFilePrivateMethod() {}              
    func somePrivateMethod() {}         
}

  • 一个类的访问级别也会影响到类型成员(属性、方法、构造器、下标)的默认访问级别。如果你将类指定为 private 或者 fileprivate 级别,那么该类的所有成员的默认访问级别也会变成 private 或者 fileprivate 级别,如果你将类指定为公开或者 internal (或者不明确指定访问级别,而使用默认的 internal ),那么该类型的所有成员的默认访问级别将是内部访问

  • 一个 public 类型的所有成员的访问级别默认为 internal 级别,而不是 public 级别。如果你想将某个成员指定为 public 级别,那么你必须显式指定。这样做的好处是,在你定义公共接口的时候,可以明确地选择哪些接口是需要公开的,哪些是内部使用的,避免不小心将内部使用的接口公开

public class SomePublicClass {                  // 显式 public 类
    public var somePublicProperty = 0            // 显式 public 类成员
    var someInternalProperty = 0                 // 隐式 internal 类成员
    fileprivate func someFilePrivateMethod() {}  // 显式 fileprivate 类成员
    private func somePrivateMethod() {}          // 显式 private 类成员
}

class SomeInternalClass {                       // 隐式 internal 类
    var someInternalProperty = 0                 // 隐式 internal 类成员
    fileprivate func someFilePrivateMethod() {}  // 显式 fileprivate 类成员
    private func somePrivateMethod() {}          // 显式 private 类成员
}

fileprivate class SomeFilePrivateClass {        // 显式 fileprivate 类
    func someFilePrivateMethod() {}              // 隐式 fileprivate 类成员
    private func somePrivateMethod() {}          // 显式 private 类成员
}

private class SomePrivateClass {                // 显式 private 类
    func somePrivateMethod() {}                  // 隐式 private 类成员
}
  • 元组类型 元组的访问级别将由元组中访问级别最严格的类型来决定,例如,如果你构建了一个包含两种不同类型的元组,其中一个类型为 internal,另一个类型为 private,那么这个元组的访问级别为 private
  • 函数类型 函数的访问级别根据访问级别最严格的参数类型或返回类型的访问级别来决定
  • 枚举类型 枚举成员的访问级别和该枚举类型相同,你不能为枚举成员单独指定不同的访问级别

子类

  • 子类的访问级别不得高于父类的访问级别,例如,父类的访问级别是 internal,子类的访问级别就不能是 public
  • 可以通过重写为继承来的类成员提供更高的访问级别
public class ClassA{
    fileprivate func run(){
        
    }
}

internal class ClassB:ClassA{
    override internal func run(){
        super.run()
    }
}

常量、变量、属性、下标

常量、变量、属性不能拥有比它们的类型更高的访问级别,比如定义一个public 级别的属性,那么它的访问级别不能是Internal


构造器

-自定义构造器的访问级别可以低于或等于其所属类的访问级别。唯一的例外是必要构造器,它的访问级别必须和所属类型的访问级别相同

  • 默认构造器的访问级别与所属类的访问级别相同,除非类的访问级别是 public。如果一个类型被指定为 public 级别,那么默认构造器的访问级别将为 internal。如果你希望一个 public 级别的类型也能在其他模块中使用这种无参数的默认构造器,你只能自己提供一个 public 访问级别的无参数构造器

协议

  • 如果想为一个协议明确地指定访问级别,在定义协议时指定即可。那么协议只能在限制的访问级别内使用
  • 协议继承中,如果定义了一个继承自其他协议的新协议,那么新协议拥有的访问级别最高也只能和被继承协议的访问级别相同。例如,你不能将继承自 internal 协议的新协议定义为 public 协议
  • 一个类型可以采纳比自身访问级别低的协议。例如,你可以定义一个 public 级别的类,它可以在其他模块中使用,同时它也可以采纳一个 internal 级别的协议,但是只能在该协议所在的模块中作为符合该协议的类使用

分类

  • 使用 extension 扩展了一个 public 或者 internal 类型,extension 中的成员就默认使用 internal 访问级别,和原始类型中的成员一致。如果你使用 extension 扩展了一个 private 类型,则 extension 的成员默认使用 private 访问级别
  • 使用 extension 来遵循协议的话,就不能显式地声明 extension 的访问级别。extension 每个 protocol 要求的实现都默认使用 protocol 的访问级别

泛型

泛型类型或泛型函数的访问级别取决于泛型类型或泛型函数本身的访问级别,还需结合类型参数的类型约束的访问级别,根据这些访问级别中的最低访问级别来确定