在Scala中使用CIRCE时，如何忽略字段从序列化中

Question

我在Scala中使用CIRCE，并有以下要求：

假设我有一些类似于下面的类，我想避免密码字段序列化，那么是否有任何方法让Circe知道它不应序列化密码字段？

在其他库中，我们有 @transient这样的注释，可以防止字段序列化，CIRCE中是否有这样的注释？

case class Employee(                   
                     name: String,
                     password: String)

Answer 1

您可以制作一个自定义编码器，以编辑某些字段：

implicit val encodeEmployee: Encoder[Employee] = new Encoder[Employee] {
  final def apply(a: Employee): Json = Json.obj(
    ("name", Json.fromString(a.name)),
    ("password", Json.fromString("[REDACTED]")),
  )
}

以后更新

，以避免从Semiauto/Auto解码器中浏览所有字段：

import io.circe.generic.semiauto._

implicit val encodeEmployee: Encoder[Employee] =
  deriveEncoder[Employee]
    .contramap[Employee](unredacted => unredacted.copy(password = "[REDACTED]"))

Answer 2

尽管 @gatear的答案很有用，但实际上并没有回答这个问题。

不幸的是，CIRCE（至少直到版本0.14.2）没有注释可以忽略字段。到目前为止，只有一个注释（@jsonkey），这用于重命名字段名称。

为了在序列化（CIRCE调用编码）时忽略字段，您可以在encoder实现中避免该字段。

因此，而不是包括密码字段：

implicit val employeeEncoder: Encoder[Employee] =
  Encoder.forProduct2("name", "password")(employee => (employee.name, employee.password))

您要使用它：

implicit val employeeEncoder: Encoder[Employee] =
  Encoder.forProduct1("name")(employee => (u.name))

我一直使用的是创建一个较小的case类，其中仅包括我感兴趣的字段。然后，我让CIRCE的自动派生使用io.circe.generic.auto ._：

import io.circe.generic.auto._
import io.circe.syntax._

case class EmployeeToEncode(name: String)

// Then given an employee object:
EmployeeToEncode(employee.name).asJson

Answer 3

deriveEncoder.mapJsonObject(_.remove("password"))