如何将验证添加到Play Json中的Reads中？

Question

假设我读取了一个包含两个可选字段的JSON创建对象：

implicit val rd: Reads[MyObject] = (
  (__ \ "field1").readNullable[String] and
  (__ \ "field2").readNullable[String]
)(MyObject.apply _)

我要检查以确保field1的值是列表中的值之一：

  List("foo", "bar")

事后，我可以通过创建一个新的MyObject并通过一个函数映射值以转换它们的方式来做到这一点，但我觉得应该有一种方法可以使用JSON转换器或其他方法更优雅地做到这一点。

理想情况下，我希望Reads读取field1的可为空值并在定义后对其进行转换，而无需对其进行后处理。 有什么办法可以潜入其中吗？

Answer 1

您可以使用这种方法：

case class MyObject(a: Option[String], b: Option[String])

val allowedValues = Seq("foo", "bar")

implicit val reads: Reads[MyObject] = new Reads[MyObject] { 
  override def reads(json: JsValue): JsResult[MyObject] = { 
    val a = (json \ "a").asOpt[String].filter(allowedValues.contains)
    val b = (json \ "b").asOpt[String]
    JsSuccess(MyObject(a, b))
  }
}

用法示例：

scala> Json.parse(""" { "a": "bar", "b": "whatever"} """).validate[MyObject]
res2: play.api.libs.json.JsResult[MyObject] = JsSuccess(MyObject(Some(bar),Some(whatever)),)

scala> Json.parse(""" { "a": "other", "b": "whatever"} """).validate[MyObject]
res3: play.api.libs.json.JsResult[MyObject] = JsSuccess(MyObject(None,Some(whatever)),)

scala> Json.parse(""" {} """).validate[MyObject]
res4: play.api.libs.json.JsResult[MyObject] = JsSuccess(MyObject(None,None),)

Answer 2

好吧，在进行了更多研究之后，我想到了以下几点：

在play.api.libs.json.ConstraintReads有一个称为verifying(cond: A => Boolean)的函数，该函数返回Reads[A] 。 可以将其作为参数传递给JsPath.readNullable[A]如下所示：

implicit val rd: Reads[MyObject] = (
  (__ \ "field1").readNullable[String](verifying(allowedValues.contains)) and
  (__ \ "field2").readNullable[String]
)(MyObject.apply _)

这将返回JsResponse；如果“ field1”有效，则返回JsSuccess；如果无效，则返回JsError。 实际上，它在输入无效时失败，而不仅仅是忽略输入。 那更像是我想要的行为。

还有许多其他约束函数也对读取值执行类似的测试。