更新嵌套结构的更清洁方法

时间:2010-10-10 12:37:05

标签: scala case-class zipper

说我有两个case class es:

case class Address(street: String, city: String, state: String, zipCode: Int)
case class Person(firstName: String, lastName: String, address: Address)

以及Person类的以下实例:

val raj = Person("Raj", "Shekhar", Address("M Gandhi Marg", 
                                           "Mumbai", 
                                           "Maharashtra", 
                                           411342))

现在,如果我想更新zipCode的{​​{1}},那么我将不得不这样做:

raj

随着嵌套程度的提高,这将变得更加丑陋。是否有一种更清洁的方式(类似于Clojure的val updatedRaj = raj.copy(address = raj.address.copy(zipCode = raj.address.zipCode + 1)) )来更新这种嵌套结构?

7 个答案:

答案 0 :(得分:182)

有趣的是没有人添加镜头,因为它们是为这种东西制作的。因此,here是关于它的CS背景文件,here是一个博客,简要介绍了Scala中使用的镜头,here是Scalaz的镜头实现,here是一些代码使用它,看起来非常像你的问题。并且,为了减少锅炉板,here's一个为案例类生成Scalaz镜头的插件。

对于奖励积分,here's另一个S.O.关于镜片的问题,以及托尼莫里斯的paper

镜头的重要性在于它们是可组合的。所以一开始它们有点麻烦,但是你使用它们的次数越来越多。此外,它们非常适合测试,因为您只需要测试单个镜头,并且可以理所当然地将它们的构图视为理所当然。

因此,基于本答案末尾提供的实现,以下是您使用镜头的方法。首先,声明镜头以更改地址中的邮政编码和人员中的地址:

val addressZipCodeLens = Lens(
    get = (_: Address).zipCode,
    set = (addr: Address, zipCode: Int) => addr.copy(zipCode = zipCode))

val personAddressLens = Lens(
    get = (_: Person).address, 
    set = (p: Person, addr: Address) => p.copy(address = addr))

现在,将它们组合起来以获得改变一个人的邮政编码的镜头:

val personZipCodeLens = personAddressLens andThen addressZipCodeLens

最后,使用那个镜头改变raj:

val updatedRaj = personZipCodeLens.set(raj, personZipCodeLens.get(raj) + 1)

或者,使用一些语法糖:

val updatedRaj = personZipCodeLens.set(raj, personZipCodeLens(raj) + 1)

甚至:

val updatedRaj = personZipCodeLens.mod(raj, zip => zip + 1)

这是一个简单的实现,取自Scalaz,用于此示例:

case class Lens[A,B](get: A => B, set: (A,B) => A) extends Function1[A,B] with Immutable {
  def apply(whole: A): B   = get(whole)
  def updated(whole: A, part: B): A = set(whole, part) // like on immutable maps
  def mod(a: A, f: B => B) = set(a, f(this(a)))
  def compose[C](that: Lens[C,A]) = Lens[C,B](
    c => this(that(c)),
    (c, b) => that.mod(c, set(_, b))
  )
  def andThen[C](that: Lens[B,C]) = that compose this
}

答案 1 :(得分:94)

拉链

Huet's Zipper提供了不可变数据结构的方便遍历和“变异”。 Scalaz为Streamscalaz.Zipper)和Treescalaz.TreeLoc)提供拉链。事实证明,拉链的结构可以自动地从原始数据结构中导出,其方式类似于代数表达式的符号区分。

但是,这对您的Scala案例类有何帮助?好吧,Lukas Rytz最近prototyped扩展了scalac,它会自动为带注释的案例类创建拉链。我将在这里重现他的例子:

scala> @zip case class Pacman(lives: Int = 3, superMode: Boolean = false) 
scala> @zip case class Game(state: String = "pause", pacman: Pacman = Pacman()) 
scala> val g = Game() 
g: Game = Game("pause",Pacman(3,false))

