使用IDEA創建一個簡單的基於Spring Boot的RESTful Web Service

使用IDEA創建一個簡單的基於Spring Boot的RESTful Web Service

這個例子創建了一個可以通過以下地址接收到HTTP GET請求的服務
http://localhost:8080/checkin?name=XXX
並返回一個以下格式的JSON
{"content":"Hello XXX!"}

註解說明

1. @RestController：
   該註解由以下幾個註解組成
@Retention(value=RUNTIME)
@Documented
@Controller
@ResponseBody用於說明該類是一個接受Rest請求的控制器類
2. @RequestMapping(“/checkIn”)
   用於說明該方法是一個用於處理資源請求的方法，處理對於HTTP請求
3. @RequestParam(value = “name”, defaultValue = “null”)
   用於獲取HTTP GET請求參數列表中name對應的值，如果爲空則設置默認值爲null
4. @SpringBootApplication
   SpringBoot項目的主方法入口點，一個項目只能有一個該註解

程序代碼

• User.java

public class User{

    private final String content;

    public User(String content){
        this.content = content;
    }

    public String getContent() {
        return content;
    }
}

• CheckInController.java

@RestController
public class CheckInController {

    private static final String template = "Hello,%s!";

    @RequestMapping("/checkIn")
    public User checkIn(@RequestParam(value = "name", defaultValue = "null") String name){
        return new User(String.format(template, name));
    }
}

• CheckinApplication.java

@SpringBootApplication
public class CheckinApplication {

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

運行結果