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)。

相关推荐
Z21-X14 分钟前
云原生运维学习笔记:ECShop全链路容器化部署与Docker底层资源隔离深度剖析
运维·笔记·学习·云原生
晓梦林5 小时前
BUUCTF-菜刀流量-MISC-学习笔记
笔记·学习
SL_staff20 小时前
JVS-BI 实战:业务人员如何用零代码 ELT + 可视化配置构建实时经营分析闭环
java·spring·全栈
David猪大卫21 小时前
【C++修炼】map 和 set 的使用
c语言·开发语言·数据结构·c++·经验分享·笔记·学习
星恒随风21 小时前
MySQL 从零入门(三):表的约束详解
linux·服务器·数据库·笔记·mysql
nice_lcj5201 天前
【从零理解 Spring AI · 12】MCP 的两种角色:做客户端还是做服务端
java·后端·spring·spring ai·ai应用开发
蒸蒸yyyyzwd1 天前
从后端面经学到的 3 个知识
笔记·学习
17岁的勇气1 天前
Unity Shader unity文档学习笔记(二十二):shader变体
笔记·学习·unity
杨凯凡1 天前
Spring Framework 7 HTTP Interface 实战:声明式 RestClient、超时与测试
java·spring·http
坤坤子吖1 天前
Linux网络编程:自定义应用层协议与 JSON 序列化
linux·服务器·网络·c++·笔记·json