个人中心
gpt4 book ai didi

SpringBoot中的6种API请求参数读取方式

转载 作者：撒哈拉 更新时间：2024-05-23 11:06:10 56 4
gpt4 key购买 nike

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

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

@RequestParam

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

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

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

@PathVariable

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

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

@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中用;分割的参数 。

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

@RequestBody

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

@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参数 。

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

@CookieValue

当我们需要与客户端保持有状态的交互时，就需要用到Cookie。此时，服务端读取Cookie数据的时候，就可以像下面这样用@CookieValue来读取Cookie中的SessionId数据 。

@GetMapping("/user")
@ResponseBody()
public List<User> getUserList(@CookieValue(name = "SessionId") String sessionId) {
     return userRepo.findAll();
}

好了，今天的分享就到这里。这些方式你都知道吗？如果有学到新知识，欢迎点赞支持。如果你还知道其他方式，也欢迎评论分享。如果您学习过程中如遇困难？可以加入我们超高质量的Spring技术交流群，参与交流与讨论，更好的学习与进步！更多Spring Boot教程可以点击直达！，欢迎收藏与转发支持！ 。

欢迎关注我的公众号：程序猿DD。第一时间了解前沿行业消息、分享深度技术干货、获取优质学习资源 。

最后此篇关于SpringBoot中的6种API请求参数读取方式的文章就讲到这里了,如果你想了解更多关于SpringBoot中的6种API请求参数读取方式的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。

56 4 0
文章推荐： 带你彻底搞懂递归时间复杂度的Master公式
文章推荐： JS实现鼠标框选（页面选择）时返回对应的代码或文本内容
文章推荐： QtCreator跨平台开发添加动态库教程（以OpenCV库举例）-Windows篇
文章推荐： C#.Net筑基-类型系统②常见类型
撒哈拉
个人简介

我是一名优秀的程序员,十分优秀！

滴滴打车优惠券免费领取
滴滴打车优惠券
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com