kotlin 使用密封类去实现受限的继承结构,也就是规定了某一父类的子类只能是定义好的某几种类型。在这一特性上,等同于枚举值的作用。和枚举值不同的是,密封类还有类的属性,枚举值是固定的,一个枚举常量只存在一个枚举实例,但是密封类可能存在多个不同值的实例。
密封类/密封接口的主要使用场景是
- 简化 when 语句
- 密封接口可以避免调用方去实现你想要隐藏的接口
密封类
如何声明一个密封类
密封类是一个抽象类,父类声明为密封类,使用 sealed 关键字。其子类只能是 data class 或者 object,或者自己实现 equal 和 hashCode 方法的类。
//1.5 以前的写法
sealed class Fruit
//sealed 类的子类只能是 data class 或者 object
data class Apple(val price: Int) : Fruit()
object Orange : Fruit()
密封类如何使用
考虑一个场景,我们需要写一个函数去卖商品,每个商品有不同的折扣,如下:
//如果是非密封类
abstract class Product
class Tissue(val price: Int) : Product()
class Toothpaste(val price: Int) : Product()
fun settlementOther(product: Product): Int {
return when (product) {
is Tissue -> product.price - 3
is Toothpaste -> product.price
else -> 0
}
}
如果换成是密封类实现:
//1.5 以前的写法
sealed class Fruit
//sealed 类的子类只能是
data class Apple(val price: Int) : Fruit()
object Orange : Fruit()
//不需要 else 语句
fun settlementFruit(fruit: Fruit): Int {
//葡萄特价 10块
return when (fruit) {
is Apple -> fruit.price
Orange -> 10
}
}
则在 when 语句里面,不需要写 else 语句。
当然,枚举也是一样的,when 里面,不需要写 else 语句,但是枚举只能有一个实例,并且不方便使用。
密封类的使用注意
kotlin 的密封类和子类必须在同一个文件里面。这个限制在 1.5版本之后被解除,只要放在同一个 module 下即可以使用。
此外 kotlin 在 1.5 版本,更新了密封接口。密封接口提出来主要是解决以下问题
- 密封类多继承的问题
- 实现 final 性质的接口,也就是如果你的三方库的接口,不想被调用方直接使用,则可以定义为密封接口。
- 实现嵌套枚举
密封接口的使用示例如下:
open class Fresh
sealed interface Food
object Fruit : Food
//密封接口,帮助实现多继承
data class Meat(val type: Int) : Fresh(), Food
sealed interface MyInnerScaledInterface
如果在另一个包名下去实现密封类接口,则会报错如下:
//package com.example.review2.scaled
sealed interface MyInnerScaledInterface
//package com.example.review2.base 这里 IDE 会报错
class OutScaled:MyInnerScaledInterface {
}
报错信息如下:
Inheritor of sealed class or interface declared in package com.example.review2.base but it must be in package com.example.review2.scaled where base class is declared.
密封接口/类的实现原理
密封类的实现是 abstract 类,密封接口的实现是普通接口。只不过在when 语句中,编译器会帮忙处理if else 的情况,而不需要加 default。如下,通过 tools-kotlins-show kotlin bytecode 之后,查看:
//Fruit 是 kotlin 密封类
public abstract class Fruit {
private Fruit() {
}
}
//Fresh 是kotlin 密封接口
public interface Fresh {
}
//密封类的 when 语句实现
public static final int settlementFruit(@NotNull Fruit fruit) {
Intrinsics.checkNotNullParameter(fruit, "fruit");
int var10000;
if (fruit instanceof Apple) {
var10000 = ((Apple)fruit).getPrice();
} else {
if (!Intrinsics.areEqual(fruit, Orange.INSTANCE)) {
throw new NoWhenBranchMatchedException();
}
var10000 = 10;
}
return var10000;
}
//Product 是普通 abstract 类
public static final int settlementOther(@NotNull Product product) {
Intrinsics.checkNotNullParameter(product, "product");
return product instanceof Tissue ? ((Tissue)product).getPrice() : (product instanceof Toothpaste ? ((Toothpaste)product).getPrice() : 0);
}
java 使用密封类/接口
java 使用密封类会报错,如下。原因在于密封类的构造函数是私有的,所以java 没有默认构造函数,无法使用。
There is no default constructor available in 'review.Fruit'
java 使用密封接口也会报错,如下:
Java class cannot be a part of Kotlin sealed hierarchy
以上限制,仅仅在java 15 之后,java 更新了密封类之后,kotlin 的密封类才可以在 java 中使用。