记录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();
}
相关推荐
麻芝汤圆14 分钟前
MapReduce 的广泛应用:从数据处理到智能决策
java·开发语言·前端·hadoop·后端·servlet·mapreduce
努力的搬砖人.14 分钟前
java如何实现一个秒杀系统(原理)
java·经验分享·后端·面试
哈哈哈哈哈哈哈哈哈...........20 分钟前
【java】在 Java 中,获取一个类的`Class`对象有多种方式
java·开发语言·python
fallwind_of_july25 分钟前
java项目分享-分布式电商项目附软件链接
java·redis·分布式·mongodb·elasticsearch·微服务·rabbitmq
怒放吧德德28 分钟前
实际应用:使用Nginx实现代理与服务治理
后端·nginx
6<732 分钟前
【go】空接口
开发语言·后端·golang
武昌库里写JAVA41 分钟前
Golang的消息中间件选型
java·开发语言·spring boot·学习·课程设计
Asthenia041244 分钟前
BCrypt vs MD5:加盐在登录流程和数据库泄露中的作用
后端
工一木子44 分钟前
大厂算法面试 7 天冲刺:第6天-树与图深度剖析——高频算法面试题 & Java 实战
java·算法·面试
追逐时光者1 小时前
由 MCP 官方推出的 C# SDK,使 .NET 应用程序、服务和库能够快速实现与 MCP 客户端和服务器交互!
后端·.net·mcp