您的位置:首页 > 软件教程 > 教程 > Spring Boot中常用的请求参数读取方式

Spring Boot中常用的请求参数读取方式

来源:好特整理 | 时间:2024-05-23 11:55:17 | 阅读:100 |  标签: T Pi API Ri S in   | 分享到:

使用Spring Boot开发API的时候,读取请求参数是服务端编码中最基本的一项操作,Spring Boot中也提供了多种机制来满足不同的API设计要求。 接下来,就通过本文,为大家总结6种常用的请求参数读取方式。如果你发现自己知道的不到6种,那么赶紧来查漏补缺一下。如果你知道的不止6种,那么告诉

在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

这个注解用于加载URL中用 ; 分割的参数,虽然我们用的并不是很多,但一些国外系统有提供这类API参数。

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

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

@RequestBody

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

@PostMapping("/add")
public boolean addAccounts(@RequestBody List 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 getUserList(@RequestHeader("Authorization") String authToken) {
     return userRepo.findAll();
}

@CookieValue

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

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

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

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

小编推荐阅读

好特网发布此文仅为传递信息,不代表好特网认同期限观点或证实其描述。

RPG Ri序章 0.2.1
RPG Ri序章 0.2.1
类型:角色扮演  运营状态:正式运营  语言: 日文  

游戏攻略

游戏礼包

游戏视频

游戏下载

游戏活动

《RPG_Ri序章》是GameMaker'Child-Dream'制作的一款幻想废土风RPG手游,完全免费的幻想废土风RPG登场!元

相关视频攻略

更多

扫二维码进入好特网手机版本!

扫二维码进入好特网微信公众号!

本站所有软件,都由网友上传,如有侵犯你的版权,请发邮件admin@haote.com

湘ICP备2022002427号-10 湘公网安备:43070202000427号© 2013~2024 haote.com 好特网