Kotlin嵌套类可见性控制技巧

欢迎各位小伙伴来到golang学习网，相聚于此都是缘哈哈哈！今天我给大家带来《Kotlin嵌套类可见性与实例控制：实现父类专属创建与外部受限访问》，这篇文章主要讲到等等知识，如果你对文章相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

本文探讨了Kotlin中如何实现一种特殊的嵌套类封装模式：该嵌套类仅能由其外部类创建，但其实例可以被外部公开访问。通过对比Java的实现方式，详细阐述了Kotlin中private、inner关键字以及接口在控制嵌套类可见性和实例化方面的应用，提供了多种解决方案及示例代码，旨在帮助开发者根据具体需求选择最合适的封装策略。

1. 问题背景与Kotlin private 类的限制

在软件设计中，我们常遇到需要将某个类（例如 Point）紧密绑定到另一个类（例如 Sphere）的需求。我们希望 Point 对象只能由 Sphere 类内部创建和管理，但 Sphere 的公共方法可以返回 Point 实例供外部使用。外部代码可以访问 Point 实例的公共属性，但不能直接创建新的 Point 对象。

然而，在Kotlin中，如果我们将一个嵌套类声明为 private，例如 private class Point(...)，并尝试通过外部类的公共属性或函数暴露它的实例，编译器会报错：'public' property exposes its 'private-in-class' type argument Point 或 'public' function exposes its 'private-in-class' return type argument Point。

class Sphere(val radius: Double = 1.toDouble()) {

    // 编译错误：'public' property exposes its 'private-in-class' type argument Point
    var pointsLinkedHashSet: LinkedHashSet<Point> = linkedSetOf()

    // 编译错误：'public' function exposes its 'private-in-class' return type argument Point
    fun getPoints(): LinkedHashSet<Point> {
        return pointsLinkedHashSet
    }

    fun addPoint(latitude: Double, longitude: Double): Point {
        val point = Point(this.radius, latitude, longitude)
        pointsLinkedHashSet.add(point)
        return point
    }

    private class Point( // private class
        val radius: Double,
        val latitude: Double,
        val longitude: Double
    )
}

这是因为 private 关键字在Kotlin中意味着该类仅在声明它的文件内部可见。如果一个公共成员（如 pointsLinkedHashSet 或 addPoint 方法）的类型参数或返回类型是 private 类，那么这个公共成员就试图暴露一个外部不可见的类型，这违反了可见性规则。

2. Java的实现方式与Kotlin的对应概念

在Java中，实现这种模式相对直接：使用一个非静态的内部类（即没有 static 关键字的嵌套类），并将其构造函数声明为 private。

// Java 示例
public class Sphere {
    private final Double radius;
    private final LinkedHashSet<Point> pointsLinkedHashSet = new LinkedHashSet<>();

    public Sphere(Double radius) {
        this.radius = radius;
    }

    public Point addPoint(Double latitude, Double longitude) {
        Point point = new Point(latitude, longitude); // 外部类可以调用私有构造函数
        pointsLinkedHashSet.add(point);
        return point;
    }

    // 非静态内部类，默认可访问外部类成员
    class Point {
        private final Double radius;
        private final Double latitude;
        private final Double longitude;

        // 私有构造函数，外部无法直接创建 Point 实例
        private Point(Double latitude, Double longitude) {
            this.radius = Sphere.this.radius; // 访问外部类的 radius
            this.latitude = latitude;
            this.longitude = longitude;
        }

        // 公共 getter 方法
        public Double getRadius() { return radius; }
        public Double getLatitude() { return latitude; }
        public Double getLongitude() { return longitude; }
    }
}

// Java 外部调用示例
public class Main {
    public static void main(String[] args) {
        Sphere sphere = new Sphere(1.0);
        Sphere.Point point = sphere.addPoint(10.0, 20.0); // 可以获取 Point 实例
        System.out.println(point.getLatitude()); // 可以访问 Point 属性

        // Sphere.Point newPoint = new Sphere.Point(30.0, 40.0); // 编译错误：构造函数私有
    }
}

在Kotlin中，nested class 默认是静态的（类似于Java的 static 嵌套类），不持有外部类的引用。要实现Java非静态内部类的行为，需要使用 inner 关键字。

Kotlin 嵌套类修饰符对比 Java：

	绑定到外部类实例 (inner / 非静态)	独立于外部实例 (nested / 静态)
Java	无关键字	static
Kotlin	inner	无关键字

3. Kotlin 实现方案

为了在Kotlin中达到类似Java的封装效果，我们需要结合 inner 关键字和构造函数的可见性修饰符。

3.1 方案一：使用 inner class 和 private 构造函数

这是最接近Java实现的方式，允许外部类创建并返回 Point 实例，同时阻止外部直接创建 Point 实例。

1. 将 Point 声明为 inner class： 这使得 Point 实例持有对其外部 Sphere 实例的引用，可以访问 Sphere 的成员（如 radius）。
2. 将 Point 类的构造函数声明为 private： 这将限制 Point 实例的创建，只有 Sphere 类内部才能调用此构造函数。
3. Point 类本身必须是 public： 因为 Sphere 的公共方法需要返回 Point 类型的实例。

class Sphere(val radius: Double = 1.toDouble()) {

    val pointsLinkedHashSet: LinkedHashSet<Point> = linkedSetOf()

    fun getPoints(): LinkedHashSet<Point> {
        return pointsLinkedHashSet
    }

    fun getLastPoint(): Point? = pointsLinkedHashSet.lastOrNull()

    fun clearPoints() = pointsLinkedHashSet.clear()

    fun addPoint(latitude: Double, longitude: Double): Point {
        // Sphere 内部可以调用 Point 的私有构造函数
        val point = Point(latitude, longitude)
        pointsLinkedHashSet.add(point)
        return point
    }

