Scala：如何为任何情况class定义一个抽象的可复制超级class？
Scala: how to define an abstract copyable superclass for any case class?
请耐心等待，在 OP 有意义之前还有一些上下文。我正在使用 Slick 3.1.x 和 slick 代码生成器。 btw 完整的源代码可以在 play-authenticate-usage-scala github project 中找到。对于这个项目，我想要一个灵活的通用 Dao 以避免为每个模型重复相同的样板代码。
我有一个 postgres sql 脚本，它在此处使用 evolutions 创建数据库：
1.sql
然后我调用生成以下数据模型的生成器：
Tables.scala
为了能够为模型 classes 提供通用的 dao slick 实现，我需要它们遵守一些基本的抽象，例如
- Entity 特征：每个实体都有一个
id 例如dao 需要 findById
- AutoIncEntity 特征声明方法
def copyWithNewId(id : PK) : Entity[PK]。这是 dao 实现 createAndFetch 所必需的，它持久化一个新实体并一步检索自动生成的 id PK。
这个copyWithNewId是OP的重点。请注意，它被称为 copyWithNewId 而不是 copy 以避免无限递归。为了能够实现允许插入并立即获取自动生成的 id 的 GenericDaoAutoIncImpl，实体行需要一个来自 <Model>Row 案例 class 的 copy(id = id) 方法] 在定义 GenericDaoAutoIncImpl 时还不知道。相关实现如下：
override def createAndFetch(entity: E): Future[Option[E]] = {
val insertQuery = tableQuery returning tableQuery.map(_.id)
into ((row, id) => row.copyWithNewId(id))
db.run((insertQuery += entity).flatMap(row => findById(row.id)))
}
这要求我在每个 AutoInc id 生成的模型中实现 copyWithNewId 方法，这并不好，例如
// generated code and modified later to adapt it for the generic dao
case class UserRow(id: Long, ...) extends AutoIncEntity[Long] with Subject {
override def copyWithNewId(id : Long) : Entity[Long] = this.copy(id = id)
}
但是，如果我可以 - 使用一些 Scala 技巧 - 定义我的 <Model>Row 案例 classes subclass 是可复制的 Base class 并复制自身，除了对于已通过的 id 即IdCopyable 和 copy(id = id) 那么我就不需要为每个 <Model>Row 生成的案例 class.
一遍又一遍地实施这个 copyWithNewId
对于任何包含 id 属性的 class 情况，是否有抽象或 "pull up" 重构 copy(id = id) 的方法？还有其他推荐的解决方案吗？
更新 1 以下几乎概括了我遇到的问题：
scala> abstract class BaseA[A <: BaseA[_]] { def copy(id : Int) : A }
defined class BaseA
scala> case class A(id: Int) extends BaseA[A]
<console>:12: error: class A needs to be abstract, since method copy in class BaseA of type (id: Int)A is not defined
case class A(id: Int) extends BaseA[A]
^
scala> case class A(id: Int); val a = A(5); a.copy(6)
defined class A
a: A = A(5)
res0: A = A(6)
更新 2 使用下面建议的解决方案我得到以下编译错误：
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:26: could not find implicit value for parameter gen: shapeless.Generic.Aux[E,Repr]
[error] val insertQuery = tableQuery returning tableQuery.map(_.id) into ((row, id) => row.copyWithNewId(id))
[error] ^
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:27: value id is not a member of insertQuery.SingleInsertResult
[error] db.run((insertQuery += entity).flatMap(row => findById(row.id)))
[error] ^
[error] two errors found
更新 3 使用和调整下面建议的镜头解决方案我得到以下编译器错误：
import shapeless._, tag.@@
import shapeless._
import tag.$at$at
/**
* Identifyable base for all Strong Entity Model types
* @tparam PK Primary key type
* @tparam E Actual case class EntityRow type
*/
trait AutoIncEntity[PK, E <: AutoIncEntity[PK, E]] extends Entity[PK] { self: E =>
//------------------------------------------------------------------------
// public
//------------------------------------------------------------------------
/**
* Returns the entity with updated id as generated by the database
* @param id The entity id
* @return the entity with updated id as generated by the database
*/
def copyWithNewId(id : PK)(implicit mkLens: MkFieldLens.Aux[E, Symbol @@ Witness.`"id"`.T, PK]) : E = {
(lens[E] >> 'id).set(self)(id)
}
}
然后我得到以下编译器错误：
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:26: could not find implicit value for parameter mkLens: shapeless.MkFieldLens.Aux[E,shapeless.tag.@@[Symbol,String("id")],PK]
[error] val insertQuery = tableQuery returning tableQuery.map(_.id) into ((row, id) => row.copyWithNewId(id))
[error] ^
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:27: value id is not a member of insertQuery.SingleInsertResult
[error] db.run((insertQuery += entity).flatMap(row => findById(row.id)))
[error] ^
使用 shapeless 你可以对大小写 class 进行抽象。
1。手动抽象大小写 classes
如果您假设每个 id 都是一个 Long 并且是案例 class 的第一个参数，它可能看起来像这样：
scala> import shapeless._, ops.hlist.{IsHCons, Prepend}
import shapeless._
import ops.hlist.{IsHCons, Prepend}
scala> trait Copy[A <: Copy[A]] { self: A =>
| def copyWithId[Repr <: HList, Tail <: HList](l: Long)(
| implicit
| gen: Generic.Aux[A,Repr],
| cons: IsHCons.Aux[Repr,Long,Tail],
| prep: Prepend.Aux[Long :: HNil,Tail,Repr]
| ) = gen.from(prep(l :: HNil, cons.tail(gen.to(self))))
| }
defined trait Copy
scala> case class Foo(id: Long, s: String) extends Copy[Foo]
defined class Foo
scala> Foo(4L, "foo").copyWithId(5L)
res1: Foo = Foo(5,foo)
也可能以更简洁的方式实现；我还不是很精通无形编程。而且我 漂亮 确定也可以在参数列表中的任何位置使用任何类型的 id 的案例 class 执行此操作。 见下文第 2 段。
您可能希望将此逻辑封装在可重用的类型中class:
scala> :paste
// Entering paste mode (ctrl-D to finish)
import shapeless._, ops.hlist.{IsHCons, Prepend}
sealed trait IdCopy[A] {
def copyWithId(self: A, id: Long): A
}
object IdCopy {
def apply[A: IdCopy] = implicitly[IdCopy[A]]
implicit def mkIdCopy[A, Repr <: HList, Tail <: HList](
implicit
gen: Generic.Aux[A,Repr],
cons: IsHCons.Aux[Repr,Long,Tail],
prep: Prepend.Aux[Long :: HNil,Tail,Repr]
): IdCopy[A] =
new IdCopy[A] {
def copyWithId(self: A, id: Long): A =
gen.from(prep(id :: HNil, cons.tail(gen.to(self))))
}
}
// Exiting paste mode, now interpreting.
import shapeless._
import ops.hlist.{IsHCons, Prepend}
defined trait IdCopy
defined object IdCopy
scala> def copy[A: IdCopy](a: A, id: Long) = IdCopy[A].copyWithId(a, id)
copy: [A](a: A, id: Long)(implicit evidence: IdCopy[A])A
scala> case class Foo(id: Long, str: String)
defined class Foo
scala> copy(Foo(4L, "foo"), 5L)
res0: Foo = Foo(5,foo)
您仍然可以将 copyWithId 方法放在您的案例 classes 可以扩展的特征中，如果这对您很重要：
scala> trait Copy[A <: Copy[A]] { self: A =>
| def copyWithId(id: Long)(implicit copy: IdCopy[A]) = copy.copyWithId(self, id)
| }
defined trait Copy
scala> case class Foo(id: Long, str: String) extends Copy[Foo]
defined class Foo
scala> Foo(4L, "foo").copyWithId(5L)
res1: Foo = Foo(5,foo)
重要的是通过使用上下文边界或隐式参数将类型class实例从使用站点传播到需要它的地方。
override def createAndFetch(entity: E)(implicit copy: IdCopy[E]): Future[Option[E]] = {
val insertQuery = tableQuery returning tableQuery.map(_.id)
into ((row, id) => row.copyWithId(id))
db.run((insertQuery += entity).flatMap(row => findById(row.id)))
}
2。使用镜头
Shapeless 还提供了 lenses，您可以将其用于此目的。这样您就可以更新任何具有 id 字段的案例 class 的 id 字段。
scala> :paste
// Entering paste mode (ctrl-D to finish)
sealed trait IdCopy[A,ID] {
def copyWithId(self: A, id: ID): A
}
object IdCopy {
import shapeless._, tag.@@
implicit def mkIdCopy[A, ID](
implicit
mkLens: MkFieldLens.Aux[A, Symbol @@ Witness.`"id"`.T, ID]
): IdCopy[A,ID] =
new IdCopy[A,ID] {
def copyWithId(self: A, id: ID): A =
(lens[A] >> 'id).set(self)(id)
}
}
def copyWithId[ID, A](a: A, elem: ID)(implicit copy: IdCopy[A,ID]) = copy.copyWithId(a, elem)
// Exiting paste mode, now interpreting.
defined trait IdCopy
defined object IdCopy
copyWithId: [ID, A](a: A, elem: ID)(implicit copy: IdCopy[A,ID])A
scala> trait Entity[ID] { def id: ID }
defined trait Entity
scala> case class Foo(id: String) extends Entity[String]
defined class Foo
scala> def assignNewIds[ID, A <: Entity[ID]](entities: List[A], ids: List[ID])(implicit copy: IdCopy[A,ID]): List[A] =
| entities.zip(ids).map{ case (entity, id) => copyWithId(entity, id) }
assignNewIds: [ID, A <: Entity[ID]](entities: List[A], ids: List[ID])(implicit copy: IdCopy[A,ID])List[A]
scala> assignNewIds( List(Foo("foo"),Foo("bar")), List("new1", "new2"))
res0: List[Foo] = List(Foo(new1), Foo(new2))
请注意在使用 copyWithId 的方法 assignNewIds 中，类型 class IdCopy[A,ID] 的实例也被请求作为隐式参数。这是因为 copyWithId 在使用时需要 IdCopy[A,ID] 的隐式实例在范围内。您需要从使用站点传播隐式实例，在那里您使用具体类型（例如 Foo），一直沿着调用链向下传播到调用 copyWithId 的位置。
您可以将隐式参数视为方法的依赖项。如果一个方法有一个类型为 IdCopy[A,ID] 的隐式参数，则在调用它时需要满足该依赖性。通常这也会对调用它的方法产生相同的依赖性。
请耐心等待，在 OP 有意义之前还有一些上下文。我正在使用 Slick 3.1.x 和 slick 代码生成器。 btw 完整的源代码可以在 play-authenticate-usage-scala github project 中找到。对于这个项目，我想要一个灵活的通用 Dao 以避免为每个模型重复相同的样板代码。
我有一个 postgres sql 脚本，它在此处使用 evolutions 创建数据库： 1.sql
然后我调用生成以下数据模型的生成器： Tables.scala
为了能够为模型 classes 提供通用的 dao slick 实现，我需要它们遵守一些基本的抽象，例如
- Entity 特征：每个实体都有一个
id例如dao 需要findById - AutoIncEntity 特征声明方法
def copyWithNewId(id : PK) : Entity[PK]。这是 dao 实现createAndFetch所必需的，它持久化一个新实体并一步检索自动生成的idPK。
这个copyWithNewId是OP的重点。请注意，它被称为 copyWithNewId 而不是 copy 以避免无限递归。为了能够实现允许插入并立即获取自动生成的 id 的 GenericDaoAutoIncImpl，实体行需要一个来自 <Model>Row 案例 class 的 copy(id = id) 方法] 在定义 GenericDaoAutoIncImpl 时还不知道。相关实现如下：
override def createAndFetch(entity: E): Future[Option[E]] = {
val insertQuery = tableQuery returning tableQuery.map(_.id)
into ((row, id) => row.copyWithNewId(id))
db.run((insertQuery += entity).flatMap(row => findById(row.id)))
}
这要求我在每个 AutoInc id 生成的模型中实现 copyWithNewId 方法，这并不好，例如
// generated code and modified later to adapt it for the generic dao
case class UserRow(id: Long, ...) extends AutoIncEntity[Long] with Subject {
override def copyWithNewId(id : Long) : Entity[Long] = this.copy(id = id)
}
但是，如果我可以 - 使用一些 Scala 技巧 - 定义我的 <Model>Row 案例 classes subclass 是可复制的 Base class 并复制自身，除了对于已通过的 id 即IdCopyable 和 copy(id = id) 那么我就不需要为每个 <Model>Row 生成的案例 class.
copyWithNewId
对于任何包含 id 属性的 class 情况，是否有抽象或 "pull up" 重构 copy(id = id) 的方法？还有其他推荐的解决方案吗？
更新 1 以下几乎概括了我遇到的问题：
scala> abstract class BaseA[A <: BaseA[_]] { def copy(id : Int) : A }
defined class BaseA
scala> case class A(id: Int) extends BaseA[A]
<console>:12: error: class A needs to be abstract, since method copy in class BaseA of type (id: Int)A is not defined
case class A(id: Int) extends BaseA[A]
^
scala> case class A(id: Int); val a = A(5); a.copy(6)
defined class A
a: A = A(5)
res0: A = A(6)
更新 2 使用下面建议的解决方案我得到以下编译错误：
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:26: could not find implicit value for parameter gen: shapeless.Generic.Aux[E,Repr]
[error] val insertQuery = tableQuery returning tableQuery.map(_.id) into ((row, id) => row.copyWithNewId(id))
[error] ^
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:27: value id is not a member of insertQuery.SingleInsertResult
[error] db.run((insertQuery += entity).flatMap(row => findById(row.id)))
[error] ^
[error] two errors found
更新 3 使用和调整下面建议的镜头解决方案我得到以下编译器错误：
import shapeless._, tag.@@
import shapeless._
import tag.$at$at
/**
* Identifyable base for all Strong Entity Model types
* @tparam PK Primary key type
* @tparam E Actual case class EntityRow type
*/
trait AutoIncEntity[PK, E <: AutoIncEntity[PK, E]] extends Entity[PK] { self: E =>
//------------------------------------------------------------------------
// public
//------------------------------------------------------------------------
/**
* Returns the entity with updated id as generated by the database
* @param id The entity id
* @return the entity with updated id as generated by the database
*/
def copyWithNewId(id : PK)(implicit mkLens: MkFieldLens.Aux[E, Symbol @@ Witness.`"id"`.T, PK]) : E = {
(lens[E] >> 'id).set(self)(id)
}
}
然后我得到以下编译器错误：
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:26: could not find implicit value for parameter mkLens: shapeless.MkFieldLens.Aux[E,shapeless.tag.@@[Symbol,String("id")],PK]
[error] val insertQuery = tableQuery returning tableQuery.map(_.id) into ((row, id) => row.copyWithNewId(id))
[error] ^
[error] /home/bravegag/code/play-authenticate-usage-scala/app/dao/GenericDaoAutoIncImpl.scala:27: value id is not a member of insertQuery.SingleInsertResult
[error] db.run((insertQuery += entity).flatMap(row => findById(row.id)))
[error] ^
使用 shapeless 你可以对大小写 class 进行抽象。
1。手动抽象大小写 classes
如果您假设每个 id 都是一个 Long 并且是案例 class 的第一个参数，它可能看起来像这样：
scala> import shapeless._, ops.hlist.{IsHCons, Prepend}
import shapeless._
import ops.hlist.{IsHCons, Prepend}
scala> trait Copy[A <: Copy[A]] { self: A =>
| def copyWithId[Repr <: HList, Tail <: HList](l: Long)(
| implicit
| gen: Generic.Aux[A,Repr],
| cons: IsHCons.Aux[Repr,Long,Tail],
| prep: Prepend.Aux[Long :: HNil,Tail,Repr]
| ) = gen.from(prep(l :: HNil, cons.tail(gen.to(self))))
| }
defined trait Copy
scala> case class Foo(id: Long, s: String) extends Copy[Foo]
defined class Foo
scala> Foo(4L, "foo").copyWithId(5L)
res1: Foo = Foo(5,foo)
也可能以更简洁的方式实现；我还不是很精通无形编程。而且我 漂亮 确定也可以在参数列表中的任何位置使用任何类型的 id 的案例 class 执行此操作。 见下文第 2 段。
您可能希望将此逻辑封装在可重用的类型中class:
scala> :paste
// Entering paste mode (ctrl-D to finish)
import shapeless._, ops.hlist.{IsHCons, Prepend}
sealed trait IdCopy[A] {
def copyWithId(self: A, id: Long): A
}
object IdCopy {
def apply[A: IdCopy] = implicitly[IdCopy[A]]
implicit def mkIdCopy[A, Repr <: HList, Tail <: HList](
implicit
gen: Generic.Aux[A,Repr],
cons: IsHCons.Aux[Repr,Long,Tail],
prep: Prepend.Aux[Long :: HNil,Tail,Repr]
): IdCopy[A] =
new IdCopy[A] {
def copyWithId(self: A, id: Long): A =
gen.from(prep(id :: HNil, cons.tail(gen.to(self))))
}
}
// Exiting paste mode, now interpreting.
import shapeless._
import ops.hlist.{IsHCons, Prepend}
defined trait IdCopy
defined object IdCopy
scala> def copy[A: IdCopy](a: A, id: Long) = IdCopy[A].copyWithId(a, id)
copy: [A](a: A, id: Long)(implicit evidence: IdCopy[A])A
scala> case class Foo(id: Long, str: String)
defined class Foo
scala> copy(Foo(4L, "foo"), 5L)
res0: Foo = Foo(5,foo)
您仍然可以将 copyWithId 方法放在您的案例 classes 可以扩展的特征中，如果这对您很重要：
scala> trait Copy[A <: Copy[A]] { self: A =>
| def copyWithId(id: Long)(implicit copy: IdCopy[A]) = copy.copyWithId(self, id)
| }
defined trait Copy
scala> case class Foo(id: Long, str: String) extends Copy[Foo]
defined class Foo
scala> Foo(4L, "foo").copyWithId(5L)
res1: Foo = Foo(5,foo)
重要的是通过使用上下文边界或隐式参数将类型class实例从使用站点传播到需要它的地方。
override def createAndFetch(entity: E)(implicit copy: IdCopy[E]): Future[Option[E]] = {
val insertQuery = tableQuery returning tableQuery.map(_.id)
into ((row, id) => row.copyWithId(id))
db.run((insertQuery += entity).flatMap(row => findById(row.id)))
}
2。使用镜头
Shapeless 还提供了 lenses，您可以将其用于此目的。这样您就可以更新任何具有 id 字段的案例 class 的 id 字段。
scala> :paste
// Entering paste mode (ctrl-D to finish)
sealed trait IdCopy[A,ID] {
def copyWithId(self: A, id: ID): A
}
object IdCopy {
import shapeless._, tag.@@
implicit def mkIdCopy[A, ID](
implicit
mkLens: MkFieldLens.Aux[A, Symbol @@ Witness.`"id"`.T, ID]
): IdCopy[A,ID] =
new IdCopy[A,ID] {
def copyWithId(self: A, id: ID): A =
(lens[A] >> 'id).set(self)(id)
}
}
def copyWithId[ID, A](a: A, elem: ID)(implicit copy: IdCopy[A,ID]) = copy.copyWithId(a, elem)
// Exiting paste mode, now interpreting.
defined trait IdCopy
defined object IdCopy
copyWithId: [ID, A](a: A, elem: ID)(implicit copy: IdCopy[A,ID])A
scala> trait Entity[ID] { def id: ID }
defined trait Entity
scala> case class Foo(id: String) extends Entity[String]
defined class Foo
scala> def assignNewIds[ID, A <: Entity[ID]](entities: List[A], ids: List[ID])(implicit copy: IdCopy[A,ID]): List[A] =
| entities.zip(ids).map{ case (entity, id) => copyWithId(entity, id) }
assignNewIds: [ID, A <: Entity[ID]](entities: List[A], ids: List[ID])(implicit copy: IdCopy[A,ID])List[A]
scala> assignNewIds( List(Foo("foo"),Foo("bar")), List("new1", "new2"))
res0: List[Foo] = List(Foo(new1), Foo(new2))
请注意在使用 copyWithId 的方法 assignNewIds 中，类型 class IdCopy[A,ID] 的实例也被请求作为隐式参数。这是因为 copyWithId 在使用时需要 IdCopy[A,ID] 的隐式实例在范围内。您需要从使用站点传播隐式实例，在那里您使用具体类型（例如 Foo），一直沿着调用链向下传播到调用 copyWithId 的位置。
您可以将隐式参数视为方法的依赖项。如果一个方法有一个类型为 IdCopy[A,ID] 的隐式参数，则在调用它时需要满足该依赖性。通常这也会对调用它的方法产生相同的依赖性。