播放如何为包含枚举的案例类实现隐式写入或格式

Question

以下this answer 展示了如何使用案例类将枚举绑定到表单。

但在 Play 2.7.3 中，此代码失败：

No Json serializer found for type jura.SearchRequest. Try to implement an implicit Writes or Format for this type.

当我实现格式化程序时：

object SearchRequest {
  implicit val searchRequestFormat: OFormat[SearchRequest] = Json.format[SearchRequest]
}

我明白了

没有 play.api.libs.json.Format 的实例可用于 scala.Enumeration.Value 在隐式范围内

我应该尝试为系统 scala.Enumeration 类型编写格式化程序吗？
或者在涉及枚举时是否有另一种方式来实现格式化程序？

测试用例here。

Answer 1

我将这个库用于任何枚举：enumeratum

使用 Dotty 会有很棒的 枚举，但在那之前我认为移动到 enumeratum 是处理 中的枚举的最佳方式斯卡拉。另见Dotty - Enumerations。

另外还有一个play-json 扩展，请参阅Play JSON Extension。

这样您的代码将如下所示：

import enumeratum.{ PlayJsonEnum, Enum, EnumEntry }

sealed trait SearchRequest extends EnumEntry

object SearchRequest extends Enum[SearchRequest] with PlayJsonEnum[SearchRequest] {

  val values = findValues

  case object SuperRequest  extends SearchRequest
  case object SimpleRequest extends SearchRequest
  ..
}

本质上，PlayJsonEnum[SearchRequest] 完成了所有工作。

Answer 2

要将枚举写成字符串，如 cchantep 所说，您可以使用 Writes.enumNameWrites，我们专门用于读取和写入 ID。因此，我们在全局包中为枚举提供了一个 EnumFormat：

package object enums {

  implicit def reads[E <: Enumeration](enum: E): Reads[E#Value] = new Reads[E#Value] {
    def reads(json: JsValue): JsResult[E#Value] = json match {
      case JsNumber(s) =>
        try {
          JsSuccess(enum.apply(s.toInt))
        } catch {
          case _: NoSuchElementException => JsError(s"Enumeration expected of type: '${enum.getClass}', but it does not appear to contain the value: '$s'")
        }
      case _ => JsError("Number value expected")
    }
  }

  implicit def writes[E <: Enumeration]: Writes[E#Value] = new Writes[E#Value] {
    def writes(v: E#Value): JsValue = JsNumber(v.id)
  }

  implicit def formatID[E <: Enumeration](enum: E): Format[E#Value] =
    Format(reads(enum), writes)


  def readsString[E <: Enumeration](enum: E): Reads[E#Value] = new Reads[E#Value] {
    def reads(json: JsValue): JsResult[E#Value] = json match {
      case JsString(s) => {
        try {
          JsSuccess(enum.withName(s))
        } catch {
          case _: NoSuchElementException => JsError(s"Enumeration expected of type: '${enum.getClass}', but it does not appear to contain the value: '$s'")
        }
      }
      case _ => JsError("String value expected")
    }
  }

  implicit def writesString[E <: Enumeration]: Writes[E#Value] = new Writes[E#Value] {
    def writes(v: E#Value): JsValue = JsString(v.toString)
  }

  implicit def formatString[E <: Enumeration](enum: E): Format[E#Value] =
    Format(readsString(enum), writesString)
}

并使用：

object SearchRequest extends Enumeration(1) {
  type SearchRequest = Value

  val ONE /*1*/ , TWO /*2*/ , ETC /*n*/ = Value

  implicit val searchRequestFormat: Format[SearchRequest] = formatID(SearchRequest)
}

Answer 3

将以下内容添加到您的枚举对象中

implicit object MatchFilterTypeFormatter extends Formatter[MatchFilterType.Value] {
    override val format = Some(("format.enum", Nil))
    override def bind(key: String, data: Map[String, String]) = {
      try {
        Right(MatchFilterType.withName(data.get(key).head))
      } catch {
        case e:NoSuchElementException =>  Left(Seq(play.api.data.FormError(key, "Invalid MatchFilterType Enumeration")))
      }
    }
    override def unbind(key: String, value: MatchFilterType.Value) = {
      Map(key -> value.toString)
    }
  }
  implicit val matchFilterTypeFormat = new Format[MatchFilterType.MatchFilterType] {
    def reads(json: JsValue) = JsSuccess(MatchFilterType.withName(json.as[String]))
    def writes(myEnum: MatchFilterType.MatchFilterType) = JsString(myEnum.toString)
  }

然后问题中给出的格式化程序/控制器将起作用。

一个有效的测试用例是here。