Kotlin 中的包保护替代方案

Question

在 Java 中，我们为类提供了 package protected（默认）修饰符，它允许我们在一个包中拥有多个类，但只公开少数几个类并保持逻辑封装。

对于 Kotlin，情况似乎并非如此。如果我想让一些类彼此可见但不再可见，我必须使用私有修饰符来限制对单个文件的可见性。

因此，如果您希望一个包中有 10 个类，但只有其中一个是公开的，那么您必须拥有一个包含所有类的大文件（并且到处都是 private）。

这是正常的做法还是有办法在 Kotlin 中实现一些类似的模块化？

我不明白：如果他们有包的概念，为什么他们要摆脱包保护访问？

更新：毕竟我们可能拥有包保护的可见性
see the discussion here

更新：如果您阅读讨论后仍然认为这是该语言的必备功能，请投票here

Answer 1

与 Java 相比，Kotlin 似乎在较小程度上依赖包模型（例如，目录结构不绑定到包）。相反，Kotlin 提供了internal visibility，它专为模块化项目架构而设计。使用它，您可以将部分代码封装在单独的module 中。

因此，您可以在顶级声明中使用

• private 限制对文件的可见性
• internal 限制对模块的可见性

此时，没有其他可见性限制选项。

Answer 2

作为我在 android 上的解决方法，我创建了 @PackagePrivate 注释和 lint 检查来控制访问。 Here你可以找到项目。

Lint 检查显然不像编译器检查那么严格，并且需要一些设置才能使构建失败。但是 android studio 会自动进行 lint 检查，并在输入时立即显示错误。不幸的是，我不知道如何从自动完成功能中排除带注释的成员。

此外，由于 lint 是一个纯粹的编译时工具，因此不会在运行时进行检查。

Answer 3

正如@hotkeys 指出的那样，您可以在module 中使用internal 关键字，或者您可以将原本属于一个包中的所有类放在一个文件中，但是在一个文件中粘贴多个类可能是有问题的设计决定。

对我来说，package 可见性有助于其记录价值。我想知道某个包向项目的其余部分展示了什么公共接口，隐藏工厂实现类等等。

所以即使可以在 Java 中访问包私有的类和方法，我仍然选择使用 package 修饰符。

为此，我创建了一个带有单个注释的项目：

package com.mycompany.libraries.kotlinannotations;

import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.SOURCE;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Documented
@Retention(SOURCE)
@Target({ TYPE, METHOD, CONSTRUCTOR })
/**
 * Use in Kotlin code for documentation purposes. 
 * 
 * Whenever a Kotlin class or method is intended to be accesible at package level only.
 *
 */
public @interface PackagePrivate {

}

然后我可以在任何 Kotlin 项目中使用这个注解。

我还没有完成的第二步是创建一个 PMD 规则，以使用 maven（或任何其他构建工具）强制执行此操作，并且还能够在我的 IDE 中使用pmd 插件。

pmdat this moment 中没有完整的 Kotlin 支持，但在某些时候似乎是可以预料的。

Answer 4

基于包的保护在 Kotlin 中毫无意义，因为包本身不受保护

在 Java 中，包与目录结构相关联。因此，如果您将您的课程放在com\example\yoursecretengine 中，那么任何（故意或意外）添加流氓课程的尝试都会很容易引起注意。这就是我们所依赖的安全性。

Kotlin 消除了目录和包之间的联系，因此我可以将我的类放在“我的”目录中（例如src\java\pl\agent_l\illegalaccess），同时将其包声明为com.example.yoursecretengine - 并获得对您所指的所有属性的访问权限作为包私有。

事实上，Kotlin 项目无需任何包声明即可完美运行。这只是强调软件包“您称之为指南而不是实际规则”。它们是一种便利功能，仅对整理命名空间有用，仅此而已。

相关quotes from kotlinlang：

与许多其他语言不同，Kotlin 包不需要文件具有任何特定位置 w.r.t。本身;文件与其包之间的连接仅通过包头建立。

还有：

文件中没有包头意味着它属于特殊的根包。