    // Point 必须是 public (默认) 才能被 public 函数返回
    inner class Point private constructor( // 私有构造函数
        val latitude: Double,
        val longitude: Double
    ) {
        // Point 实例可以访问外部类的 radius
        val radius: Double = this@Sphere.radius

        override fun toString(): String {
            return "Point(radius=$radius, latitude=$latitude, longitude=$longitude)"
        }
    }
}

// 外部调用示例
fun main() {
    val sphere = Sphere(1.0)
    println("Sphere radius = ${sphere.radius}")

    // 外部可以通过 Sphere 方法获取 Point 实例
    val point = sphere.addPoint(10.0, 20.0)
    println("Point: $point")
    println("Point radius = ${point.radius}")
    println("Point latitude = ${point.latitude}")

    val point1 = sphere.getLastPoint()
    println("Point1: $point1")

    // 编译错误：Cannot access '<init>': it is private in 'Point'
    // val newPoint = Sphere.Point(30.0, 40.0)

    // 编译错误：Cannot access '<init>': it is private in 'Point'
    // val newPointFromInstance = sphere.Point(30.0, 40.0)
}

解析：

• inner class Point 使得 Point 实例与 Sphere 实例绑定，并且 Point 内部可以直接访问 this@Sphere.radius。
• private constructor(...) 确保了 Point 只能由 Sphere 类内部通过 addPoint 方法创建。
• Point 类本身是 public 的（Kotlin默认可见性），因此它可以作为 addPoint 的返回类型，外部代码可以接收 Point 实例并访问其公共属性（radius, latitude, longitude）。

3.2 方案二：使用接口实现更深层次的类型封装

如果你的目标是不仅限制 Point 的实例化，而且完全隐藏 Point 的具体实现类型，只暴露其行为，那么使用接口是更强大的方式。

1. 定义一个公共接口（IPoint）： 包含 Point 实例需要暴露给外部的所有属性和方法。
2. 将 Point 类声明为 private 或 internal： 这样 Point 的具体实现就对外部不可见。
3. Point 类实现 IPoint 接口。
4. Sphere 的公共方法返回 IPoint 类型而不是 Point 类型。

interface IPoint {
    val radius: Double
    val latitude: Double
    val longitude: Double
}

class Sphere(val radius: Double = 1.toDouble()) {

    private val pointsLinkedHashSet: LinkedHashSet<Point> = linkedSetOf()

    fun getPoints(): LinkedHashSet<IPoint> { // 返回接口类型
        return LinkedHashSet(pointsLinkedHashSet) // 返回副本，避免外部修改内部集合
    }

    fun getLastPoint(): IPoint? = pointsLinkedHashSet.lastOrNull() // 返回接口类型

    fun clearPoints() = pointsLinkedHashSet.clear()

    fun addPoint(latitude: Double, longitude: Double): IPoint { // 返回接口类型
        val point = Point(latitude, longitude)
        pointsLinkedHashSet.add(point)
        return point
    }

    // private class Point，对外部完全隐藏具体实现
    private inner class Point(
        override val latitude: Double,
        override val longitude: Double
    ) : IPoint { // 实现 IPoint 接口
        override val radius: Double = this@Sphere.radius

        override fun toString(): String {
            return "Point(radius=$radius, latitude=$latitude, longitude=$longitude)"
        }
    }
}

// 外部调用示例
fun main() {
    val sphere = Sphere(1.0)
    val point: IPoint = sphere.addPoint(10.0, 20.0) // 接收 IPoint 接口
    println("Point radius = ${point.radius}")
    println("Point latitude = ${point.latitude}")

    val lastPoint: IPoint? = sphere.getLastPoint()
    println("Last Point radius = ${lastPoint?.radius}")

    // 编译错误：Cannot access 'Point': it is private in 'Sphere'
    // val newPoint = Sphere.Point(30.0, 40.0)

    // 编译错误：Unresolved reference: Point
    // val concretePoint: Sphere.Point = sphere.addPoint(50.0, 60.0) as Sphere.Point
}

解析：

• IPoint 接口定义了外部可见的契约。
• private inner class Point 确保 Point 的具体实现完全封装在 Sphere 内部，外部无法直接访问 Point 类型。
• Sphere 的公共方法只返回 IPoint 接口，强制外部只能通过接口定义的行为与 Point 实例交互。

4. 注意事项与总结

• 可见性修饰符： 理解 private（文件内可见）、internal（模块内可见）、public（全局可见）以及它们在类和构造函数上的应用至关重要。
• inner 与 nested： inner 类持有外部类实例的引用，可以访问外部类的成员。nested 类（默认）是独立的，类似于Java的 static 嵌套类。
• 选择合适的方案：
  • 如果只是想限制嵌套类的直接实例化，但允许外部知道并使用该类型（例如，进行类型检查或访问公共属性），那么方案一 (inner class + private constructor) 是合适的。
  • 如果需要更强的封装，完全隐藏嵌套类的具体实现类型，只暴露其行为接口，那么方案二（接口 + private inner class） 是更好的选择。
• Kotlin的 internal 修饰符： 如果你的需求是限制嵌套类及其构造函数在整个模块内部可见，而不是文件级别，可以使用 internal 修饰符。例如，internal class Point internal constructor(...)。但这通常不如 private 构造函数或接口方案那样精细地控制单个类的实例化。

通过上述讨论和示例，你应该能够根据具体的封装需求，在Kotlin中灵活地控制嵌套类的可见性和实例化行为，实现既能有效封装内部逻辑，又能提供受控外部访问的健壮设计。

到这里，我们也就讲完了《Kotlin嵌套类可见性控制技巧》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！