如何在circe中覆盖默认编解码器？

Question

我想将我的case类的Array[Byte]字段编码为Base64字符串。出于某种原因，Circe没有使用默认的编解码器，而是将字节数组转换为整数的json数组。

我该怎么做才能解决这个问题？这是我最小化的代码

import io.circe.generic.JsonCodec

sealed trait DocumentAttribute

@JsonCodec
sealed case class DAAudio(title: Option[String], performer: Option[String], waveform: Option[Array[Byte]], duration: Int) extends DocumentAttribute

@JsonCodec
sealed case class DAFilename(fileName: String) extends DocumentAttribute

object CirceEncodersDecoders {
  import io.circe._
  import io.circe.generic.extras._
  import io.circe.generic.extras.semiauto._

  implicit val arrayByteEncoder: Encoder[Array[Byte]] = Encoder.encodeString.contramap[Array[Byte]] { bytes ⇒
    Base64.getEncoder.encodeToString(bytes)
  }

  val printer: Printer = Printer.noSpaces.copy(dropNullValues = true, reuseWriters = true)
  implicit val config: Configuration = Configuration.default.withDiscriminator("kind").withSnakeCaseConstructorNames.withSnakeCaseMemberNames

  implicit val DocumentAttributeEncoder: Encoder[DocumentAttribute] = deriveEncoder
  implicit val DocumentAttributeDecoder: Decoder[DocumentAttribute] = deriveDecoder
}

object main {
  def main(args: Array[String]): Unit = {
    import CirceEncodersDecoders._

    import io.circe.parser._
    import io.circe.syntax._

    val attributes: List[DocumentAttribute] = List(
      DAAudio(Some("title"), Some("perform"), Some(List(1, 2, 3, 4, 5).map(_.toByte).toArray), 15),
      DAFilename("filename")
    )
    val j2 = attributes.asJson
    val decoded2 = decode[List[DocumentAttribute]](j2.noSpaces)
    println(decoded2)
  }
}

Answer 1

当你这样做：

implicit val DocumentAttributeEncoder: Encoder[DocumentAttribute] = deriveEncoder

circe试图为Encoder和DAFilename获得合适的DAAudio。但是，由于那些已经存在（通过@JsonCodec在各个类上），它不会从头开始使用泛型和你的Encoder[Array[Byte]]在你想要的范围内重新派生它们。

所以你可以摆脱@JsonCodec（所以它自动导出DAFilename和DAAudio与DocumentAttribute的编解码器）或手动触发重新推导：

implicit val AudioDecoder: Encoder[DAAudio] = deriveEncoder // takes priority over existing one
implicit val DocumentAttributeEncoder: Encoder[DocumentAttribute] = deriveEncoder // AudioDecoder will be used here

你还需要为Decoder构建一个Array[Byte]并重复Decoders的上述过程，否则它将尝试将Base64字符串解析为一个int列表，从而导致失败。

Answer 2

它接缝@JsonCodec注释不适用于Array[Byte]的自定义编码器。

以下是使用circe对类进行编码和解码所需的所有内容：

object CirceEncodersDecoders2 {
  val printer: Printer = Printer.noSpaces.copy(dropNullValues = true, reuseWriters = true)
  implicit val arrayByteEncoder: Encoder[Array[Byte]] =
    Encoder.encodeString.contramap[Array[Byte]](Base64.getEncoder.encodeToString)
  implicit val arrayByteDecoder: Decoder[Array[Byte]] =
    Decoder.decodeString.map[Array[Byte]](Base64.getDecoder.decode)
  implicit val config: Configuration = Configuration.default.withDiscriminator("kind").withSnakeCaseConstructorNames.withSnakeCaseMemberNames
  implicit val audioEncoder: Encoder[DAAudio] = deriveEncoder[DAAudio]
  implicit val audioDecoder: Decoder[DAAudio] = deriveDecoder[DAAudio]
  implicit val filenameEncoder: Encoder[DAFilename] = deriveEncoder[DAFilename]
  implicit val filenameDecoder: Decoder[DAFilename] = deriveDecoder[DAFilename]
  implicit val documentAttributeEncoder: Encoder[DocumentAttribute] = deriveEncoder[DocumentAttribute]
  implicit val documentAttributeDecoder: Decoder[DocumentAttribute] = deriveDecoder[DocumentAttribute]
}

如果您不限于选择JSON解析器/序列化器，那么您可以使用jsoniter-scala尝试更有效的解决方案。

免责声明：我是这个图书馆的作者。

以下是两种实现的基准测试结果：

[info] Benchmark                                        Mode  Cnt        Score           Error   Units
[info] ListOfAdtWithBase64Benchmark.readCirce           thrpt 5   114927.343 ±   7910.068 ops/s
[info] ListOfAdtWithBase64Benchmark.readJsoniterScala   thrpt 5  1818299.170 ± 162757.404 ops/s
[info] ListOfAdtWithBase64Benchmark.writeCirce          thrpt 5   117982.635 ±   8942.816 ops/s
[info] ListOfAdtWithBase64Benchmark.writeJsoniterScala  thrpt 5  4281752.461 ± 319953.287 ops/s

完整的来源是here。