SpringBoot中API接口参数获取方式小结
引言
在Spring Boot中，API接口参数可以通过多种方式获取，具体取决于你定义的API接口参数类型（如路径参数、查询参数、请求体参数、请求头等）。以下是一些常见的参数获取方式以及对应的Java样例代码：
1.路径参数（Path Variable)
使用@PathVariable注解从URL路径中获取参数。
@RestController
@RequestMapping("/users")
public class UserController {
@GetMapping("/{id}")
public ResponseEntity<String> getUserById(@PathVariable Long id) {
// 处理逻辑
return ResponseEntity.ok("User with ID: " + id);
}
}2.查询参数（Query Parameter)
使用@RequestParam注解从URL查询字符串中获取参数。
@RestController
@RequestMapping("/users")
public class UserController {
@GetMapping("/search")
public ResponseEntity<String> searchUsers(@RequestParam String name) {
// 处理逻辑
return ResponseEntity.ok("Searching for user with name: " + name);
}
// 也可以设置默认值
@GetMapping("/searchWithDefault")
public ResponseEntity<String> searchUsersWithDefault(@RequestParam(defaultValue = "John") String name) {
// 处理逻辑
return ResponseEntity.ok("Searching for user with name: " + name);
}
}3.请求体参数（Request Body)
使用@RequestBody注解从HTTP请求体中获取参数，通常用于POST或PUT请求。
@RestController
@RequestMapping("/users")
public class UserController {
@PostMapping("/")
public ResponseEntity<String> createUser(@RequestBody User user) {
// 处理逻辑
return ResponseEntity.ok("User created with name: " + user.getName());
}
// 假设User类如下
static class User {
private String name;
// getters and setters
}
}4.请求头参数（Request Header)
通常不直接使用注解来获取请求头参数，但可以通过HttpServletRequest对象或@RequestHeader注解来获取。
使用@RequestHeader注解:
@RestController
@RequestMapping("/users")
public class UserController {
@GetMapping("/")
public ResponseEntity<String> getUsers(@RequestHeader("Authorization") String authToken) {
// 处理逻辑
return ResponseEntity.ok("Authorization token: " + authToken);
}
}使用HttpServletRequest对象：
@RestController
@RequestMapping("/users")
public class UserController {
@GetMapping("/")
public ResponseEntity<String> getUsers(HttpServletRequest request) {
String authToken = request.getHeader("Authorization");
// 处理逻辑
return ResponseEntity.ok("Authorization token from HttpServletRequest: " + authToken);
}
}5.@CookieValue
当我们需要与客户端保持有状态的交互时，就需要用到Cookie。此时，服务端读取Cookie数据的时候，就可以像下面这样用@CookieValue来读取Cookie中的SessionId数据。
@GetMapping("/user")
@ResponseBody()
public List<User> getUserList(@CookieValue(name = "SessionId") String sessionId) {
return userRepo.findAll();
}6.@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);
}7.表单数据（Form Data)
对于POST请求中的表单数据，通常可以使用@ModelAttribute或@RequestParam来获取。但如果表单数据作为请求体发送（Content-Type: application/x-www-form-urlencoded），则可以直接使用@RequestParam。如果表单数据是JSON格式，则应使用@RequestBody。
8.Servlet API的其他部分
你还可以使用HttpServletResponse、HttpSession等Servlet API的其他部分来处理请求和响应。但在Spring Boot中，通常推荐使用Spring MVC提供的高级抽象来简化开发。
注：为了正确解析请求体中的JSON数据，需要在Spring Boot项目中添加适当的JSON库（如Jackson），并且确保请求的Content-Type设置为application/json。
以上就是SpringBoot中API接口参数获取方式小结的详细内容，更多关于SpringBoot API接口参数的资料请关注脚本之家其它相关文章！
相关文章
这篇文章主要介绍了Java中valueOf和parseInt的区别详解,在编程中,遇到类型转换,好像会经常用到 parseInt 和 valueOf,当然这里只拿 Integer 类型进行陈述,其他类型也是雷同的,需要的朋友可以参考下2024-01-01
这篇文章主要介绍了jfinal的jcaptcha验证码实现方法，大家参考使用吧2014-01-01
springboot2.0配置连接池(hikari、druid)的方法
springboot 2.0 默认连接池就是Hikari了，直接在配置文件中输入配置就可以了，本文通过实例代码给大家介绍了springboot2.0配置连接池(hikari、druid)的方法，感兴趣的朋友一起看看吧2021-12-12
这篇文章主要介绍了mybatis的动态sql之if test的使用说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-02-02
这篇文章主要介绍了浅谈@PostConstruct不被调用的原因及分析，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-02-02
解决Intellij IDEA 使用Spring-boot-devTools无效的问题
下面小编就为大家带来一篇解决Intellij IDEA 使用Spring-boot-devTools无效的问题。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-07-07
这篇文章主要为大家介绍了java设计模式策略模式图文示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-06-06
这篇文章主要介绍了Java微信公众号开发之通过微信公众号获取用户信息,需要的朋友可以参考下2017-05-05
这篇文章主要介绍了Java8 Collectors.toMap的坑，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2021-03-03
Eclipse 出现Failed to load JavaHL Library解决方法
这篇文章主要介绍了Eclipse 出现Failed to load JavaHL Library解决方法的相关资料,今天使用Eclipse 时出现以上错误，本文说明如何更更正，需要的朋友可以参考下2016-11-11
最新评论