data class 和 seal class

Kotlin 中的 data class

在使用 java 的时候,我们经常会重写类的 equalshashCodetoString 方法。这些方法往往都是模板化的。在 kotlin 中提供了更为简便的方法让我们使用一行代码搞定这些工作。这就是 data class

// 定义一个 Person 类
data class Person(val name: String, val age: Int) {
}

写好上面的代码之后,Person 类中的上述几个方法的重写就由 kotlin 帮我们自动完成了。运行下面的代码

fun main() {
    val p1 = Person("Jack", 24)
    val p2 = Person("Jack", 24)

    val p3 = Person("Jack", 32)
    val p4 = Person("Rose", 31)

    println(p1 == p2) 

    println(p1 === p2)

    println(p1 == p3)

    println("""
        p1 hashCode = ${p1.hashCode()}
        p2 hashCode = ${p2.hashCode()}
        p3 hashCode = ${p3.hashCode()}
        p4 hashCode = ${p4.hashCode()}
    """.trimIndent())

    println("p1 = $p1")
}

结果如下:

true
false
false
p1 hashCode = 71328761
p2 hashCode = 71328761
p3 hashCode = 71328769
p4 hashCode = 79149200
p1 = Person(name=Jack, age=24)

可以看到equalshashCodetoString 方法可以直接调用,并且已经被覆写了。

data class 究竟做了什么?

data class 是如何做到上述实现的呢?查看 Person 类的字节码反编译得到的 java 代码,如下

public final class Person {
   @NotNull
   private final String name;
   private final int age;

   @NotNull
   public final String getName() {
      return this.name;
   }

   public final int getAge() {
      return this.age;
   }

   public Person(@NotNull String name, int age) {
      Intrinsics.checkParameterIsNotNull(name, "name");
      super();
      this.name = name;
      this.age = age;
   }

   @NotNull
   public final String component1() {
      return this.name;
   }

   public final int component2() {
      return this.age;
   }

   @NotNull
   public final Person copy(@NotNull String name, int age) {
      Intrinsics.checkParameterIsNotNull(name, "name");
      return new Person(name, age);
   }

   // $FF: synthetic method
   public static Person copy$default(Person var0, String var1, int var2, int var3, Object var4) {
      if ((var3 & 1) != 0) {
         var1 = var0.name;
      }

      if ((var3 & 2) != 0) {
         var2 = var0.age;
      }

      return var0.copy(var1, var2);
   }

   @NotNull
   public String toString() {
      return "Person(name=" + this.name + ", age=" + this.age + ")";
   }

   public int hashCode() {
      String var10000 = this.name;
      return (var10000 != null ? var10000.hashCode() : 0) * 31 + this.age;
   }

   public boolean equals(@Nullable Object var1) {
      if (this != var1) {
         if (var1 instanceof Person) {
            Person var2 = (Person)var1;
            if (Intrinsics.areEqual(this.name, var2.name) && this.age == var2.age) {
               return true;
            }
         }

         return false;
      } else {
         return true;
      }
   }
}

从上面可以一目了然地看见 kotlin 是如何构造 data class 的。由于我定义的成员变量是 val 不可变类型的,所以没有 Getter 和 Setter。

  • 对于equals 方法,对于 var1 , 如果它的地址和自己不同,那么先检查其是否是 Person 类型 ,如果是,则逐个对比每个成员变量是否相等。这里用到的 Intrinsics.areEqual(Object o1, Object o2) 定义如下:

    public static boolean areEqual(Object first, Object second) {
          return first == null ? second == null : first.equals(second);
      }
    
    

    最终调用了被比较对象的 equals 方法。 对于 Int 类型的成员变量 age , 直接使用 == 比较。

    这是覆写一个类的 equals 方法的常规写法。

  • hashCodetoString 方法也是我们常规覆写的套路。

  • 提供了 component1component2 两个方法来获取成员变量。这两个方法可以用来做解构声明。如下:

    val (name, age) = Person("Rose", 43) 
    println("$name, $age")
    // (name, age) 就是解构声明,name 对应 component1 , age 对应 component2 
    
    
  • 提供了 copy 方法构造一个 Person 对象。有 // FF: synthetic method 注释的 `copydefault` 方法是给 kotlin 编译器调用的,我们用不到。
    注意 copy 是浅拷贝,且参数需要在 primary constructor 里面才会拷贝

    如果我们只想要 age 不同的 Person , 可以这样写

      val newPerson = p1.copy(age = 30)
    
    

    编译器编译到这句代码时,会帮我们调用 copy$default 来构造一个 name 值和 p1 一样的 newPerson 对象 。

总之, data class 就是用常规套路来生成一个已经覆写好上述方法的类。

如果 Person 类不需要自动生成 age ,只需要把 age 从主构造函数中拿出,放到类体中就可以。如下

data class Person(val name: String) {
    val age: Int = 0
}

