如何验证Play Framework中的可选查询参数？

Question

所以我有一个路由文件看起来是这样的：

GET  /myRes     controllers.MyController.get(ids: Option[String], elems: Option[String]) 

一切都很好。用户可以通过做得到的东西：

/myRes 
/myRes?ids=X 
/myRes?elems=Y 
/myRes?ids=X&elems=Y 

然而，它们还可以通过执行查询的接口：

/myRes?id=X 

这是有问题的，因为在这种情况下，用户得到的结果，如果同他们询问/myRes，这几乎肯定不是他们预期的结果。这对API的开发人员造成了很多混淆/错误。有没有一种优雅的方式来捕获传递给控制器​​的不正确/未指定的查询参数，并返回此类查询的硬错误？

编辑：将标题更改为更具描述性的内容。我的问题基本上是验证查询参数，以捕获传递给API的任何查询参数，这些参数是无效的/正确的。

Answer 1

我通常把它传递这样的get方法

GET /getSomething  Controllers.Application.getData() 

GET /getSomething/:id   Controllers.Application.getData(id:Integer) 

GET /getSomething/:id/:name   Controllers.Application.getData(id:Integer, name :String) 

Answer 2

它可以与宏注释类似以下的帮助来完成：

import scala.reflect.macros.whitebox.Context 
import scala.language.experimental.macros 
import scala.annotation.StaticAnnotation 
import scala.annotation.compileTimeOnly 
import play.api.mvc._ 

@compileTimeOnly("respond 400 bad request in case of unexpected params") 
class StrictParams extends StaticAnnotation { 
    def macroTransform(annottees: Any*): Any = macro StrictParamsMacro.impl 
} 

object StrictParamsMacro { 
    def impl(c: Context)(annottees: c.Expr[Any]*): c.Expr[Any] = { 
    import c.universe._ 
    annottees.map(_.tree).toList match { 
     case q"def $name(..$params) = $action { ..$body }" :: Nil => 
     val supportedParamNames = params.map(ab => ab.name.toString).toSet 
     c.Expr[Any](
      q"""def $name(..$params) = { req: Request[_] => 
      val unsupportedParams = req.queryString.keySet -- $supportedParamNames 
      if (unsupportedParams.nonEmpty) { 
       BadRequest(unsupportedParams.mkString("Unsupported Params: ", ", ", "")) 
      } else { 
       $body 
      } 
      }""" 
     ) 
    } 
    } 
} 

然后你就可以注释动作方法像这样：

@StrictParams 
def get(ids: Option[String], elems: Option[String]) = Action { 
    ... 
}