知識庫 / REST RSS 訂閱

public Result greet(String name, int age) {
    return ok("Hello " + name + ", you are " + age + " years old");
}

前往以下路徑：

GET     /greet/:name/:age               controllers.HomeController.greet(name: String, age: Integer)

請注意 Scala 中聲明變量的語法，即 age: Integer。在 Java 中，我們會使用 Integer age 這種語法。Play Framework 是用 Scala 構建的。因此，大量的 Scala 語法被廣泛使用。

現在，讓我們加載 http://localhost:9000/greet/john/26：

Hello john, you are 26 years old

6.2. 路徑參數中的通配符

在我們的路由配置文件中，最後的映射是：

GET     /assets/*file  controllers.Assets.versioned(path="/public", file: Asset)

我們使用通配符在路徑的動態部分。我們告訴 Play，無論哪個值替換路徑中的 *file，都應該作為一個整體進行解析，而不會像其他路徑參數的情況那樣進行解碼。

在這個例子中，控制器是一個內置的控制器，Assets，它允許客户端從 play-routing/public 文件夾下載文件。當我們加載 http://localhost:9000/assets/images/favicon.png 時，我們應該在瀏覽器中看到 Play 的 favicon 圖像，因為它位於 /public/images 文件夾中。

讓我們在 HomeController.java 中創建一個自定義的 action：

public Result introduceMe(String data) {
    String[] clientData = data.split(",");
    return ok("Your name is " + clientData[0] + ", you are " + clientData[1] + " years old");
}

請注意，在這一操作中，我們接收一個 String 參數並應用我們的邏輯對其進行解碼。在這種情況下，邏輯是將逗號分隔的 String 分割成一個數組。此前，我們依賴路由器來解碼這些數據。

使用通配符時，我們必須自己處理。我們希望客户端能夠正確地使用我們的語法傳遞這些數據。理想情況下，我們應該在使用前驗證傳入的 String。

讓我們創建一個路由到此操作：

GET   /*data   controllers.HomeController.introduceMe(data)

現在加載 URL http://localhost:9000/john,26。這將打印：

Your name is john, you are 26 years old

6.3. 路徑參數中的正則表達式

與通配符類似，我們可以使用正則表達式來處理動態部分。下面添加一個接收數字並返回其平方的操作：

public Result squareMe(Long num) {
    return ok(num + " Squared is " + (num * num));
}

現在我們將添加它的路由：

GET   /square/$num<[0-9]+>   controllers.HomeController.squareMe(num:Long)

讓我們將此路由放置在 introduceMe 路由下方，以介紹一個新概念。 僅當此路由配置下，正則表達式部分為正整數時，我們才能處理路由。

現在，如果我們按照上一段中的指示放置了該路由，並加載 http://localhost:9000/square/2，我們應該收到一個 ArrayIndexOutOfBoundsException：

如果我們在服務器控制枱檢查錯誤日誌，我們會發現該操作調用實際上是在 introduceMe 操作中執行的，而不是 squareMe 操作。 就像前面所説，關於通配符，我們自己負責，並且沒有驗證傳入的數據。

而不是逗號分隔的字符串，introduceMe 方法被調用時，傳入的字符串是 “square/2”。 因此，分割後，我們得到一個大小為一的數組。 嘗試訪問索引 1 導致拋出異常。

自然，我們期望該調用被路由到 squareMe 方法。 為什麼它被路由到 introduceMe？ 這是我們將在下一部分介紹的 Play 功能 Routing Priority。

7. 路由優先級

如果存在路由衝突，例如 squareMe 和 introduceMe 之間，則 Play 會選擇聲明順序中的第一個路由

為什麼會出現衝突？因為通配符上下文路徑 /*data 匹配所有請求 URL，除了基本路徑 /。因此，所有使用通配符的 URI 模式的路由應該在聲明順序中最後出現

現在，讓我們更改路由的聲明順序，使得 introduceMe 路由在 squareMe 路由之後，並重新加載：

2 Squared is 4

為了測試路由中正則表達式的強大功能，嘗試加載 http://locahost:9000/square/-1，路由器將無法匹配 squareMe 路由。相反，它會匹配 introduceMe，並且我們再次會得到 ArrayIndexOutOfBoundsException。

這是因為 -1 不匹配提供的正則表達式，任何字母字符也不會匹配。

8. 參數

在此之前，我們已經介紹了在路由文件中聲明參數類型的語法。

在本節中，我們將探討在路由中處理參數時可用的更多選項。

8.1. 帶有固定值的參數

有時，我們可能希望為參數使用固定的值。 這樣做是為了告訴 Play 使用提供的路徑參數，或者如果請求上下文為路徑 ，則使用一個固定的值。

public Result writer() {
    return ok("Routing in Play by Baeldung");
}

Routing in Play by Baeldung

public Result writer(String author) {
    return ok("REST API with Play by " + author);
}

GET     /writer           controllers.HomeController.writer(author = "Baeldung")
GET     /writer/:author   controllers.HomeController.writer(author: String)

Routing in Play by Baeldung

Routing in Play by john

author = "Baeldung"

author ?= "Baeldung"

public Result writer(String author, int id) {
    return ok("Routing in Play by: " + author + " ID: " + id);
}

GET     /writer           controllers.HomeController.writer(author="Baeldung", id: Int ?= 1)
GET     /writer/:author   controllers.HomeController.writer(author: String, id: Int ?= 1)

Routing in Play by: Baeldung ID: 1

Routing in Play by: Baeldung ID: 10

Routing in Play by: john ID: 1

Routing in Play by: john ID: 5