@RequestParam 和 @PathVariable偏好列出推荐图书案例

@RequestParam@PathVariable 是 Spring MVC 中两个非常重要的注解,它们都用于将 Web 请求中的信息绑定到控制器方法的参数上,但它们各自适用于不同的场景。

注解设计结构

业务案例:在线图书商店

例如在开发一个在线图书商店的 Web API,该 API 允许用户搜索图书、查看图书详情、以及根据用户偏好列出推荐图书。

1. 搜索图书

用户可以通过关键字和其他可选参数(如作者、出版年份)来搜索图书。

API Endpoint:

txt 复制代码
GET /api/books?keyword=spring&author=authorName&page=1&size=10

Controller 方法:

java 复制代码
@GetMapping("/api/books")
public ResponseEntity<List<Book>> searchBooks(
        @RequestParam(required = true) String keyword,
        @RequestParam(required = false) String author,
        @RequestParam(defaultValue = "1") int page,
        @RequestParam(defaultValue = "10") int size) {
    List<Book> books = bookService.searchBooks(keyword, author, page, size);
    return ResponseEntity.ok(books);
}

在这个例子中,@RequestParam 注解用于提取请求中的关键字、作者、页码和大小参数。required = true 表示关键字参数是必需的,而其他参数则有默认值。

2. 查看图书详情

用户可以通过图书的 ID 获取图书的详细信息。

API Endpoint:

txt 复制代码
GET /api/books/123

Controller 方法:

java 复制代码
@GetMapping("/api/books/{bookId}")
public ResponseEntity<Book> getBookDetails(@PathVariable Long bookId) {
    Book book = bookService.findBookById(bookId);
    if (book == null) {
        return ResponseEntity.notFound().build();
    }
    return ResponseEntity.ok(book);
}

在这个例子中,@PathVariable 注解用于从 URL 中提取 bookId。如果找不到指定 ID 的图书,则返回 404 状态码。

3. 获取推荐图书

根据用户的购买历史和评分,系统可以推荐图书。

API Endpoint:

txt 复制代码
GET /api/users/{userId}/recommendations

Controller 方法:

java 复制代码
@GetMapping("/api/users/{userId}/recommendations")
public ResponseEntity<List<Book>> getRecommendations(@PathVariable Long userId) {
    List<Book> recommendations = bookService.getRecommendationsForUser(userId);
    return ResponseEntity.ok(recommendations);
}

在这个例子中,@PathVariable 注解用于从 URL 中提取 userId,然后根据用户 ID 获取推荐图书列表。

属性说明

@RequestParam 属性:

  1. value:

    • 类型:String
    • 作用:指定查询参数的名称。这是 @RequestParam 的主要属性,用于匹配请求中的查询字符串参数。
  2. name:

    • 类型:String
    • 作用:为绑定的参数提供自定义名称。如果指定了 name,将使用该名称而不是 value 属性的值。
  3. required:

    • 类型:boolean
    • 默认值:true
    • 作用:指示参数是否必须在请求中提供。如果设置为 true 且请求中没有提供参数,则会抛出 ServletRequestBindingException
  4. defaultValue:

    • 类型:String
    • 作用:提供参数的默认值。如果请求中没有提供参数,或者参数值为空字符串,将使用此默认值。如果请求中提供了参数,但参数值为空字符串,且 required 属性设置为 false,则注入 null

@PathVariable 属性:

  1. value:

    • 类型:String
    • 作用:指定路径变量的名称。这是 @PathVariable 的主要属性,用于匹配 URL 模板中的路径变量。
  2. name:

    • 类型:String
    • 作用:为绑定的参数提供自定义名称。如果指定了 name,将使用该名称而不是 value 属性的值。
  3. required:

    • 类型:boolean
    • 默认值:true
    • 作用:指示路径变量是否必须在 URL 中提供。如果设置为 true 且 URL 中没有提供变量,则会抛出 ServletRequestBindingException
  4. defaultValue:

    • 类型:String
    • 作用:提供路径变量的默认值。如果 URL 中没有提供变量,或者变量值为空字符串,将使用此默认值。通常路径变量是必需的,因此默认值不常用。

总结:

  • @RequestParam 注解用于从请求的查询参数中提取值。它非常适合于搜索、过滤和分页等场景,其中客户端可以传递多个参数来定制响应。
  • @PathVariable 注解用于从请求的 URL 路径中提取变量。它非常适合于访问资源的特定实例,例如获取特定 ID 的图书详情或用户特定的数据。
相关推荐
StayInLove16 分钟前
G1垃圾回收器日志详解
java·开发语言
对许20 分钟前
SLF4J: Failed to load class “org.slf4j.impl.StaticLoggerBinder“
java·log4j
无尽的大道24 分钟前
Java字符串深度解析:String的实现、常量池与性能优化
java·开发语言·性能优化
小鑫记得努力33 分钟前
Java类和对象(下篇)
java
binishuaio37 分钟前
Java 第11天 (git版本控制器基础用法)
java·开发语言·git
zz.YE39 分钟前
【Java SE】StringBuffer
java·开发语言
老友@39 分钟前
aspose如何获取PPT放映页“切换”的“持续时间”值
java·powerpoint·aspose
颜淡慕潇1 小时前
【K8S问题系列 |1 】Kubernetes 中 NodePort 类型的 Service 无法访问【已解决】
后端·云原生·容器·kubernetes·问题解决
wrx繁星点点1 小时前
状态模式(State Pattern)详解
java·开发语言·ui·设计模式·状态模式
Upaaui1 小时前
Aop+自定义注解实现数据字典映射
java