Spring Boot中REST Controller設計

在Spring Boot中設計RESTful API的Controller是一個常見的任務。以下是一個基本的步驟指南，幫助你設計和實現一個簡單的RESTful Controller。

1. 創建Spring Boot項目

首先，確保你已經有一個Spring Boot項目。如果沒有，可以使用Spring Initializr（https://start.spring.io/）快速創建一個。

2. 添加依賴

確保你的pom.xml文件中包含了必要的依賴，例如spring-boot-starter-web，它包含了Spring MVC和嵌入式Tomcat服務器。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

3. 創建Controller類

創建一個新的Java類來定義你的RESTful API。這個類將包含處理HTTP請求的方法。

package com.example.demo;

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api")
public class MyController {

    // 處理GET請求
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }

    // 處理POST請求
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // 這里可以添加業務邏輯，例如保存用戶到數據庫
        return user;
    }

    // 處理GET請求，獲取特定用戶
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        // 這里可以添加業務邏輯，例如從數據庫獲取用戶
        return new User(id, "John Doe");
    }

    // 處理PUT請求，更新用戶信息
    @PutMapping("/users/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        // 這里可以添加業務邏輯，例如更新數據庫中的用戶信息
        return user;
    }

    // 處理DELETE請求，刪除用戶
    @DeleteMapping("/users/{id}")
    public void deleteUser(@PathVariable Long id) {
        // 這里可以添加業務邏輯，例如從數據庫刪除用戶
    }
}

4. 創建實體類

為了使上述代碼工作，你需要創建一個簡單的User實體類。

package com.example.demo;

public class User {
    private Long id;
    private String name;

    // 無參構造函數
    public User() {}

    // 全參構造函數
    public User(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    // Getter和Setter方法
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

5. 啟動類

確保你的項目有一個啟動類，通常是一個帶有@SpringBootApplication注解的類。

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

6. 測試API

啟動你的Spring Boot應用程序，然后使用工具如Postman或curl來測試你的API端點。

• GET /api/hello 應該返回 Hello, World!
• POST /api/users 應該創建一個新的用戶并返回該用戶
• GET /api/users/{id} 應該返回指定ID的用戶
• PUT /api/users/{id} 應該更新指定ID的用戶信息
• DELETE /api/users/{id} 應該刪除指定ID的用戶

通過以上步驟，你已經成功創建了一個簡單的RESTful API Controller。你可以根據需要擴展這個Controller，添加更多的端點和業務邏輯。