我們在開發(fā) REST API 的過程中，經(jīng)常需要傳遞參數(shù)，那么，我們可以怎么做呢？本文，我們將探討 Spring Boot 項目中三種傳遞參數(shù)的方式，如下??

• @PathVariable
• @RequestParam
• @RequestBody

什么是 REST API？REST API 是基于 REST 架構(gòu)原則設(shè)計的一組規(guī)范和約定，用于在不同軟件系統(tǒng)之間進行通信。

測試環(huán)境

• macOs Monterey 12.4 (Apple M1)
• IntelliJ IDEA 2021.2.2(Ultimate Edition)
• java --version (17.0.7)
• maven version 3.9.2
• Spring Boot version 3.2.0
• Postman version 8.12.1

相關(guān)依賴

這里我們不考慮數(shù)據(jù)庫、security 等的引入，相關(guān)的依賴比較簡單，如下：

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

spring-boot-starter-web 是用于開發(fā)基于 Spring Boot 的 Web 應(yīng)用程序的起步依賴，支持 RESTful API 的開發(fā)。

PS：當(dāng)然，我們后期可以引入數(shù)據(jù)庫、JWT 等操作，但是，這個知識點并不是本文的重點

@PathVariable 注解

@PathVariable 注解用于從 URI 中提取模版變量，并將其綁定到方法的參數(shù)上。如下：

@RestController
@RequestMapping("/api")
public class HelloController {
  @GetMapping("/hello/{name}")
  public String sayHello(@PathVariable String name) {
    return "Hello, " + name + "!";
  }
}

啟動程序，在 postman 中輸入 http://localhost:8080/api/hello/Jimmy，即可看到輸出 Hello, Jimmy! 的返回信息。如下圖??

上面的 @GetMapping("/hello/{name}") 和 @PathVariable String name 其實是省略了同名的寫法，如果 GetMapping 中路徑變量和方法的參數(shù)變量不同名，我們需要做下調(diào)整。

@RestController
@RequestMapping("/api")
public class HelloController {
  @GetMapping("/hello/{username}")
  public String sayHello(@PathVariable("username") String name) {
    return "Hello, " + name + "!";
  }
}

上面的運行效果跟截圖展示的效果一樣。

@RequestParam 注解

@RequestParam 注解將 HTTP 請求中的參數(shù)值映射到方法的參數(shù)上。如下示范：

@RestController
@RequestMapping("/api")
public class ParamController {
  @RequestMapping("/param")
  public String requestParamDemo(@RequestParam String name) {
    return "Hello, " + name + "!";
  }
}

我們在 postman 上請求 http://localhost:8080/api/param?name=Jimmy，可看到輸出 Hello, Jimmy! 的字樣。

上面的代碼中傳參還可以是下面的這種推薦寫法：

@RestController
@RequestMapping("/api")
public class ParamController {
  @RequestMapping("/param")
  public String requestParamDemo(@RequestParam("username") String name) {
    return "Hello, " + name + "!";
  }
}

這個時候，我們在 postman 上傳遞的 username 值，其實就是賦予了變量 name，如下??

@RequestBody 注解

@RequestBody 注解 注解用于處理 HTTP 請求體的內(nèi)容映射到方法的參數(shù)上。使用 @RequestBody 注解可以將請求體的內(nèi)容轉(zhuǎn)化為相應(yīng)的 Java 對象，以便在方法中處理。如下例子：

我們先創(chuàng)建一個 bean 類：

@Setter
@Getter
public class Person {
  String username;
}

然后創(chuàng)建一個 controller：

@RestController
@RequestMapping("/api")
public class requestBodyController {
  @RequestMapping("/request-body")
  public String requestBodyDemo(@RequestBody Person person) {
      return "Hello, " + person.getUsername() + "!"; 
  }
}

在 postman 上請求接口 http://localhost:8080/api/request-body，在 Body 請求輸入 json 數(shù)據(jù)，如下：

總結(jié)

本文中，我們一起學(xué)習(xí)了 @PathVariable 注解、RequestParam 注解和 RequestBody 注解來處理 HTTP 請求的傳遞參數(shù)。本文中的案例，我們都是使用了 Get 請求來模擬，但是實際上，RequestBody 用得更多的是在 POST 新增記錄和 PUT 修改記錄的情況。三個注解搭配使用，完成參數(shù)的傳遞。

到此這篇關(guān)于SpringBoot中REST API 接口傳參的實現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot REST API 接口傳參內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論