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

Posted 2023-03-23

【中文标题】播放框架路由不区分大小写

【英文标题】：Play framework Route case insensitive

【发布时间】：2016-12-16 16:03:38

【问题描述】：

我们目前正在开发 Play 2.5.x

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

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

在我们想要达到的 URL 中

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

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

有没有一种方法可以使用正则表达式来实现这个 bu？有人可以指出或提供一个例子吗？

【问题讨论】：

***.com/questions/22015902/…

@MipH 之前看到过这篇文章。我正在寻找一些正则表达式来处理这个。也许我可以就我到底需要什么提出问题。谢谢

我想你可能有兴趣阅读这个：jazzy.id.au/2013/05/08/advanced_routing_in_play_framework.html

【参考方案1】：

您可以定义一个请求处理程序以使 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$14$$anon$3@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”作为参数。请注意，这不适用于查询字符串参数。 根据您的用例，这可能会有问题。

【参考方案2】：

使用 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)