Circe - 解码/编码json时在case类中使用默认字段

Question

可以说我有这个案例类:

case class Foo(bar: String, baz: Boolean = false)

在使用akka-http-json解码/编码API请求/响应时使用

在类似于此的示例中:

import akka.actor.ActorSystem
import akka.http.scaladsl.Http
import akka.http.scaladsl.server.Directives
import akka.stream.{ ActorMaterializer, Materializer }
import scala.io.StdIn

object ExampleApp {

  private final case class Foo(bar: String, baz: Boolean = false)

  def main(args: Array[String]): Unit = {
    implicit val system = ActorSystem()
    implicit val mat    = ActorMaterializer()

    Http().bindAndHandle(route, "127.0.0.1", 8000)

    StdIn.readLine("Hit ENTER to exit")
    system.terminate()
  }

  private def route(implicit mat: Materializer) = {
    import Directives._
    import FailFastCirceSupport._
    import io.circe.generic.auto._

    pathSingleSlash {
      post {
        entity(as[Foo]) { foo =>
          complete {
            foo
          }
        }
      }
    }
  }
}

只要json消息包含baz字段,这就可以正常工作.但是,我希望能够发送一条json消息,{bar: "something"}并让结果使用Foo的默认值为baz.是否有任何配置,circe或akka-http-json可能使这项工作？

此外,baz在再次编码为json时忽略该字段会很好,但这并不重要.

编辑:

我知道我可以这样做:

implicit val fooEncoder: Encoder[Foo] = new Encoder[Foo] {
    final def apply(a: Foo): Json = Json.obj(
      ("id", Json.fromString(a.bar))
    )
  }

implicit val fooDecoder: Decoder[Foo] = new Decoder[Decoder] {
  final def apply(c: HCursor): Decoder.Result[Decoder] =
    for {
      bar <- c.downField("bar").as[String]
    } yield {
      Foo(bar)
    }
}

但希望有一个更易于维护的解决方案,解决了不需要json消息中的默认字段的一般情况.

Answer 1

您可以使用circe-generic-extras包执行此操作.这是您必须在构建中添加的独立依赖项.对于sbt,那是:

libraryDependencies += "io.circe" %% "circe-generic-extras" % "0.8.0"

然后,在您的路线功能中,替换

import io.circe.generic.extras.Configuration
import io.circe.generic.auto._

有:

import io.circe.generic.extras.auto._
implicit val customConfig: Configuration = Configuration.default.withDefaults

此生成的编码器将始终包含默认字段.

有关更多信息,请参阅以下文件中的circe发行说明:https://github.com/circe/circe/releases/tag/v0.6.0-RC1