类、对象、接口、构造函数、方法与属性及其 setter 都可以有可见性修饰符。 getter 总是与属性有着相同的可见性。

在 Kotlin 中有这四个可见性修饰符：

  • private
  • protected
  • internal
  • public（默认）

在本页可以学到这些修饰符如何应用到不同类型的声明作用域。

包

函数、属性和类、对象和接口可以直接在包内的顶层声明：

  1. // 文件名：example.kt
  2. package foo
  4. fun baz() { …… }
  5. class Bar { …… }
  • 如果你不使用任何可见性修饰符，默认为 public，这意味着你的声明将随处可见。
  • 如果你声明为 private，它只会在声明它的文件内可见。
  • 如果你声明为 internal，它会在相同模块内随处可见。
  • protected 修饰符不适用于顶层声明。

⚠️ 注意：要使用另一包中可见的顶层声明，需要将其导入进来。

例如:

  1. // 文件名：example.kt
  2. package foo
  4. private fun foo() { …… } // 在 example.kt 内可见
  6. public var bar: Int = 5 // 该属性随处可见
  7.     private set         // setter 只在 example.kt 内可见
  9. internal val baz = 6    // 相同模块内可见

类成员

对于类内部声明的成员：

  • private 意味着只该成员在这个类内部（包含其所有成员）可见；
  • protected 意味着该成员具有与 private 一样的可见性，但也在子类中可见。
  • internal 意味着能见到类声明的本模块内的任何客户端都可见其 internal 成员。
  • public 移位置能见到类声明的任何客户端都可见其 public 成员。

⚠️注意：在 Kotlin 中，外部类不能访问内部类的 private 成员。

如果你覆盖一个 protected 或 internal 成员并且没有显式指定其可见性，该成员还会具有与原始成员相同的可见性。

例子:

  1. open class Outer {
  2.     private val a = 1
  3.     protected open val b = 2
  4.     internal open val c = 3
  5.     val d = 4  // 默认 public
  7.     protected class Nested {
  8.         public val e: Int = 5
  9.     }
  10. }
  12. class Subclass : Outer() {
  13.     // a 不可见
  14.     // b、c、d 可见
  15.     // Nested 和 e 可见
  17.     override val b = 5   // “b”为 protected
  18.     override val c = 7   // 'c' is internal
  19. }
  21. class Unrelated(o: Outer) {
  22.     // o.a、o.b 不可见
  23.     // o.c 和 o.d 可见（相同模块）
  24.     // Outer.Nested 不可见，Nested::e 也不可见
  25. }

构造函数

使用以下语法来指定一个类的的主构造函数的可见性：

You need to add an explicit constructor keyword.

  1. class C private constructor(a: Int) { …… }

这里的构造函数是私有的。默认情况下，所有构造函数都是 public，这实际上等于类可见的地方它就可见（即 一个 internal 类的构造函数只能在相同模块内可见).

局部声明

局部变量、函数和类不能有可见性修饰符。

模块

可见性修饰符 internal 意味着该成员只在相同模块内可见。更具体地说， 一个模块是编译在一起的一套 Kotlin 文件，例如：

  • 一个 IntelliJ IDEA 模块
  • 一个 Maven 项目
  • 一个 Gradle 源代码集（例外是 test 源代码集可以访问 main 的 internal 声明）
  • 一次 Ant 任务执行所编译的一套文件