SpringBoot中REST API 接口傳參的實(shí)現(xiàn)

更新時(shí)間：2023年12月10日 09:48:44 作者：Jimmy

我們?cè)陂_發(fā)?REST API?的過程中,經(jīng)常需要傳遞參數(shù),本文主要介紹了SpringBoot中REST API 接口傳參的實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下

測(cè)試環(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

@PathVariable 注解

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

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

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

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

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

上面的運(yùn)行效果跟截圖展示的效果一樣。

@RequestParam 注解

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

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

我們?cè)?nbsp;postman 上請(qǐng)求 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 + "!";
  }
}

這個(gè)時(shí)候，我們?cè)?nbsp;postman 上傳遞的 username 值，其實(shí)就是賦予了變量 name，如下??

@RequestBody 注解

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

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

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

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

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

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

總結(jié)

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

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

您可能感興趣的文章: