Question

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

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

我的人员类定义如下

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

Answer 1

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

import play.api.libs.json._

val standardReads = Json.reads[Person]

虽然这些 super -handy，但如果您需要其他验证，则必须定义自定义Reads[Person]类;但幸运的是，我们仍然可以利用内置的JSON-to-case-class宏来进行基本的检查和转换，然后在事情看起来不错的情况下添加一层额外的自定义检查：

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。无需在这里重新发明轮子。

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

checkUnwantedKeys 只使用JsObject为really just a wrapper around a Map的事实，因此我们可以根据白名单轻松检查密钥的名称。

注意你也可以使用for-comprehension来编写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方法不是依赖于一组固定的字段，而是为案例类动态获取所有字段（类型为param T）。它查看所有成员并仅收集案例类访问者（否则我们会选择toString之类的方法）。它返回Set[String]个字段名称。

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

剩下的代码是相当自我解释的。如果传入的json匹配我们的第一个案例（它是JsObject并且案例类中没有字段），那么我们返回JsError。否则我们将其传递给基础读者。

Json＆＃34;验证＆＃34;为......而玩

2 个答案: