@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 的图书详情或用户特定的数据。
相关推荐
大葱白菜几秒前
🧩 Java 枚举详解:从基础到实战,掌握类型安全与优雅设计
java·程序员
expect7g2 分钟前
Flink-Checkpoint-2.OperatorChain
后端·flink
笑衬人心。3 分钟前
在 Mac 上安装 Java 和 IntelliJ IDEA(完整笔记)
java·macos·intellij-idea
大葱白菜3 分钟前
🧱 Java 抽象类详解:从基础到实战,掌握面向对象设计的核心基石
后端·程序员
SimonKing10 分钟前
颠覆传统IO:零拷贝技术如何重塑Java高性能编程?
java·后端·程序员
sniper_fandc20 分钟前
SpringBoot系列—MyBatis(xml使用)
java·spring boot·mybatis
mCell33 分钟前
为什么我们需要 `.proto` 文件
后端·微服务·架构
胚芽鞘6811 小时前
查询依赖冲突工具maven Helper
java·数据库·maven
Charlie__ZS1 小时前
若依框架去掉Redis
java·redis·mybatis
mit6.8241 小时前
[Meetily后端框架] AI摘要结构化 | `SummaryResponse`模型 | Pydantic库 | vs marshmallow库
c++·人工智能·后端