记录Spring Boot中的API请求参数读取方式

一、背景

项目开发中经常使用Spring Boot开发API,所以读取请求参数是服务端编码中最基本最常见的操作项,Spring Boot中也提供多种机制来满足不同的API设计要求。接下来就记录一下项目中用过的6种请求参数读取方式。

@RequestParam

用来加载请求URL中"?"之后的参数。比如:这个请求 /user?name=abc 就可以如下面这样,使用@RequestParam来加载URL中的name参数:

java 复制代码
@GetMapping("/user")
@ResponseBody
public User findUserByName(@RequestParam("name") String name){ 
    return userRepo.findByName(name);
}
@PathVariable

RESTful风格API中常用的注解,用来加载URL路径中的参数。比如:这个请求/user/1 就可以如下面这样,使用@PathVariable来加载URL中的id参数:

java 复制代码
@GetMapping("/user/{id}")
@ResponseBody
public User findUserById(@PathVariable("id") String id){ 
    return userRepo.findById(id);
}
@MatrixVariable

用的并不是很多,有些国外系统有提供这类API参数,这种API的参数通过;分割。

比如:请求/books/reviews;id=1234;topN=5; 就可以如下面这样,使用@MatrixVariable来加载URL中用;分割的参数:

java 复制代码
@GetMapping("/books/reviews")
@ResponseBody
public List<BookReview> getBookReviews( 
  @MatrixVariable String id,  @MatrixVariable Integer topN) {
  return bookReviewsLogic.getTopNReviewsByIsbn(isbn, topN);
}
@RequestBody

用来加载POST/PUT请求的复杂请求体(也叫:payload)。比如,客户端需要提交一个复杂数据的时候,就要将这些数据放到请求体中,然后服务端用@RequestBody来加载请求体中的数据

java 复制代码
@PostMapping("/add")
public boolean addAccounts(@RequestBody List<Account> accounts) throws SQLException {
     accounts.stream().forEach(a -> {
         a.setCreatedOn(Timestamp.from(Instant.now()));
         a.setLastLogin(Timestamp.from(Instant.now()));
     });
     return notificationLogic.addAccounts(accounts);
}
@RequestHeader

用来加载请求头中的数据,在业务系统中不太使用,但在基础设施的建设中或者鉴权请求中会比较常用,比如传递分布式系统的TraceID等。比如,假设将鉴权数据存在http请求头中,就可以用@RequestHeader来加载请求头中的Authorization参数:

java 复制代码
@GetMapping("/user")
@ResponseBody()
public List<User> getUserList(@RequestHeader("Authorization") String authToken) {
     return userRepo.findAll();
}
@CookieValue

需要与客户端保持有状态的交互时,就需要用到Cookie。此时,服务端读取Cookie数据的时候,就可以用@CookieValue来读取Cookie中的SessionId数据:

java 复制代码
@GetMapping("/user")
@ResponseBody()
public List<User> getUserList(@CookieValue(name = "SessionId") String sessionId) {
     return userRepo.findAll();
}
相关推荐
最强小杰8 小时前
某 OpenAI 兼容网关上的 `kimi-k3.1-pro`:Cline、Zed 接入与 SSE 排错示例
java·服务器·网络·ai
皮皮林5518 小时前
京东又开源一款新框架,用起来真优雅!
后端
Flynn Liang8 小时前
流量治理不是限流那么简单:I/O 密集型 Java 服务的 6 层防线
java·微服务·高并发·限流·熔断·系统稳定性·resilience4j
学长毕设8 小时前
基于SpringBoot智慧养老服务平台设计与实现-附源码
java·spring boot·后端
曹牧9 小时前
Java:“刷新雪崩”
java·开发语言
秋天的怀念_David9 小时前
算法一千零一夜 · 第三十三夜 · 跳表
java·程序人生·算法
千寻技术帮9 小时前
10454_基于Springboot的企业购销链管理系统
spring boot·mysql·vue·毕业设计·进销存
Forget the Dream10 小时前
Spring AI 2.0 系列(二):第一个 ChatClient——从注入到一次完整调用
java·人工智能·spring boot·ai·springai
行百里er11 小时前
【Spring Insight 技术分享】跨服务调用链路是怎么串起来的?
后端·spring·开源
火山引擎和TA的超级拍档们11 小时前
产品情报局 11 | AI 数据湖 LAS:打造大模型时代多模态数据底座
前端·后端