Kotlin 中的 sealed class

  • 枚举不支持泛型,数据不灵活
  • 枚举限制每个类型只允许有一个实例
enum class Color(val value: Int) {
    Red(1)
}

fun main(args: Array<String>) {
    val red1 = Color.Red
    val red2 = Color.Red
    println("${red1 == red2}") // true
}

最后输出结果
red1 == red2 : true

无论 Color.Red 有多少个对象,最终他们的实例都是一个,每个枚举常量仅作为一个实例存在,而一个密封类的子类可以有多个包含状态的实例,这既是枚举的局限性也是枚举的优点。

sealed class 是一种同时拥有枚举类 enum 和 普通类 class 特性的类,叫做密封类。使用起来很简单,如下

sealed class Result
class Success(val code: Int) : Result()
class Exception(val code: Int, val message: String) : Result()

在同一个 kotlin 文件中声明三个类。首先声明 sealed classResult, 然后定义出两个子类 Success, Exception 继承自 Result。注意,密封类及其子类必须声明在同一个 kotlin 文件中。

这是一个非常常见的场景。比如对于网络请求的结果 Result , 往往只有两种类型,成功 Success 或者是失败 Exception 。使用普通的类不能把限制关系表达出来,使用枚举类则无法灵活地自定义需要的类的内容。这时候,sealed class 就派上用场了。比如在处理结果 Result 的时候:

fun handleResult(result: Result): String{
    return when(result) {
        is Success -> {
            "success"
        }
        is Exception -> {
            "exception"
        }
    }
}

这样,对于 handleResult 的入参就做了类型的限制,防止传入类型不匹配的参数。

还有一个好处是,使用密封类的话,when 表达式可以覆盖所有情况,不需要再添加 else 语句(表达式即有返回值的 when , 没有返回值的称为 when 语句)。

sealed class 究竟做了什么?

同样地,让我们来看看 sealed class 在 java 层面做了什么,实现了前面的效果。 上述密封类反编译得到的 java 代码如下:

public final class Exception extends Result {
   private final int code;
   @NotNull
   private final String message;

   public final int getCode() {
      return this.code;
   }

   @NotNull
   public final String getMessage() {
      return this.message;
   }

   public Exception(int code, @NotNull String message) {
      Intrinsics.checkParameterIsNotNull(message, "message");
      super((DefaultConstructorMarker)null);
      this.code = code;
      this.message = message;
   }
}
// Success.java
import kotlin.Metadata;
import kotlin.jvm.internal.DefaultConstructorMarker;
public final class Success extends Result {
   private final int code;

   public final int getCode() {
      return this.code;
   }

   public Success(int code) {
      super((DefaultConstructorMarker)null);
      this.code = code;
   }
}
// Result.java
import kotlin.Metadata;
import kotlin.jvm.internal.DefaultConstructorMarker;
// 最重要的地方
public abstract class Result {
   private Result() {
   }

   // $FF: synthetic method
   public Result(DefaultConstructorMarker $constructor_marker) {
      this();
   }
}

可以看到,Result 类其实是一个抽象类,SuccessException 继承了这个抽象类。
Result 类的构造函数是私有的,不能在外部访问到

通过继承这个抽象类,达到限制类型的做法。

这其实和 java 中使用接口来限定参数类型的做法类似,很好理解

总结

枚举的局限性

  • 限制枚举每个类型只允许有一个实例
  • 限制所有枚举常量使用相同的类型的值

抽象类的局限性

对于一个抽象类我们可以用一些子类去继承它,但是子类不是固定的,它可以随意扩展,同时也失去枚举常量受限性。

枚举作为单例的优点

是否只有一个实例 是否反序列化 是否是线程安全 是否是懒加载

Sealed Classes 是什么?

Sealed 是一个 abstract 类,它本身是不能被实例化,只能用它的子类实例化对象。Sealed 的构造方法私有化,禁止在 Sealed 所定义的文件外使用。

  • Sealed Classes 用于表示受限制的类层次结构
  • 从某种意义上说,Sealed Classes 是枚举类的扩展
  • 枚举的不同之处在于,每个枚举常量仅作为单个实例存在,而 Sealed Classes 的子类可以表示不同状态的实例。

在什么情况下使用枚举或者 Sealed?

  • 如果涉及反序列化创建对象的时候,建议使用枚举,因为 Java 规定,枚举的序列化和反序列化是有特殊定制的,因此禁用编译器使用 writeObjectreadObjectreadObjectNoDatawriteReplacereadResolve 等方法。

  • 如果你不需要多次实例化,也不需要不提供特殊行为,或者也不需要添加额外的信息,仅作为单个实例存在,这个时候使用枚举更加合适

  • 其他情况下使用 Sealed Classes,在一定程度上可以使用 Sealed Classes 代替枚举

快捷键

自动补全 when 语句下的所有分支
Alt + Enter ---> Add remaining braches

原文
https://juejin.cn/post/6844904163835396103
https://juejin.cn/post/6859980718588575757

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容