Scala 使用 Circe 转换 JSON

在本文中，我们将介绍如何使用 Scala 的 Circe 库来转换 JSON 数据。Circe 是一个功能强大而受欢迎的 JSON 库，用于在 Scala 中进行 JSON 编码和解码。

阅读更多：Scala 教程

什么是 Circe？

Circe 是一个纯函数式的 JSON 编码和解码库，旨在使 Scala 中的 JSON 处理变得简单和优雅。它提供了类型安全和易于使用的 API，可以轻松地将 JSON 数据转换为 Scala 对象，并将 Scala 对象转换为 JSON。

Circe 提供了两个核心模块：circe-core 和 circe-generic。circe-core 提供了对 JSON 值的编码和解码功能，而 circe-generic 则提供了自动生成编码和解码器的能力。借助这两个模块的组合，Circe 可以满足各种复杂的 JSON 处理需求。

安装 Circe

要开始使用 Circe，我们首先需要将其添加到我们的项目依赖中。可以在 build.sbt 文件中添加以下行来添加 Circe 的依赖：

libraryDependencies += "io.circe" %% "circe-core" % "0.14.1"
libraryDependencies += "io.circe" %% "circe-generic" % "0.14.1"

当这些依赖项被添加到项目中时，我们就可以开始使用 Circe 来转换 JSON 数据了。

将 JSON 转换为 Scala 对象

要将 JSON 数据转换为 Scala 对象，我们首先需要定义一个对应于 JSON 结构的 Scala 类。然后，我们可以使用 Circe 提供的解码器将 JSON 数据解码为这个 Scala 对象。

考虑以下 JSON 数据：

{
  "name": "John",
  "age": 30,
  "isStudent": true
}

我们定义一个对应于这个 JSON 结构的 Scala 类：

import io.circe.Decoder
import io.circe.generic.semiauto.deriveDecoder

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

object Person {
  implicit val decoder: Decoder[Person] = deriveDecoder[Person]
}

在上面的代码中，Person 类定义了一个 name 字段（字符串类型），一个 age 字段（整数类型）和一个 isStudent 字段（布尔类型）。我们使用 deriveDecoder 方法自动生成了 Person 类型的解码器。

现在，我们可以使用 Circe 的 decode 方法将 JSON 数据解码为 Person 对象：

import io.circe.parser.decode

val json = """
{
  "name": "John",
  "age": 30,
  "isStudent": true
}
"""

val result = decode[Person](json)

result.fold(
  error => println(s"解码失败：error"),
  person => println(s"解码成功：person")
)

在上面的代码中，我们使用 Circe 的 decode 方法将 JSON 数据解码为 Person 对象。解码结果可以是 Either[io.circe.Error, Person] 类型，我们可以使用 fold 方法处理解码成功和失败的情况。

如果解码成功，我们将得到一个 Person 对象。否则，我们将输出解码失败的错误信息。

将 Scala 对象转换为 JSON

要将 Scala 对象转换为 JSON 数据，我们需要定义一个对应于 JSON 结构的 Scala 类，并使用 Circe 提供的编码器将 Scala 对象编码为 JSON 数据。

考虑以下 Scala 类：

import io.circe.Encoder
import io.circe.generic.semiauto.deriveEncoder

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

object Person {
  implicit val encoder: Encoder[Person] = deriveEncoder[Person]
}

在上面的代码中，Person 类与前面相同。我们使用 deriveEncoder 方法自动生成了 Person 类型的编码器。

现在，我们可以使用 Circe 的 encode 方法将 Person 对象编码为 JSON 数据：

import io.circe.syntax.EncoderOps

val person = Person("John", 30, true)
val json = person.asJson

println(json)

在上面的代码中，我们使用 asJson 方法将 Person 对象转换为 JSON 数据。输出的结果将是一个 io.circe.Json 对象。

定制编码和解码

在某些情况下，可能需要对编码和解码过程进行一些自定义。Circe 允许我们通过手动编写自己的编码器和解码器来实现这一点。

假设我们的 Person 类需要将 isStudent 字段从布尔类型转换为字符串类型（”yes” 或 “no”）。我们可以手动编写一个解码器来实现这个转换：

import io.circe.Decoder
import io.circe.generic.semiauto.deriveDecoder
import io.circe.parser.decode
import io.circe.DecodingFailure
import io.circe.HCursor

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

object Person {
  implicit val decoder: Decoder[Person] = deriveDecoder[Person].emap { cursor =>
    cursor.downField("isStudent").as[Boolean] match {
      case Right(true) => Right(Person(cursor.downField("name").as[String].getOrElse("unknown"), cursor.downField("age").as[Int].getOrElse(-1), "yes"))
      case Right(false) => Right(Person(cursor.downField("name").as[String].getOrElse("unknown"), cursor.downField("age").as[Int].getOrElse(-1), "no"))
      case _ => Left(DecodingFailure("isStudent field decoding error", cursor.history))
    }
  }
}

val json = """
{
  "name": "John",
  "age": 30,
  "isStudent": true
}
"""

val result = decode[Person](json)

result.fold(
  error => println(s"解码失败：error"),
  person => println(s"解码成功：person")
)