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();
}

  • 3
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
### 回答1: Spring Boot常见的注解有: 1. @SpringBootApplication:用于标记主类,表示该类是Spring Boot应用的入口类。该注解主要包含了@ComponentScan、@EnableAutoConfiguration和 @Configuration三个注解。 2. @RestController:用于标记Controller类,表示该类是Spring MVC的控制器,并且会自动将返回的数据转换为JSON格式。 3. @RequestMapping:用于映射请求URL和Controller方法之间的关系,可以用在类级别和方法级别。在类级别上使用时,会为该类的所有方法的URL添加一个前缀。 4. @GetMapping、@PostMapping、@PutMapping、@DeleteMapping:这些注解分别用于标记GET、POST、PUT、DELETE请求的处理方法。它们与@RequestMapping的作用类似,用于指定请求的URL和HTTP方法。 5. @RequestParam:用于从请求参数获取值,将请求参数与方法参数进行绑定。 6. @PathVariable:用于从URL路径获取值,将路径变量与方法参数进行绑定。 7. @RequestBody:用于将请求体的内容绑定到方法参数上,常用于接收JSON格式的请求数据。 8. @ResponseBody:用于将方法返回的对象转换为HTTP响应体,并将其发送给客户端。 9. @Autowired:用于自动注入依赖对象,Spring Boot会自动扫描并创建相应的对象,并将它们注入到标记了@Autowired的属性上。 10. @Configuration:用于标记配置类,指示Spring Boot需要对该类进行额外配置。 以上只是一些常见的注解,Spring Boot还有许多其他的注解供开发者使用,用于不同的场景和功能需求。 ### 回答2: Spring Boot是一个Java框架,提供了很多常见的注解来简化开发。以下是一些常见的Spring Boot注解: 1. @SpringBootApplication:这是一个组合注解,用于标注主类。它包含了@EnableAutoConfiguration、@ComponentScan和@Configuration注解,用于自动配置、扫描组件和声明配置文件。 2. @RestController:该注解用于标注一个类,表示这是一个RESTful风格的控制器,用于处理HTTP请求和返回响应。 3. @RequestMapping:用于将请求映射到处理方法或控制器类上。 4. @Autowired:用于自动装配Bean,通过依赖注入来实现组件的自动装配。 5. @Component:用于将类标记为一个Spring组件,通过自动扫描和注册,将其作为Bean管理。 6. @Configuration:标识该类是一个配置类,用于声明Spring的配置信息。 7. @Value:用于注入属性值,从配置文件读取。 8. @PathVariable:用于获取URL的路径参数。 9. @RequestParam:用于获取HTTP请求请求参数。 10. @ResponseBody:用于将方法的返回值直接作为HTTP响应体返回。 11. @ExceptionHandler:用于捕获处理方法抛出的异常,并进行统一处理。 12. @Transactional:用于标记一个方法或类需要进行事务管理。 13. @Service:用于标记一个类为服务层的组件。 14. @Repository:用于标记一个类为数据访问层的组件。 15. @Aspect:用于声明一个切面,定义横切关注点和通知类型。 以上只是常见的一些Spring Boot注解,还有其他更多的注解用于实现不同的功能和特性。 ### 回答3: Spring Boot常见的注解包括: 1. @SpringBootApplication:用于标记主类,表示这是一个Spring Boot应用程序的入口点。它是由三个注解组成的组合注解:@SpringBootConfiguration、@EnableAutoConfiguration和@ComponentScan。 2. @RestController:用于标记一个类,表示该类是一个RESTful风格的控制器。它将类的方法的返回值直接作为响应内容,而不是返回视图。 3. @RequestMapping:用于映射HTTP请求的URL路径到方法上。可以用在类和方法上,用于指定处理请求的路径。 4. @GetMapping、@PostMapping、@PutMapping、@DeleteMapping:这些注解分别用于映射HTTP的GET、POST、PUT、DELETE请求到方法上,可以指定路径,并且支持Ant风格的路径匹配。 5. @PathVariable:用于将URL路径参数绑定到方法的参数上。通常与@RequestMapping一起使用,用于处理带有路径参数请求。 6. @RequestParam:用于从请求的URL、查询参数或者表单参数获取参数的值,并绑定到方法的参数上。 7. @RequestBody:用于接收HTTP请求请求体,并绑定到方法的参数上。通常用于处理POST请求的JSON/XML数据。 8. @ResponseBody:用于将方法的返回值直接作为响应内容返回给客户端。通常用于处理RESTful风格的API请求。 9. @Autowired:用于自动装配依赖的Bean。它可以注入Spring容器的Bean,减少手动配置依赖的繁琐操作。 10. @ConfigurationProperties:用于将配置文件的属性值绑定到Spring Boot应用程序的配置类。 以上是Spring Boot常见的注解,这些注解可以帮助我们更方便地开发和配置Spring Boot应用程序。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ISBN图书

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值