播放框架路由不区分大小写

Play framework Route case insensitive

我们目前正在开发 Play 2。5.x

我们希望实现不区分大小写的路由。比如说

GET /via/v1/organizations http.organizationApi()

在 URL 我们想要实现

http://localhost:9000/abc/v1/organizations

http://localhost:9000/ABC/V1/OrganIZations

是否有使用正则表达式实现此目的的方法?有人可以指出或提供一个例子吗?

您可以定义一个请求处理程序来使 URL 不区分大小写。在这种情况下,以下处理程序只会将 url 转换为小写,因此在您的路由中 url 应以小写形式定义:

import javax.inject.Inject

import play.api.http._
import play.api.mvc.RequestHeader
import play.api.routing.Router

class MyReqHandler @Inject() (router: Router, errorHandler: HttpErrorHandler,
                   configuration: HttpConfiguration, filters: HttpFilters
          ) extends DefaultHttpRequestHandler(router, errorHandler, configuration, filters) {

  override def routeRequest(request: RequestHeader) = {
    val newpath = request.path.toLowerCase
    val copyReq = request.copy(path = newpath)
    router.handlerFor(copyReq)
  }
}

并在 application.conf 中引用它:

# This supposes MyReqHandler.scala is in your project app folder
# If it is in another place reference it using the correct package name
# ex: app/handlers/MyReqHandler.scala --> "handlers.MyReqHandler"
play.http.requestHandler = "MyReqHandler"

现在,如果您将路由定义为“/persons/create”,则无论大小写组合都可以使用(例如:“/PeRsOns/cREAtE”)

不过有两个注意事项:

  • 您只能将其用于 Scala 操作。如果你的路由文件引用了一个 Java 控制器方法,你会得到一个奇怪的异常:

    [error] p.c.s.n.PlayRequestHandler - Exception caught in Netty
    scala.MatchError: Right((play.core.routing.HandlerInvokerFactory$JavaActionInvokerFactory$$anon$$anon@22d56da6,play.api.DefaultApplication@67d7f798)) (of class scala.util.Right) 
    

    如果是这种情况,您可以找到更多信息 here

  • 如果您的 url 有参数,这些参数也会被转换。例如,如果您有这样的路线

    GET /persons/:name/greet       ctrl.Persons.greet(name: String)
    

    对“/persons/JohnDoe/greet”的调用将转换为“/persons/johndoe/greet”,并且您的 greet 方法将收到 "johndoe" 而不是 "JohnDoe" 作为范围。请注意,这不适用于查询字符串参数。 根据您的用例,这可能会有问题。

对于 play 2.8,上面的答案不起作用。剧本 api 已更改,因此我将代码粘贴到此处。

class CaseInsensitive @Inject()(router: Router, errorHandler: HttpErrorHandler, configuration: HttpConfiguration, filters: EssentialFilter*)
extends DefaultHttpRequestHandler(new DefaultWebCommands, None, router, errorHandler, configuration, filters){

override def routeRequest(request: RequestHeader): Option[Handler] = {
  val target = request.target;
  val newPath = target.path.toLowerCase

  val newTarget = request.target.withPath(newPath)
  val newRequest = request.withTarget(newTarget);

  router.handlerFor(newRequest)
}

}