Spring Boot中的 6 种API请求参数读取方式示例详解

 更新时间:2024年05月23日 10:21:48   作者:程序猿DD  
使用Spring Boot开发API的时候,读取请求参数是服务端编码中最基本的一项操作,Spring Boot中也提供了多种机制来满足不同的API设计要求,这篇文章主要介绍了Spring Boot中的 6 种API请求参数读取方式示例详解,需要的朋友可以参考下

使用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 Boot中的 6 种API请求参数读取方式的文章就介绍到这了,更多相关Spring Boot API请求参数读取内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java中String.split()用法小结

    Java中String.split()用法小结

    这篇文章主要介绍了Java中String.split()用法小结的相关资料,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2016-07-07
  • Spring的RequestBodyAdvice拦截浅析

    Spring的RequestBodyAdvice拦截浅析

    本文主要介绍了Spring的RequestBodyAdvice拦截浅析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-02-02
  • 重新认识Java的System.in

    重新认识Java的System.in

    今天小编就为大家分享一篇关于重新认识Java的System.in,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Kotlin 基础教程之注解与java中的注解比较

    Kotlin 基础教程之注解与java中的注解比较

    这篇文章主要介绍了Kotlin 基础教程之注解与java中的注解比较的相关资料,需要的朋友可以参考下
    2017-06-06
  • Spring Boot在启动时执行一次的功能实现

    Spring Boot在启动时执行一次的功能实现

    这篇文章主要给大家介绍了关于Spring Boot在启动时执行一次的功能实现,在实习过程中,有时候会遇到一些项目启动初始化的需求,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2023-08-08
  • idea导入若依项目教程

    idea导入若依项目教程

    文章介绍了如何在IntelliJ IDEA中导入若依管理系统项目,并详细步骤包括克隆项目、修改配置文件、创建数据库、运行项目和前端展示
    2025-03-03
  • IDEA 2020代码提示忽略大小写的问题

    IDEA 2020代码提示忽略大小写的问题

    这篇文章主要介绍了IDEA 2020代码提示忽略大小写的问题,本文通过图文并茂的形式给大家分享解决方法,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • java中消息推送功能的关键实现代码

    java中消息推送功能的关键实现代码

    在日常开发中,消息推送是非常典型的业务需求,下面这篇文章主要介绍了java中消息推送功能的关键实现代码,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-09-09
  • 详解Maven安装教程及是否安装成功

    详解Maven安装教程及是否安装成功

    这篇文章主要介绍了详解Maven安装教程及是否安装成功,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • java显示目录文件列表和删除目录功能

    java显示目录文件列表和删除目录功能

    这篇文章主要介绍了java显示目录文件列表和删除目录功能,文章通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2017-12-12

最新评论