记录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();
}
相关推荐
drebander5 分钟前
使用 Java Stream 优雅实现List 转化为Map<key,Map<key,value>>
java·python·list
乌啼霜满天2499 分钟前
Spring 与 Spring MVC 与 Spring Boot三者之间的区别与联系
java·spring boot·spring·mvc
tangliang_cn14 分钟前
java入门 自定义springboot starter
java·开发语言·spring boot
程序猿阿伟15 分钟前
《智能指针频繁创建销毁:程序性能的“隐形杀手”》
java·开发语言·前端
Grey_fantasy24 分钟前
高级编程之结构化代码
java·spring boot·spring cloud
新知图书26 分钟前
Rust编程与项目实战-模块std::thread(之一)
开发语言·后端·rust
弗锐土豆31 分钟前
工业生产安全-安全帽第二篇-用java语言看看opencv实现的目标检测使用过程
java·opencv·安全·检测·面部
Elaine20239132 分钟前
零碎04 MybatisPlus自定义模版生成代码
java·spring·mybatis
盛夏绽放1 小时前
Node.js 和 Socket.IO 实现实时通信
前端·后端·websocket·node.js
小小大侠客1 小时前
IText创建加盖公章的pdf文件并生成压缩文件
java·pdf·itext