Spring Boot 怎么使用 @GetMapping 与 @PostMapping 规范 RESTful 接口动词

老枫吖_7799

老枫吖_7799

2026-09-25

283人浏览

原创

spring boot 用 @getmapping 和 @postmapping 直接体现 http 动词语义,使接口意图一目了然;/users 路径下,get 查列表或单个,post 新增用户,路径只表资源,动词由注解决定,严格遵循 restful 设计原则。

spring boot 怎么使用 @getmapping 与 @postmapping 规范 restful 接口动词

Spring Boot 用 @GetMapping 和 @PostMapping 规范 RESTful 接口动词,核心是把 HTTP 方法语义直接“写进注解名”,而不是藏在 @RequestMapping 的 method 属性里。这样一眼就能看出这个接口是查数据还是提数据,不用读方法体、不靠命名猜意图。

动词和资源要严格对应

RESTful 不是加个注解就完事,关键在设计逻辑:HTTP 方法就是操作类型,URL 路径只表达资源本身。

  • GET 请求必须对应查询动作,路径用复数名词,比如 /users、/users/123,不能写成 /getUser 或 /queryUserById
  • POST 请求必须对应新建动作,路径仍是资源集合,比如 /users,表示“往用户集合里新增一个用户”,不是 /createUser
  • 同一个路径 /users,用 @GetMapping 是查全部用户,用 @PostMapping 是新增用户——动词由注解决定,路径保持语义纯净

@GetMapping 处理查询类请求

它本质是 @RequestMapping(method = RequestMethod.GET) 的语义封装,专用于获取资源,天然排斥非 GET 请求。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 查列表:@GetMapping("/users") → 返回用户集合
  • 查单个:@GetMapping("/users/{id}"),配合 @PathVariable Long id 提取路径参数
  • 带条件查询:@GetMapping("/users"),用 @RequestParam 接收 ?name=xxx&page=1 这类查询参数,不放请求体
  • 不支持请求体(@RequestBody),如果误加了,Spring 会报 400 错误,这是它的保护机制

@PostMapping 处理新建类请求

它等价于 @RequestMapping(method = RequestMethod.POST),明确限定只响应 POST,且默认期望接收 JSON 数据体。

  • 新增资源:@PostMapping("/users"),参数用 @RequestBody User user 接收完整对象
  • 不推荐从 URL 或表单参数取主体数据,避免语义混乱;如需额外控制字段,可用 @RequestHeader 或 @RequestParam 补充元信息
  • 成功后建议返回 ResponseEntity.created(URI.create("/users/123")).body(user),带 201 状态码和新资源地址,符合 RESTful 响应规范
  • 如果前端发 GET 到这个接口,直接 405 Method Not Allowed,不会误执行业务逻辑

组合使用时注意层级与前缀统一

避免每个方法都写全路径,用类级 @RequestMapping 抽公共前缀,再用组合注解细化动作。

  • 在 Controller 类上加 @RequestMapping("/api/v1/users"),所有方法自动继承该路径
  • 方法上只写相对路径:@GetMapping → 实际映射 GET /api/v1/users;@PostMapping → POST /api/v1/users
  • 单个资源操作写成 @GetMapping("/{id}"),Spring 自动绑定路径变量,不需要手动解析字符串
  • 别在路径里塞动词,例如 @PostMapping("/users/add") 违反 RESTful 原则,也削弱了注解的语义价值

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2151

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

417

25

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

531

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1415

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

4066

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

416

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

600

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

365

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

331

18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习