Springboot 入门学习记录:创建 RESTful 接口处理前端请求

目录

1.核心理念:约定大于配置

2.项目基础:启动类与控制器

3.HTTP 方法详解

1.GET方法:查询资源

2.Post方法:创建资源或提交数据

3.PUT方法:更新资源

4.Delete方法:删除资源

4.参数传递方式总结:

5.统一返回格式建议:

6.学习小结:


1.核心理念:约定大于配置

Spring Boot 作为主流的 Java 后端框架,极大简化了 Web 应用的开发流程。本文将带你从零开始,创建一个能接收前端请求的接口,并掌握 HTTP 四大方法(GET、POST、PUT、DELETE)的使用方式。

2.项目基础:启动类与控制器

springboot主要作为后端服务器来使用,当前端向服务器发送请求后,由springboot提供的接口来接收请求、处理请求并返回相应数据。

使用idea创建的springboot项目,必须要有启动类,启动类必须添加@SpringBootApplication注解

那么怎么创建一个接口用来接收前端发送的请求呢。

在idea中,我创建了一个HelloController类  并给他添加了@RestController注解 这个注解告诉了Springboot  这是一个处理请求的类,它会自动去抓取那些向服务器发送数据的请求并交给对应处理请求类来处理。

3.HTTP 方法详解

接下来我将介绍HTTP请求中比较常见的四种方法:

1.GET方法:查询资源

        GET方法的主要使用场景:获取单个资源详情(如用户信息),获取资源列表(如用户列表),搜索、分页、过滤

在springboot中使用@GetMapping("/路径名")或@RequestMapping("/路径名", method = RequestMethod.GET)

举例:

这就是一个Get方法,它用来接收路径名为/hello的请求并返回一个"hello world"的字符串.

这是使用postman模拟前端发送的get请求,可以看到请求了8080端口下的hello方法 服务器也成功返回了"hello world"。

在继续下面的学习前,我先定义一个用户类

并在HelloController类中创建User类集合

GET请求支持两种参数类型 :路径参数和查询参数

路径参数:使用@PathVariable  

举例:

可以从请求中将{id}的id获取到作为形参传给当前方法使用。

成功返回所需要的用户信息。

查询参数:使用@RequestParam

在路径后面添加需要查询的参数 如页数、姓名、编号

服务器通过@RequestParam 类型  变量名的方法一一将路径中的参数对应到形参中去。

2.Post方法:创建资源或提交数据

主要用于提交表单、创建用户、执行复杂操作

在springboot中使用@PostMapping注解或@RequestMapping(method = RequestMethod.POST, value = "/路径名")

主要支持的参数类型:@RequestBody  @RequestParam

@RequestBody:接收JSON 请求体,  主要用于创建对象

举例:

接收/createUser路径下的Post方法  形参要求为@RequestBody的JSon请求体  类型为User类型

模拟发送一个id为4 name为"孙6" 的Json 格式   由@RequestBody注解 自动映射到User类中 并添加给User的集合  返回User集合的所有数据。

@RequestParam:主要用于接收表单数据 

举例:

通过@RequestParam 接收表单参数一一对应到形参上,例子通过id将对应id的User对象的name修改为传入的name。

可以看到id为1的User name已经被修改.

3.PUT方法:更新资源

主要使用场景:

  • 完全替换一个已有资源(前端传完整对象)
  • 更新用户资料、商品信息等

在Springboot中使用@PutMapping方法或@RequestMapping(value = "/{id}", method = RequestMethod.PUT)

例子:

Put请求路径参数为动态参数id,通过@PathVariable接收,通过@RequestBody接收传进来的Json数据体映射给user1.然后完成找到对应id修改姓名的操作.

4.Delete方法:删除资源

主要使用场景:删除单个资源(指定用户)

在Springboot中使用@@DeleteMapping("/{id}") 方法或@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)

例子:

删除指定id

4.参数传递方式总结:

路径参数@PathVariable   实例: /users/{id}  

查询参数@RequestParam  实例: ?name=Tom&page=1

请求体(JSon)@RequestBody 实例: {"name":"Tom"}

表单数据@RequestParam   <form> 提交

方法总结:Get用于查询  Post用于创建或复杂方法 PUT用于替换  DELETE尽量只用路径参数

5.统一返回格式建议:

为提升 API 可维护性和前端体验,建议封装统一返回结果

接口返回示例:

响应 JSON:

6.学习小结:

  • ✅ Spring Boot 通过 @RestController 快速构建 RESTful 接口。
  • ✅ 四大 HTTP 方法各有用途:
    • GET:查
    • POST:增 / 复杂操作
    • PUT:改(完整更新)
    • DELETE:删
  • ✅ 参数传递方式需根据场景选择:路径、查询、JSON、表单。
  • ✅ 统一返回格式 是专业 API 设计的标配。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值