在用 Scala 做业务开发的时候,我们大都会用到 case class 以及「模式匹配」,本文将介绍在日常开发中如何利用 case class 模拟 ADT 去良好地组织业务。
ADT(代数数据类型)
在计算机编程、特别是函数式编程与类型理论中,
ADT是一种composite type(组合类型)。例如,一个类型由其它类型组合而成。两个常见的代数类型是product(积)类型 (比如tuples和records)和sum(和)类型,它也被称为tagged unions或variant type。
这里简单介绍一下常见的两种代数类型 product(积)类型和 sum(和)类型
计数(Counting)
在介绍两种常见代数类型之前我们先介绍一下 「计数」 的概念,方面理解后面所要介绍的内容。
为了将某个类型与我们熟悉的数字代数相关联,我们可以计算该类型有多少种取值,例如 Haskell中的Bool 类型:
1 | data Bool = true | false |
可以看到 Bool 类型有两种可能的取值,要么是 false, 要么是 true, 所以这里我们暂时将数字 2 与 Bool 类型相关联。
如果 Bool 类型关联的是 2,那么何种类型是 1 呢,在 Scala 中 Unit 类型只有一种取值:
1 2 | scala> val a = () a: Unit = () |
所以这里我们将数字 1 与 Unit 类型相关联。
有了 「计数」 这个概念,接下来我们介绍常见的两种代数类型。
product
product 可以理解为是一种 组合(combination),可以通过我们熟悉的 *(乘法) 操作来产生,对应的类型为:
1 | data Mul a b = Mul a b |
也就是说, a * b 类型是同时持有 a 和 b 的容器。
在 Scala中,tuples(元组)就是这样的,例如:
1 2 | scala> val b = (Boolean, Boolean) b: (Boolean.type, Boolean.type) = (object scala.Boolean,object scala.Boolean) |
我们定义的元组 b 就是两个 Boolean 类型的组合,也就是说,元组 b 是同时拥有两个 Boolean 类型的容器,可以通过我们前面介绍的 「计数」 的概念来理解:
Boolean 类型有两种取值,当 Boolean 和 Boolean 通过 * 操作进行组合时:
1 | 2 * 2 = 4 |
所以我们定义的元组 b 有四种可能的取值,我们利用 「模式匹配」 来列举这四种取值:
1 2 3 4 5 6 | b match { case (true, true) => ??? case (true, false) => ??? case (false, true) => ??? case (false, false) => ??? } |
sum
sum 可以理解为是一种 alternation(选择),可以通过我们熟悉的 + 操作来产生,对应的类型为:
1 | data Add a b = AddL a | AddR b |
a + b 是一个和类型,同时拥有 a 或者 b。
注意这里是 a 或者 b,不同于上面介绍的 *。
这里可能就会有疑惑了,为什么 + 操作对应的语义是「或者」 呢,我们依然通过前面介绍的 「计数」 的概念来理解:
在 Scala 中 Option 就是一种 sum 类型,例如:
1 2 | scala> val c = Option(false) c: Option[Boolean] = Some(false) |
option[Boolean] 其实是 Boolean 与 None 通过 + 操作得到的,分析:
Boolean 有两种取值,None 只有一种,那么:
1 | 2 + 1 = 3 |
所以我们定义的 c: Option[Boolean] 有三种可能的取值,我们利用 「模式匹配」 来列举这三种取值:
1 2 3 4 5 | c match { case Some(true) => ??? case Some(false) => ??? case None => ??? } |
我们可以看到,Option[Boolean] 类型的取值要么是 Boolean 类型,要么是 None 类型,这两种类型是「不能同时」存在的,这一点与 product 类型不同。并且 sum 类型是一个「闭环」,类型的定义已经包含了所有可能性,绝无可能会出现非法状态。
在业务中使用 ADT
我们在利用 Scala 的 case class 组织业务的时候其实就已经用到了 ADT,例如:
1 2 3 | sealed trait Tree case class Node(left: Tree, right: Tree) extends Tree case class Leaf[A](value: A) extends Tree |
在上面 「树」 结构的定义中,Node、Leaf 通过继承 Tree,通过这种继承关系而得到的类型就是 ADT 中的 sum,而构造 Node 和 Leaf 的时候则是 ADT 中的 product。大家可以通过我们前面所说的 「计数」的概念来验证。
上面的代码中出现了一个关键字 sealed,我们先介绍一下这个关键字。
Sealed
前面我们说过 sum 类型是一个 「闭环」,当我们将「样例类」的「超类」声明为 sealed 后,该超类就变成了一个 「密封类」,「密封类」的子类都必须在与该密封类相同的文件中定义,从而达到了上面说的「闭环」的效果。
比如我们现在要为上面的 Tree 添加一个 EmptyLeaf:
1 | case object EmptyLeaf extends Tree |
那这段被添加的代码必须放在我们上面声明 Tree 的那个文件里面,否则会报错。
另外,sealed 关键字也可以让「编译器」检查「模式」语句的完整性,例如:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | sealed trait Answer case object Yes extends Answer case object No extends Answer val x: Answer = Yes x match { case Yes => println("Yes") } <console>: warning: match may not be exhaustive. It would fail on the following input: No x match { ^ |
「编译器」会在编译阶段提前给我们一个可能会出错的「警告(warning)」
利用 ADT 来良好地组织业务
前面说了这么多,终于进入正题了,接下来我们以几个例子来说明如何在开发中合理地利用 ADT。
场景一
现在我们要开发一个与「优惠券」有关的业务,一般情况下,我们可能会这么去定义优惠券的结构:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | case class Coupon ( id: Long, baseInfo: BaseInfo, `type`: String, ... ) object Coupon { //优惠券类型 object Type { // 现金券 final val CashType = "CASH" //折扣券 final val DiscountType = "DISCOUNT" // 礼品券 final val GiftType = "GIFT" } } |
分析:这样去定义 「优惠券」 的结构也能解决问题,但是当 「优惠券」 类型增多的时候,会出现很多的冗余数据。比如说,不同的优惠类型,会有不同优惠信息,这些优惠信息在结构中对应的字段也会有所不同:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | case class Coupon ( id: Long, baseInfo: BaseInfo, `type`: String, // 仅在优惠券类型是代金券的时候使用 leastCost: Option[Long], reduceCost: Option[Long], //仅在优惠券类型是折扣券的时候使用 discount: Option[Int], //仅在优惠券是礼品券的时候使用 gift: Option[String] ) |
从上定义的结构我们可以看到,当我们使用 「礼品券」 的时候,有三个字段(leastCost、reduceCost、discount)的值是 None,因为我们根本就用不到。由此可以看出,当 「优惠券」 的结构比较复杂的时候,可能会产生大量的冗余字段,从而使我们的代码看上去非常臃肿,同时增加了我们的开发难度。
利用 ADT 重新组织:
分析:通过上面的讨论,我们知道 「优惠券」 可能有多种类型,所以,我们利用 ADT 将不同的「优惠券」分离开来:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | // 将每一种优惠券公共的部分抽离出来 sealed trait Coupon { val id: Long val baseInfo: BaseInfo val status: Int val `type`: String ... } case class CashCoupon ( id: Long, baseInfo: BaseInfo, `type`: String = Coupon.Type.CashType, status: Int, leastCost: Long, reduceCost: Long, ... ) extends Coupon case class DiscountCoupon ( id: Long, baseInfo: BaseInfo, `type`: String = Coupon.Type.DiscountType, status: Int, discount: Int, ... ) extends Coupon case class GiftCoupon ( id: Long, baseInfo: BaseInfo, `type`: String = Coupon.Type.GiftType, status: Int, gift: String, ... ) extends Coupon |
同过合理地利用 ADT 我们使每一种「优惠券」的结构更加清晰,同时也减少了字段的冗余。并且,如果在业务后期我们还要增加别的 「优惠券」类型,我们不用修改原来的结构,只需要再重新创建一个新的 case class 就可以了:
比如我们在后期增加了一种叫 「团购券」 的优惠券,我们不需要修改原来定义的结构,直接:
1 2 3 4 5 6 7 | case class GroupCoupon ( id: Long, baseInfo: BaseInfo, `type`: String, status: Int, dealDetail: String ) |
并且在利用「模式匹配」的时候,我们可以像操作代数那样:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | coupon match { case c: CashCoupon => ??? // 我们可以直接在匹配完成之后使用 coupon case c: DiscountCoupon => ??? case c: GiftCoupon => ??? case c: GroupCoupon => ??? } // 如果是我们用 ADT 改造前的数据结构,那模式匹配就会变成: coupon.`type` match { case Coupon.Type.CashType => ??? // 我们只能使用 coupon.`type` case Coupon.Type.GiftType => ??? case Coupon.Type.DiscountType => ??? case Coupon.Type.GroupCoupon => ??? } |
通过本例,我们可以看到,利用 ADT 重新组织之后的数据结构减少了数据的冗余,并且在使用「模式匹配」的时候更加清晰,在功能上也更加强大。
场景二
针对上面的优惠券,用户在使用这些优惠券的时候,优惠券会存在不同的几种状态:
未领取
已领取但暂未使用
已使用
过期优惠券
无效优惠券
我们现在想要根据这几种不同的状态渲染出不同的结果页面,要得到这几种状态,我们通常会:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | def fetched(c: Coupon, user: User) = { //根据coupon信息以及user信息去查询用户是否已经领取了这张优惠券 ??? } def used(c: Coupon, user: User) = { //根据coupon信息以及user信息去查询用户是否已经使用了这张优惠券 ??? } def isExpired(c: Coupon) = { //根据优惠券信息来判断优惠券是否已经过期 ??? } def isAviable(c: Coupon) = { //根据优惠券信息来判断优惠券是否已经失效 ??? } |
我们现在就利用这些状态去渲染页面:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | def f(c: Coupon, user: User) = { if (!isAviable(coupon)) { if (!isExpired(coupon)) { if (used(coupon, user)) { //已使用的优惠券 ??? } else { if (fetched(coupon, user)) { //已领取但未使用的优惠券 ??? } else { //未领取的优惠券 ??? } } } else { //已过期的优惠券 ??? } } else { //已失效的优惠券 ??? } } |
上面的代码能够完成我们的需求,但是,当优惠券的状态变多的时候,该方法传入的参数也会有所变化,「if-else」语句层级也会越多,非常容易出错,同时代码表达的意思也没那么明确,可读性极差。
所以我们能否重新组织一下数据结构,使之能够利用「模式匹配」?
利用 ADT 重新组织:
分析:我们在使用优惠券的时候无非就是判断这几种「状态」,那我们就利用 ADT 将这些状态抽象化:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | sealed trait CouponStatus { //每种状态共用的一些信息 val base: CouponStatusBase } case class CouponStatusBase ( coupon: Coupon, ... ) //未领取 case class StatusNotFetched ( base: CouponStatusBase ) extends CouponStatus //已领取但未使用 case class StatusFetched ( base: CouponStatusBase, user: User ) extends CouponStatus //已使用 case class StatusUsed ( base: CouponStatusBase, user: User ) extends CouponStatus //过期优惠券 case class StatusExpired ( base: CouponStatusBase ) extends CouponStatus |