Spring MVC 是一種常用的 Java Web 框架，用于構建基于請求-響應模型的 Web 應用程序。在 Spring MVC 中，處理請求的控制器（Controller）需要接收用戶傳遞的參數(shù)。Spring MVC 提供了多種接收請求參數(shù)的方式，可以讓開發(fā)者靈活地獲取用戶輸入并進行相應的處理。本篇文章將詳細介紹 Spring MVC 接收參數(shù)的幾種方式，包括常見的@RequestParam、@PathVariable、@RequestBody、@ModelAttribute 等注解的使用方法，幫助開發(fā)者深入理解如何在 Spring MVC 中高效、安全地獲取請求參數(shù)。
一、使用@RequestParam接收請求參數(shù)
@RequestParam 注解是 Spring MVC 中最常用的接收請求參數(shù)的方式。它用于將 HTTP 請求中的參數(shù)映射到方法的參數(shù)中。常見的使用場景包括從表單或 URL 中獲取單個參數(shù)。
使用 @RequestParam 時，通常需要指定請求參數(shù)的名稱。如果請求參數(shù)名稱和方法參數(shù)名稱一致，可以省略名稱。除此之外，還可以使用 "required" 屬性指定該參數(shù)是否為必填項，使用 "defaultValue" 屬性指定默認值。
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@RequestMapping("/getUser")
public String getUser(@RequestParam(name = "userId", required = true) String userId,
@RequestParam(name = "userName", defaultValue = "Guest") String userName) {
return "User ID: " + userId + ", User Name: " + userName;
}
}在這個示例中，當請求 URL 為 "/getUser?userId=123&userName=Tom" 時，"userId" 和 "userName" 會分別傳遞給方法中的參數(shù) "userId" 和 "userName"。
二、使用@PathVariable接收路徑變量
@PathVariable 注解用于獲取 URL 中的路徑變量。它非常適用于 RESTful 風格的接口設計，其中 URL 中的一部分是動態(tài)變化的。例如，獲取用戶 ID、文章編號等信息。
@PathVariable 通常用于處理 REST API 接口中的動態(tài)路徑參數(shù)，它能夠直接從 URL 中提取信息，而不需要使用請求參數(shù)。
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ArticleController {
@RequestMapping("/article/{articleId}")
public String getArticle(@PathVariable("articleId") String articleId) {
return "Article ID: " + articleId;
}
}在上述示例中，URL "/article/123" 會將 "articleId" 的值設置為 "123"，傳遞給方法中的 "articleId" 參數(shù)。
三、使用@RequestBody接收請求體參數(shù)
@RequestBody 注解用于接收 HTTP 請求體中的內(nèi)容。它常用于接收 JSON、XML 或其他類型的請求體數(shù)據(jù)。@RequestBody 可以將請求體自動綁定到 Java 對象中，支持自動的 JSON 與 Java 對象之間的轉(zhuǎn)換（需要 Jackson 等庫的支持）。
在處理復雜對象（如 JSON 格式的數(shù)據(jù)）時，@RequestBody 是一個非常有效的選擇。
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@RequestMapping("/createUser")
public String createUser(@RequestBody User user) {
return "Created User: " + user.getName() + ", Age: " + user.getAge();
}
}在上述代碼中，"User" 是一個普通的 Java 對象，它包含 "name" 和 "age" 屬性。請求的 JSON 內(nèi)容應該類似于以下格式：
{
"name": "John",
"age": 30
}Spring 會自動將請求體中的 JSON 數(shù)據(jù)轉(zhuǎn)換為 "User" 對象，并傳遞給 "createUser" 方法中的 "user" 參數(shù)。
四、使用@ModelAttribute接收表單數(shù)據(jù)
@ModelAttribute 注解用于將請求中的表單數(shù)據(jù)自動綁定到 Java 對象上。它通常用于處理表單提交數(shù)據(jù)。與 @RequestParam 類似，@ModelAttribute 也能夠?qū)⒍鄠€請求參數(shù)綁定到一個 Java 對象中，這對于復雜的表單數(shù)據(jù)非常有用。
@ModelAttribute 可以用來將表單提交的字段自動映射為對象的屬性，使得數(shù)據(jù)的處理更加簡潔和直觀。
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@RequestMapping("/submitForm")
public String submitForm(@ModelAttribute User user) {
return "User Name: " + user.getName() + ", User Age: " + user.getAge();
}
}在這個例子中，如果用戶提交一個包含 "name" 和 "age" 字段的表單數(shù)據(jù)，Spring 會自動將這些字段的值映射到 "User" 對象的屬性中。
五、使用HttpServletRequest直接獲取請求參數(shù)
除了使用注解，Spring MVC 還支持通過 "HttpServletRequest" 對象直接獲取請求參數(shù)。雖然這種方式比較傳統(tǒng)，但它仍然適用于一些特殊場景。
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@RequestMapping("/getUserByRequest")
public String getUser(HttpServletRequest request) {
String userId = request.getParameter("userId");
String userName = request.getParameter("userName");
return "User ID: " + userId + ", User Name: " + userName;
}
}通過 "HttpServletRequest" 對象，開發(fā)者可以調(diào)用 "getParameter" 方法獲取請求中的參數(shù)。這種方式需要手動提取每一個參數(shù)，通常不如注解方式簡潔，但在某些情況下仍然很有用。
六、使用@RequestHeader接收請求頭參數(shù)
@RequestHeader 注解用于接收請求中的頭部信息（Header）。HTTP 請求頭中通常包含一些元數(shù)據(jù)，如用戶的語言、認證信息、客戶端類型等。通過 @RequestHeader 注解，可以方便地獲取這些信息。
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HeaderController {
@RequestMapping("/getUserAgent")
public String getUserAgent(@RequestHeader("User-Agent") String userAgent) {
return "User Agent: " + userAgent;
}
}在這個示例中，當請求頭中包含 "User-Agent" 信息時，Spring 會自動將該值綁定到方法的 "userAgent" 參數(shù)中。
七、總結(jié)
Spring MVC 提供了多種接收請求參數(shù)的方式，每種方式都有其適用的場景。@RequestParam 用于處理簡單的請求參數(shù)；@PathVariable 適用于 RESTful 風格的 URL 參數(shù)；@RequestBody 方便處理 JSON 格式的請求體數(shù)據(jù)；@ModelAttribute 適合用于表單提交數(shù)據(jù)的自動綁定；通過 HttpServletRequest 可以靈活地獲取請求參數(shù)；而 @RequestHeader 則用于獲取請求頭中的信息。
開發(fā)者可以根據(jù)業(yè)務需求和接口設計選擇最合適的參數(shù)接收方式。掌握這些方法能夠幫助我們更高效地處理 Spring MVC 中的請求參數(shù)，從而提高開發(fā)效率和代碼可維護性。
