spring mvc 创建restapi 笔记

java 复制代码
@RestController
@RequestMapping("/spittles")
public class SpittleController {

    // 示例:使用 @RequestBody 接收 JSON 并自动转换为 Spittle 对象
    @PostMapping
    public Spittle saveSpittle(@RequestBody Spittle spittle) {
        // 此时 Spring 已经把请求体中的 JSON/XML 解析成了 spittle 对象
        // 你可以直接使用 spittle 做保存、处理等操作
        return spittle; 
        // 这里返回的 spittle 会再次被自动转换为 JSON 并写到响应体中
    }
}

每个注解都是什么意思? 有什么作用?

首先知道,一个流程,例如我们一个请求过来,格式是json格式。并且是url过来。

@RestController:@Controller + @ResponseBody

类中所有方法生效,这意味着该控制器的所有方法返回值默认都直接写到 HTTP 响应体,而非去渲染一个视图(JSP、Thymeleaf 等)

这个是为前后端分离项目后,不需要去渲染,有这个注解就会跳过这一步。直接返回http相应体。

@Controller:如果方法返回一个字符串,Spring 会默认将其视为"视图名",再由视图解析器找到对应的模板去渲染 HTML 页面。

@RestController:所有方法返回值会直接序列化成 JSON(或其他格式)写回客户端(也就是常说的返回纯数据,不走视图渲染)

@RestController 一般用于编写 RESTful API,客户端(例如前端框架Vue/React或Postman)拿到的是 JSON 数据,而不是一个服务端渲染好的页面。

@RequestMapping("/spittles"):统一给这个控制器的所有方法加上路径前缀 /spittles。

我在类上用 @PostMapping,方法上也用 @PostMapping 可以吗?"

java 复制代码
技术上虽然可能不报错,但实际很少这么做。通常类上只设置"公共路径前缀",不限定 HTTP 方法;具体方法用 @PostMapping 等区分 GET、POST、PUT...... 这样更灵活,也更符合 REST 设计。

@RequestBody 是序列化标识吗?"

更准确说是**"反序列化标识":告诉 Spring "请求体里是 JSON/XML,要把它转换为**某个 Java 对象当作参数"。

而 @ResponseBody(或 @RestController) 则用于"把返回的 Java 对象序列化成 JSON/XML 写回响应体"。

Accept头部包含 application/json 的请求?

@RequestMapping 或 @GetMapping 中加上 produces="application/json",告诉 Spring 只能满足 "希望拿到 JSON" 的客户端。

如果请求头中没有 Accept: application/json,又没有其他匹配的控制器方法,Spring 就不会执行这个方法,会返回 406(Not Acceptable)。

相关推荐
冷雨夜中漫步3 小时前
Python快速入门(6)——for/if/while语句
开发语言·经验分享·笔记·python
JH30734 小时前
SpringBoot 优雅处理金额格式化:拦截器+自定义注解方案
java·spring boot·spring
Gain_chance5 小时前
34-学习笔记尚硅谷数仓搭建-DWS层最近一日汇总表建表语句汇总
数据仓库·hive·笔记·学习·datagrip
Gain_chance6 小时前
36-学习笔记尚硅谷数仓搭建-DWS层数据装载脚本
大数据·数据仓库·笔记·学习
肖永威7 小时前
macOS环境安装/卸载python实践笔记
笔记·python·macos
暗光之痕7 小时前
Unreal5研究笔记 Actor的生命周期函数
笔记·unreal engine
Gain_chance7 小时前
35-学习笔记尚硅谷数仓搭建-DWS层最近n日汇总表及历史至今汇总表建表语句
数据库·数据仓库·hive·笔记·学习
2301_818732067 小时前
前端调用控制层接口,进不去,报错415,类型不匹配
java·spring boot·spring·tomcat·intellij-idea
码字的字节8 小时前
Spring Cloud服务注册与发现(一):手把手搭建Eureka Server,详解高可用配置
spring·spring cloud·eureka
大厂资深架构师8 小时前
Spring Cloud Eureka在后端系统中的服务剔除策略
spring·spring cloud·ai·eureka