当前位置:   article > 正文

SpringBoot——SpringBoot中使用RESTful风格_springboot restful

springboot restful

文章目录:

1.一些新的注解

1.1 @RestController

1.2 @RequestMapping(常用)

1.3 @GetMapping

1.4 @PostMapping

1.5 @PutMapping

1.6 @DeleteMapping

1.7 @PathVariable

2.SpringBoot实现RESTful风格

2.1 实例代码

2.2 GET请求方式

2.3 DELETE请求方式

2.4 POST请求方式

2.5 PUT请求方式

3.RESTful风格中请求冲突的问题


1.一些新的注解

1.1 @RestController

@RestController:Spring 4 后新增注解,是@Controller 注解功能的增强,是 @Controller 与 @ResponseBody 的组合注解。

如果一个 Controller 类添加了@RestController,那么该 Controller 类下的所有方法都相当于添加了@ResponseBody 注解,用于返回字符串或 json 数据。

1.2 @RequestMapping(常用)

 支持 Get 请求,也支持 Post 请求

1.3 @GetMapping

@RequestMapping 和 Get 请求方法的组合,只支持 Get 请求,Get 请求主要用于查询操作。

1.4 @PostMapping

@RequestMapping 和 Post 请求方法的组合,只支持 Post 请求,Post 请求主要用户新增数据。

1.5 @PutMapping

@RequestMapping 和 Put 请求方法的组合,只支持 Put 请求,Put 通常用于修改数据。

1.6 @DeleteMapping

@RequestMapping 和 Delete 请求方法的组合,只支持 Delete 请求,通常用于删除数据。

1.7 @PathVariable

获取 url 中的数据,该注解是实现 RESTful 最主要的一个注解。


2.SpringBoot实现RESTful风格

REST (英文:Representational State Transfer ,简称 REST )

一种互联网软件架构设计的风格,但它并不是标准,它只是提出了一组客户端和服务器交互时的架构理念和设计原则,基于这种理念和原则设计的接口可以更简洁,更有层次,REST这个词,是 Roy Thomas Fielding 在他 2000 年的博士论文中提出的。

任何的技术都可以实现这种理念,如果一个架构符合 REST 原则,就称它为 RESTFul 架构。

比如我们要访问一个 http 接口:http://localhost:8080/springboot/order?id=1021&status=1

采用 RESTFul 风格则 http 地址为:http://localhost:8080/springboot/order/1021/1

2.1 实例代码

首先是一个实体类

  1. package com.songzihao.springboot.entity;
  2. public class Student {
  3. private Integer id;
  4. private String name;
  5. private Integer age;
  6. //getter and setter
  7. }

然后是我们的控制层

  1. package com.songzihao.springboot.controller;
  2. import org.springframework.web.bind.annotation.*;
  3. import java.util.HashMap;
  4. import java.util.Map;
  5. /**
  6. *
  7. */
  8. @RestController //相当于是 @Controller 与 @ResponseBody 的组合注解,意味着当前控制层类中的所有方法返回的都是Json对象
  9. public class StudentController {
  10. @GetMapping(value = "/student/{id}/{age}")
  11. public Object student(@PathVariable("id") Integer id,
  12. @PathVariable("age") Integer age) {
  13. Map<String,Object> map=new HashMap<>();
  14. map.put("id",id);
  15. map.put("age",age);
  16. return map;
  17. }
  18. @DeleteMapping(value = "/student/detail/{id}/{status}")
  19. public Object student2(@PathVariable("id") Integer id,
  20. @PathVariable("status") Integer status) {
  21. Map<String,Object> map=new HashMap<>();
  22. map.put("id",id);
  23. map.put("status",status);
  24. return map;
  25. }
  26. @DeleteMapping(value = "/student/{id}/detail/{phone}")
  27. public Object student3(@PathVariable("id") Integer id,
  28. @PathVariable("phone") Integer phone) {
  29. Map<String,Object> map=new HashMap<>();
  30. map.put("id",id);
  31. map.put("phone",phone);
  32. return map;
  33. }
  34. @PostMapping(value = "/student/{id}")
  35. public String addStudent(@PathVariable("id") Integer id) {
  36. return "add student ID: " + id;
  37. }
  38. @PutMapping(value = "/student/{id}")
  39. public String updateStudent(@PathVariable("id") Integer id) {
  40. return "update student ID: " + id;
  41. }
  42. }

接下来是springboot的核心配置文件

  1. server.port=8082
  2. server.servlet.context-path=/springboot

最后通过springboot项目入口类启动

  1. package com.songzihao.springboot;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication
  5. public class Application {
  6. public static void main(String[] args) {
  7. SpringApplication.run(Application.class, args);
  8. }
  9. }

由于请求方式的不同(有GET、POST、PUT、DELETE),这里我使用Postman工具来模拟发送请求,查看测试结果。

2.2 GET请求方式

2.3 DELETE请求方式

2.4 POST请求方式

2.5 PUT请求方式


3.RESTful风格中请求冲突的问题

对于下面这两段代码,就会出现请求冲突的问题。

  1. @DeleteMapping(value = "/student/detail/{id}/{status}")
  2. public Object student2(@PathVariable("id") Integer id,
  3. @PathVariable("status") Integer status) {
  4. Map<String,Object> map=new HashMap<>();
  5. map.put("id",id);
  6. map.put("status",status);
  7. return map;
  8. }
  1. @DeleteMapping(value = "/student/detail/{id}/{phone}")
  2. public Object student2(@PathVariable("id") Integer id,
  3. @PathVariable("phone") Integer phone) {
  4. Map<String,Object> map=new HashMap<>();
  5. map.put("id",id);
  6. map.put("phone",phone);
  7. return map;
  8. }

因为当我们发起请求之后,服务器并不知道这个地址 http://localhost:8082/springboot/student/1001/666 对应的是那个方法

解决的方法有两个:

  1. 修改路径。(见下面的代码)
  2. 修改请求方式。(这个意思是说,将请求方式由DELETE改为其他三种,所以就不再举例了)
  1. @DeleteMapping(value = "/student/detail/{id}/{status}")
  2. public Object student2(@PathVariable("id") Integer id,
  3. @PathVariable("status") Integer status) {
  4. Map<String,Object> map=new HashMap<>();
  5. map.put("id",id);
  6. map.put("status",status);
  7. return map;
  8. }

  1. @DeleteMapping(value = "/student/{phone}/detail/{id}")
  2. public Object student3(@PathVariable("id") Integer id,
  3. @PathVariable("phone") Integer phone) {
  4. Map<String,Object> map=new HashMap<>();
  5. map.put("id",id);
  6. map.put("phone",phone);
  7. return map;
  8. }

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/小舞很执着/article/detail/799689
推荐阅读
相关标签
  

闽ICP备14008679号