Scala下Play框架學習筆記（Http Routing）

內置的HTTP路由

路由把每一個引進來的HTTP請求對應到相應的Action去。

HTTP請求被認為是MVC框架下的一個事件，這一事件包含兩部分主要信息：

（1）請求路徑，包括query String

（2）HTTP方法，如get,post等

   路由被定義在經過編譯的conf/routes中，因此你能在瀏覽器上直接看到報錯信息。

conf/routes中每一行一般由HTTP方法和相應URI組成：

GET   /clients/:id          controllers.Clients.show(id: Long)

也可加上評論：

# Display a client.

GET   /clients/:id          controllers.Clients.show(id: Long)

以下這個不太懂，請高人指教：

->      /api                        api.MyRouter

HTTP方法

HTTP方法包括get、post、patch、put、delete、head等。

URI PATTERN

URI PATTERN定義了routes的路徑，部分請求路徑可以是動態的。

（１）靜態路徑：

準確匹配請求路徑，可以定義如下：

GET   /clients/all          controllers.Clients.list()

 （2）動態的部分：

如果要通過ID來搜索路徑，需要用動態指定的方式。

GET   /clients/:id          controllers.Clients.show(id: Long)

The default matching strategy for a dynamic part is defined by the regular expression [^/]+, meaning that any dynamic part defined as :id will match exactly one URI path segment.

通過*id可以來匹配多個URI，如下：

GET   /files/*name          controllers.Application.download(name)

以上的router，對于GET /files/p_w_picpaths/logo.png這樣的請求，name會匹配p_w_picpaths/logo.png。

用自定義正則表達式動態路由

用$id<regex>可以來自定義正則表達式

GET   /items/$id<[0-9]+>    controllers.Items.show(id: Long)

 the parameter is not decoded by the router or encoded by the reverse router. You’re responsible for validating the input to make sure it makes sense in that context.

controller action method

如果方法沒有參數，可以如下定義：

GET   /                     controllers.Application.homePage()

如果有參數，則從請求URI中尋找參數：

# Extract the page parameter from the path.

GET   /:page                controllers.Application.show(page)

或者如下：

# Extract the page parameter from the query string.

GET   /                     controllers.Application.show(page)

show方法的定義如下：

def show(page: String) = Action {
  loadContentFromDatabase(page).map { htmlContent =>
    Ok(htmlContent).as("text/html")
  }.getOrElse(NotFound)

}

如果要把入參轉換成scala的數據類型，就要有下面的router，并且實現相應的方法：

GET   /clients/:id          controllers.Clients.show(id: Long)

def show(id: Long) = Action {
  Client.findById(id).map { client =>
    Ok(views.html.Clients.display(client))
  }.getOrElse(NotFound)

}

固定值的參數：

# Extract the page parameter from the path, or fix the value for /
GET   /                     controllers.Application.show(page = "home")

GET   /:page                controllers.Application.show(page)

默認值方式：

# Pagination links, like /clients?page=3

GET   /clients              controllers.Clients.list(page: Int ?= 1)

Option類型，不需要在每一次傳參時都傳入：

# The version parameter is optional. E.g. /api/list-all?version=3.0

GET   /api/list-all         controllers.Api.list(version: Option[String])

注：多個routes沖突時，使用第一個。

play.api.mvc.Call中提供了HTTP回調，提供了HTTP和URI方法，它用如下方法創建控制器：

package controllers

import play.api._
import play.api.mvc._

class Application extends Controller {

  def hello(name: String) = Action {
    Ok("Hello " + name + "!")
  }

}

如果在conf/routes中有如下定義：

# Hello action
GET   /hello/:name          controllers.Application.hello(name)

那么可以通過controllers.routes.Application實現控制反轉：

// Redirect to /hello/Bob
def helloBob = Action {
  Redirect(routes.Application.hello("Bob"))

}

默認控制器：

# Redirects to https://www.playframework.com/ with 303 See Other
GET   /about      controllers.Default.redirect(to = "https://www.playframework.com/")

# Responds with 404 Not Found
GET   /orders     controllers.Default.notFound

# Responds with 500 Internal Server Error
GET   /clients    controllers.Default.error

# Responds with 501 Not Implemented
GET   /posts      controllers.Default.todo