Spring Boot中的 5 种API请求参数读取方式

使用Spring Boot开发API的时候,读取请求参数是服务端编码中最基本的一项操作,Spring Boot中也提供了多种机制来满足不同的API设计要求。

接下来,就通过本文,为大家总结6种常用的请求参数读取方式。如果你发现自己知道的不到5种,那么赶紧来查漏补缺一下。如果你知道的不止6种,那么告诉大家,一起互相学习一下吧~

@RequestParam

这是最最最最最最常用的一个了吧,用来加载URL中?之后的参数。

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

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

@PathVariable

这是RESTful风格API中常用的注解,用来加载URL路径中的参数

比如:这个请求/user/1 就可以如下面这样,使用@PathVariable来加载URL中的id参数

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

@MatrixVariable

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

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

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

@RequestBody

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

less 复制代码
 @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

@RequestHeader注解用来加载请求头中的数据,一般在业务系统中不太使用,但在基础设施的建设中会比较常用,比如传递分布式系统的TraceID等。用法也很简单,比如,假设我们将鉴权数据存在http请求头中,那么就可以像下面这样用@RequestHeader来加载请求头中的Authorization参数

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

好了,今天的分享就到这里。这些方式你都知道吗?如果有学到新知识,欢迎点赞支持。如果你还知道其他方式,也欢迎评论分享。

相关推荐
张先shen2 小时前
Elasticsearch RESTful API入门:索引的增删改查完全指南
java·大数据·elasticsearch·搜索引擎·架构·全文检索·restful
木叶丸3 小时前
AI三大核心概念通俗指南:AIGC、Agent、MCP
人工智能·flutter·架构
CodeWithMe4 小时前
【Note】Linux Kernel 之 内核架构、源码文件、API/ABI 、FHS
linux·运维·架构
谢娘蓝桥4 小时前
[Xmos] Xmos架构
开发语言·架构·xmos
一块plus5 小时前
深度详解 Revive 和 Precompile 技术路径
后端·设计模式·架构
若兰幽竹5 小时前
【基于大模型 + FAISS 的本地知识库与智能 PPT 生成系统:从架构到实现】
架构·powerpoint·faiss
果子⌂5 小时前
Docker-构建镜像并实现LNMP架构
mysql·nginx·docker·容器·架构·php
Java技术小馆6 小时前
langChain开发你的第一个 Agent
java·面试·架构
自由鬼7 小时前
正向代理服务器Squid:功能、架构、部署与应用深度解析
java·运维·服务器·程序人生·安全·架构·代理
沐森7 小时前
对于electron编译和运行上的依赖解释
架构