知識庫 / REST RSS 訂閱

public enum StatusResponse {
    SUCCESS ("Success"),
    ERROR ("Error");
 
    private String status;       
    // constructors, getters
}

5. 實現 RESTful 服務

現在，讓我們實現我們的 REST API 的路由和處理程序。

5.1. 創建控制器

以下 Java 類包含我們 API 的路由，包括動詞、路徑以及每個路由的處理器的概要：

public class SparkRestExample {
    public static void main(String[] args) {
        post("/users", (request, response) -> {
            //...
        });
        get("/users", (request, response) -> {
            //...
        });
        get("/users/:id", (request, response) -> {
            //...
        });
        put("/users/:id", (request, response) -> {
            //...
        });
        delete("/users/:id", (request, response) -> {
            //...
        });
        options("/users/:id", (request, response) -> {
            //...
        });
    }
}

在下面的子章節中，我們將展示每個路由處理器的完整實現。

5.2. 添加用户

以下是使用 POST 方法響應處理程序來添加 User 的示例：

post("/users", (request, response) -> {
    response.type("application/json");
    User user = new Gson().fromJson(request.body(), User.class);
    userService.addUser(user);

    return new Gson()
      .toJson(new StandardResponse(StatusResponse.SUCCESS));
});

注意： 在本示例中，User 對象的 JSON 表示形式作為 POST 請求的原始正文傳遞。

讓我們測試該路由：

請求：

POST http://localhost:4567/users
{
    "id": "1012", 
    "email": "[email protected]", 
    "firstName": "Mac",
    "lastName": "Mason1"
}

響應：

{
    "status":"SUCCESS"
}

5.3. 獲取所有用户

以下是 get 方法響應處理程序，它從 UserService 中返回所有用户：

get("/users", (request, response) -> {
    response.type("application/json");
    return new Gson().toJson(
      new StandardResponse(StatusResponse.SUCCESS,new Gson()
        .toJsonTree(userService.getUsers())));
});

現在讓我們測試一下路由：

請求：

GET http://localhost:4567/users

響應：

{
    "status":"SUCCESS",
    "data":[
        {
            "id":"1014",
            "firstName":"John",
            "lastName":"Miller",
            "email":"[email protected]"
        },
        {
            "id":"1012",
            "firstName":"Mac",
            "lastName":"Mason1",
            "email":"[email protected]"
        }
    ]
}

5.4. 根據ID獲取用户

以下是 方法的響應處理程序，它返回具有給定 的 ：

get("/users/:id", (request, response) -> {
    response.type("application/json");
    return new Gson().toJson(
      new StandardResponse(StatusResponse.SUCCESS,new Gson()
        .toJsonTree(userService.getUser(request.params(":id")))));
});

現在讓我們測試一下路由：

請求：

GET http://localhost:4567/users/1012

響應：

{
    "status":"SUCCESS",
    "data":{
        "id":"1012",
        "firstName":"Mac",
        "lastName":"Mason1",
        "email":"[email protected]"
    }
}

5.5. 編輯用户

以下是 put 方法的響應處理程序，它會編輯擁有路由模式中提供的 id 的用户：

put("/users/:id", (request, response) -> {
    response.type("application/json");
    User toEdit = new Gson().fromJson(request.body(), User.class);
    User editedUser = userService.editUser(toEdit);
            
    if (editedUser != null) {
        return new Gson().toJson(
          new StandardResponse(StatusResponse.SUCCESS,new Gson()
            .toJsonTree(editedUser)));
    } else {
        return new Gson().toJson(
          new StandardResponse(StatusResponse.ERROR,new Gson()
            .toJson("User not found or error in edit")));
    }
});

注意： 在本示例中，數據以 POST 請求的原始正文中作為 JSON 對象傳遞，其屬性名稱與要編輯的 User 對象中的字段相匹配。

讓我們測試該路由：

請求：

PUT http://localhost:4567/users/1012
{
    "lastName": "Mason"
}

響應：

{
    "status":"SUCCESS",
    "data":{
        "id":"1012",
        "firstName":"Mac",
        "lastName":"Mason",
        "email":"[email protected]"
    }
}

5.6. 刪除用户

以下是 delete 方法的處理程序，它將刪除具有指定 id 的 User：

delete("/users/:id", (request, response) -> {
    response.type("application/json");
    userService.deleteUser(request.params(":id"));
    return new Gson().toJson(
      new StandardResponse(StatusResponse.SUCCESS, "user deleted"));
});

現在，讓我們測試一下路由：

請求：

DELETE http://localhost:4567/users/1012

響應：

{
    "status":"SUCCESS",
    "message":"user deleted"
}

5.7. 檢查用户是否存在

<em>options</em> 方法 是一種良好的條件檢查方式。下面是 <em>options</em> 方法 的響應處理程序，它將檢查是否存在具有給定 <em>id</em> 的 <em>User</em>：

options("/users/:id", (request, response) -> {
    response.type("application/json");
    return new Gson().toJson(
      new StandardResponse(StatusResponse.SUCCESS, 
        (userService.userExist(
          request.params(":id"))) ? "User exists" : "User does not exists" ));
});

現在讓我們測試一下路由：

請求：

OPTIONS http://localhost:4567/users/1012

響應：

{
    "status":"SUCCESS",
    "message":"User exists"
}

6. 結論

在本文中，我們對 Spark 框架進行了一般性介紹，用於快速 Web 開發。

該框架主要推廣用於 Java 中生成微服務。 具備 Java 知識的 Node.js 開發者，如果希望利用基於 JVM 庫構建的庫，將在這個框架中感到賓至如歸。