// Changing the game state to "run" is simple using the copy method:
scala> val g1 = g.copy(state = "run") 
g1: Game = Game("run",Pacman(3,false))

// However, changing pacman's super mode is much more cumbersome (and it gets worse for deeper structures):
scala> val g2 = g1.copy(pacman = g1.pacman.copy(superMode = true))
g2: Game = Game("run",Pacman(3,true))

// Using the compiler-generated location classes this gets much easier: 
scala> val g3 = g1.loc.pacman.superMode set true
g3: Game = Game("run",Pacman(3,true)

因此社区需要说服Scala团队继续努力并将其集成到编译器中。

顺便提一下,Lukas最近published是Pacman的一个版本,用户可以通过DSL进行编程。但是,看起来他没有使用修改过的编译器,因为我看不到任何@zip注释。

树重写

在其他情况下,您可能希望在整个数据结构中应用一些转换,根据某种策略(自上而下,自下而上),并基于与结构中某个点的值匹配的规则。经典的例子是为一种语言转换AST,也许是为了评估,简化或收集信息。 Kiama支持Rewriting,请参阅RewriterTests中的示例,并观看此video。这是一个可以激起你胃口的片段:

// Test expression
val e = Mul (Num (1), Add (Sub (Var ("hello"), Num (2)), Var ("harold")))

// Increment every double
val incint = everywheretd (rule { case d : Double => d + 1 })
val r1 = Mul (Num (2), Add (Sub (Var ("hello"), Num (3)), Var ("harold")))
expect (r1) (rewrite (incint) (e))

请注意Kiama steps outside类型系统来实现这一目标。

答案 2 :(得分:11)

使用镜头的有用工具:

只想添加基于Scala 2.10宏的MacrocosmRillit项目,提供动态镜头创建。


使用Rillit:

case class Email(user: String, domain: String)
case class Contact(email: Email, web: String)
case class Person(name: String, contact: Contact)

val person = Person(
  name = "Aki Saarinen",
  contact = Contact(
    email = Email("aki", "akisaarinen.fi"),
    web   = "http://akisaarinen.fi"
  )
)

scala> Lenser[Person].contact.email.user.set(person, "john")
res1: Person = Person(Aki Saarinen,Contact(Email(john,akisaarinen.fi),http://akisaarinen.fi))

使用Macrocosm:

  

这甚至适用于当前编译运行中定义的案例类。

case class Person(name: String, age: Int)

val p = Person("brett", 21)

scala> lens[Person].name._1(p)
res1: String = brett

scala> lens[Person].name._2(p, "bill")
res2: Person = Person(bill,21)

scala> lens[Person].namexx(()) // Compilation error

答案 3 :(得分:8)

我一直在寻找具有最好语法和最佳功能的Scala库,这里没有提到的一个库monocle对我来说非常好。一个例子如下:

import monocle.Macro._
import monocle.syntax._

case class A(s: String)
case class B(a: A)

val aLens = mkLens[B, A]("a")
val sLens = aLens |-> mkLens[A, String]("s")

//Usage
val b = B(A("hi"))
val newB = b |-> sLens set("goodbye") // gives B(A("goodbye"))

这些非常好,有许多方法可以合并镜片。例如Scalaz需要很多样板,这样可以快速编译并运行良好。

要在项目中使用它们,只需将其添加到依赖项中:

resolvers ++= Seq(
  "Sonatype OSS Releases"  at "http://oss.sonatype.org/content/repositories/releases/",
  "Sonatype OSS Snapshots" at "http://oss.sonatype.org/content/repositories/snapshots/"
)

val scalaVersion   = "2.11.0" // or "2.10.4"
val libraryVersion = "0.4.0"  // or "0.5-SNAPSHOT"

libraryDependencies ++= Seq(
  "com.github.julien-truffaut"  %%  "monocle-core"    % libraryVersion,
  "com.github.julien-truffaut"  %%  "monocle-generic" % libraryVersion,
  "com.github.julien-truffaut"  %%  "monocle-macro"   % libraryVersion,       // since 0.4.0
  "com.github.julien-truffaut"  %%  "monocle-law"     % libraryVersion % test // since 0.4.0
)

答案 4 :(得分:7)

无形可以解决问题:

"com.chuusai" % "shapeless_2.11" % "2.0.0"

with:

case class Address(street: String, city: String, state: String, zipCode: Int)
case class Person(firstName: String, lastName: String, address: Address)

object LensSpec {
      import shapeless._
      val zipLens = lens[Person] >> 'address >> 'zipCode  
      val surnameLens = lens[Person] >> 'firstName
      val surnameZipLens = surnameLens ~ zipLens
}

class LensSpec extends WordSpecLike with Matchers {
  import LensSpec._
  "Shapless Lens" should {
    "do the trick" in {

      // given some values to recreate
      val raj = Person("Raj", "Shekhar", Address("M Gandhi Marg",
        "Mumbai",
        "Maharashtra",
        411342))
      val updatedRaj = raj.copy(address = raj.address.copy(zipCode = raj.address.zipCode + 1))

      // when we use a lens
      val lensUpdatedRaj = zipLens.set(raj)(raj.address.zipCode + 1)

      // then it matches the explicit copy
      assert(lensUpdatedRaj == updatedRaj)
    }

    "better yet chain them together as a template of values to set" in {

      // given some values to recreate
      val raj = Person("Raj", "Shekhar", Address("M Gandhi Marg",
        "Mumbai",
        "Maharashtra",
        411342))

      val updatedRaj = raj.copy(firstName="Rajendra", address = raj.address.copy(zipCode = raj.address.zipCode + 1))

      // when we use a compound lens
      val lensUpdatedRaj = surnameZipLens.set(raj)("Rajendra", raj.address.zipCode+1)

      // then it matches the explicit copy
      assert(lensUpdatedRaj == updatedRaj)
    }
  }
}

请注意,虽然这里的其他一些答案让你可以让镜头更深入到一个给定的结构,这些无形镜头(以及其他库/宏)让你可以组合两个不相关的镜头,这样你就可以制作设置任意数量参数的镜头进入你结构中的任意位置。对于复杂的数据结构,额外的组合非常有用。

答案 5 :(得分:6)

由于其可组合性,镜头为重度嵌套结构的问题提供了非常好的解决方案。然而,由于嵌套水平较低,我有时觉得镜头太多了,如果只有很少的地方有嵌套更新,我不想介绍整个镜头方法。为了完整起见,这是一个非常简单/实用的解决方案:

我所做的只是在顶级结构中编写一些modify...辅助函数,它处理丑陋的嵌套副本。例如:

case class Person(firstName: String, lastName: String, address: Address) {
  def modifyZipCode(modifier: Int => Int) = 
    this.copy(address = address.copy(zipCode = modifier(address.zipCode)))
}

我的主要目标(简化客户端更新)已实现:

val updatedRaj = raj.modifyZipCode(_ => 41).modifyZipCode(_ + 1)

创建完整的修改帮助器组显然很烦人。但对于内部事物,通常可以在第一次尝试修改某个嵌套字段时创建它们。

答案 6 :(得分:3)

或许QuickLens更符合您的问题。 QuickLens使用宏将IDE友好表达式转换为接近原始复制语句的内容。

给出两个示例案例类:

case class Address(street: String, city: String, state: String, zipCode: Int)
case class Person(firstName: String, lastName: String, address: Address)

和Person类的实例:

val raj = Person("Raj", "Shekhar", Address("M Gandhi Marg", 
                                           "Mumbai", 
                                           "Maharashtra", 
                                           411342))

您可以使用以下命令更新raj的zipCode:

import com.softwaremill.quicklens._
val updatedRaj = raj.modify(_.address.zipCode).using(_ + 1)