当前位置:

首页 > 编程开发 > SpringBoot接口参数接收指南:从URL到请求体,4种方式一次掌握

SpringBoot接口参数接收指南:从URL到请求体,4种方式一次掌握

SpringBoot中接收前端参数有四种常用注解:@PathVariable用于URL路径变量(例如用户ID),@RequestParam用于查询参数(例如分页),@RequestHeader用于请求头(例如认证令牌),@RequestBody用于JSON请求体(例如创建资源)。开发者需根据具体业务场景和请求结构选择合适的注解。

本文目录

    前言

    前后端分离已经成了主流开发模式,前端怎么向后端传递参数?这几乎是每个 Spring Boot 开发者都绕不开的基础技能。下面这张图先帮你快速建立起整体印象:

    SpringBoot接口参数接收指南:从URL到请求体,4种方式一次掌握

    今天这篇文章,就把 Spring 中最常见的四种参数接收方式掰开揉碎讲清楚,配合简单示例,帮你搞清楚它们各自的使用场景和差异。

    1. Request 简介

    在正式介绍注解之前,先快速了解一下 HTTP 请求的数据结构。一个典型的 HTTP 请求由三部分组成:

    • 请求行:包括 URL 路径、方法(GET、POST)等;
    • 请求头(Headers):携带客户端信息、Token 等;
    • 请求体(Body):通常用于 POST/PUT 请求,存放结构化数据(如 JSON)。

    四种注解的本质,就是从这些不同部分中把参数提取出来。

    2. 四种方式速览

    Spring Boot 接收前端数据,常用的方式有哪几种?下面这四种就是最常见的:

    • @PathVariable:用于接收 URL 路径中的参数;
    • @RequestParam:用于接收查询参数或表单数据;
    • @RequestHeader:用于接收请求头中的信息;
    • @RequestBody:用于接收 JSON 或 XML 格式的请求体数据。

    后文会依次展开,说清楚每个注解怎么用、什么时候用。

    3. @PathVariable 注解

    用于接收 URL 路径中的变量,比如 /user/{id}。这在 RESTful 风格的接口里非常常见。

    示例:

    @GetMapping("/user/{id}")
    public String getUser(@PathVariable Long id) {
        return "User ID: " + id;
    }
    

    想从路径里拿用户ID?直接写个 {id} 占位,再用 @PathVariable 绑定参数,干净利落。

    4. @RequestHeader 注解

    用于接收请求头里的参数,最典型的场景就是读取 Token、User-Agent 这类信息。

    示例:

    @GetMapping("/device")
    public String getDevice(@RequestHeader("User-Agent") String userAgent) {
        return "User-Agent: " + userAgent;
    }
    

    如果你需要根据客户端类型做差异化处理,直接从请求头里拿 User-Agent 就行。

    5. @RequestParam 注解

    用于接收 URL 中的查询参数,或者表单提交的数据。GET 请求的查询参数拼接在 URL 后面,POST 请求如果 Content-Type 是 application/x-www-form-urlencoded,表单数据也会以键值对形式编码放在请求体里。这两种情况,@RequestParam 都能搞定。

    示例:

    @GetMapping("/search")
    public String search(@RequestParam String keyword) {
        return "Searching: " + keyword;
    }
    

    比如搜索接口,参数直接拼在 URL 上,用 @RequestParam 接收,简单粗暴。

    6. @RequestBody 注解

    用于接收请求体中的 JSON 或 XML 数据,通常配合 POST/PUT 请求和实体类一起使用。

    示例:

    @PostMapping("/login")
    public String login(@RequestBody User user) {
        return "Welcome " + user.getUsername();
    }
    

    注意:GET 请求没有请求体,不能使用 @RequestBody。只有 Content-Type 为 application/json 的 POST/PUT 请求,才适合用它来接收 JSON 数据。而且一个方法中只能有一个 @RequestBody 注解,通常用 Ja va Bean、DTO 或 Map 来接收整体结构化数据。

    7. 总结

    回顾一下,Spring Boot 接收前端参数的四种常用注解,选用哪种完全取决于你的业务场景和前端的请求结构:

    • URL 参数:@PathVariable
    • 查询参数 / 表单数据:@RequestParam
    • 请求头信息:@RequestHeader
    • JSON 请求体:@RequestBody

    把这些基础注解吃透,开发 Web 接口时就能更得心应手,API 也会更清晰、更规范。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    n8n 2.47.6、2.47.7、2.48.3 Beta、2.48.4 Beta、3.2.2预发布与1.123.96适用哪些安全修复?
    n8n 2.47.6、2.47.7、2.48.3 Beta、2.48.4 Beta、3.2.2预发布与1.123.96适用哪些安全修复?

    按维护分支、利用权限与节点类型对应四项修复,区分正式补丁、Beta和临时缓解的适用边界。

    GitHub合并故障的已缓解、监控与已解决有什么不同
    GitHub合并故障的已缓解、监控与已解决有什么不同

    GitHub合并故障中的“已缓解并监控”和“已解决”不能互换。前者表示影响已经采取措施缓解,仍在观察稳定性;后者是供应商正式结束这场事故的状态。11月13日的Pull Requests合并超时事件先进入监控,随后于北京时间11月14日02:29标记为已解决。

    llama.cpp v1.0.0的网页聊天分组与Markdown编辑适合哪些场景
    llama.cpp v1.0.0的网页聊天分组与Markdown编辑适合哪些场景

    llama.cpp v1.0.0改善聊天组织、长消息编辑和附件预览;界面变化与底层API迁移、缓存及访问边界需要分别理解。

    Postman 12.36.4 更新后仍报错,怎么判断是哪一层的问题
    Postman 12.36.4 更新后仍报错,怎么判断是哪一层的问题

    Postman 12.36.4 更新后仍有异常时,可按应用、API请求和平台服务区分问题范围,避免把补丁版本当作故障原因。

    n8n 2.47.6、2.48.3 Beta与1.123.96适合哪些部署环境?
    n8n 2.47.6、2.48.3 Beta与1.123.96适合哪些部署环境?

    按正式、预发布和1.x维护渠道对应补丁,再结合Redis、Agent端点和Pinecone索引判断适用范围。

    Codex CLI 0.169.0与0.171.0-alpha.2怎样选择,终端工作区适合哪些任务
    Codex CLI 0.169.0与0.171.0-alpha.2怎样选择,终端工作区适合哪些任务

    Codex CLI 0.169.0提供有明确说明的终端工作区能力;0.171.0-alpha.2为预发布,当前没有功能清单,选用时应分开评估。

    llama.cpp b12345的Hexagon后端支持哪些Q5量化格式?
    llama.cpp b12345的Hexagon后端支持哪些Q5量化格式?

    llama.cpp b12345的预发布构建为Hexagon HTP后端增加Q5_0和Q5_1支持。选择模型时需要核对完整量化名称及实际运行后端,不能只看到“Q5”就视为同一种格式。

    llama.cpp b12344的MCP工具调用在断连或超时后会怎样处理?
    llama.cpp b12344的MCP工具调用在断连或超时后会怎样处理?

    llama.cpp b12344的预发布构建调整了MCP工具调用的取消行为:客户端断连或调用超时时,服务器会向MCP服务发送带请求ID的取消通知。使用服务端工具的Web界面也属于这项变更范围。

    GitHub Actions与Checks同时排队失败时,如何区分平台故障?
    GitHub Actions与Checks同时排队失败时,如何区分平台故障?

    GitHub对11月5日Actions与Checks事件的新增复盘指出:数据库服务在高并发大读请求下耗尽资源,导致部分运行无法排队或执行失败。检查类似问题时,先比对平台事件时间与失败状态,再决定是否重试自己的工作流。

    GitHub Actions运行卡住占用并发时,应检查哪些状态?
    GitHub Actions运行卡住占用并发时,应检查哪些状态?

    GitHub对11月9日Actions事件的新增复盘说明:数据库迁移后,新区域容量与速率限制不足导致请求被拒,部分运行在服务恢复后仍占用并发。排查自己的工作流时,应把平台状态、运行状态与应用代码错误分开核对。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。