Json "Validate" for Play

Question

对于request.body上的验证方法，它将json对象的属性名称和值类型与模型定义中定义的属性名称和值类型相匹配。现在，如果我向 json 对象添加一个额外的属性并尝试验证它，它会在不应该的时候作为 JsSuccess 传递。

{ 
    "Name": "Bob",
    "Age": 20,
    "Random_Field_Not_Defined_in_Models": "Test"
}

我的人类定义如下

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

Answer 1

我假设您一直在使用 Play 通过 Json.reads[T] 为您提供的内置Reads[T]或Format[T]转换器，例如：

import play.api.libs.json._
val standardReads = Json.reads[Person]

虽然这些非常方便，但如果您需要额外的验证，则必须定义一个自定义Reads[Person]类;但幸运的是，我们仍然可以利用内置的 JSON 到案例类宏来执行基本的检查和转换，然后添加额外的自定义检查层（如果一切正常）：

val standardReads = Json.reads[Person]
val strictReads = new Reads[Person] {
  val expectedKeys = Set("name", "age")
  def reads(jsv:JsValue):JsResult[Person] = {
    standardReads.reads(jsv).flatMap { person =>
      checkUnwantedKeys(jsv, person)
    }
  }
  private def checkUnwantedKeys(jsv:JsValue, p:Person):JsResult[Person] = {
    val obj = jsv.asInstanceOf[JsObject]
    val keys = obj.keys
    val unwanted = keys.diff(expectedKeys)
    if (unwanted.isEmpty) {
      JsSuccess(p)
    } else {
      JsError(s"Keys: ${unwanted.mkString(",")} found in the incoming JSON")
    }
  } 
} 

请注意我们如何首先利用standardReads ，以确保我们正在处理可以转换为Person的东西。无需在这里重新发明轮子。

如果我们从standardReads获得JsError，我们使用flatMap来有效地短路转换 - 即我们只在需要时调用checkUnwantedKeys。

checkUnwantedKeys只是利用了这样一个事实，即JsObject实际上只是 Map 的包装器，因此我们可以轻松地根据白名单检查密钥的名称。

请注意，您也可以使用理解来编写该flatMap，如果您需要更多检查阶段，它开始看起来更干净：

for {
    p <- standardReads.reads(jsv)
    r1 <- checkUnexpectedFields(jsv, p)
    r2 <- checkSomeOtherStuff(jsv, r1)
    r3 <- checkEvenMoreStuff(jsv, r2)
} yield r3

Answer 2

如果你想避免太多的样板，可以使用一点点scala反射来制作一个更通用的解决方案：

import play.api.libs.json._
import scala.reflect.runtime.universe._
def checkedReads[T](underlyingReads: Reads[T])(implicit typeTag: TypeTag[T]): Reads[T] = new Reads[T] {
    def classFields[T: TypeTag]: Set[String] = typeOf[T].members.collect {
      case m: MethodSymbol if m.isCaseAccessor => m.name.decodedName.toString
    }.toSet
    def reads(json: JsValue): JsResult[T] = {
      val caseClassFields = classFields[T]
      json match {
        case JsObject(fields) if (fields.keySet -- caseClassFields).nonEmpty =>
          JsError(s"Unexpected fields provided: ${(fields.keySet -- caseClassFields).mkString(", ")}")
        case _ => underlyingReads.reads(json)
      }
    }
  }

然后，您可以将读取实例指定为：

implicit val reads = checkedReads(Json.reads[Person])

这利用了相当多的 Scala 类型的魔术和反射库（允许您查看类上的字段）。

classFields 方法不依赖于一组固定的字段，而是动态获取 case 类的所有字段（类型 param T ）。它查看所有成员并仅收集 case 类访问器（否则我们将选择像 toString 这样的方法）。它返回字段名称的Set[String]。

您会注意到checkedReads采用隐式TypeTag[T]。这由编译器在编译时提供，并由 typeOf 方法使用。

其余代码相当不言自明。如果传入的 json 与我们的第一个案例匹配（它是一个JsObject并且有不在 case 类上的字段），那么我们返回一个 JsError .否则，我们会将其传递给底层读取器。