springboot使用restful风格基本使用和常用注解

为何使用restful风格，为何这样设计？

    restful风格，就是一种面向资源服务的API设计方式，它不是规范，不是标准，它一种设计模式。EST的核心在于，当你设计一个系统的时候，资源是第一位的考虑，你首先从资源的角度进行系统的拆分、设计，而不是像以往一样以操作为角度来进行设计。当我们在写一个进行一个前后端请求时，总是以操作为第一位的设计方法，在以操作为第一位的设计时，首先我们确认了一个操作，然后围绕这个操作把周边需要的东西建设好，这种方式当然可以架构出一个系统，甚至是一个好系统，但是偶尔会有些问题：

   1.操作之间是会有关联，你的设计容易变成“第2个操作要求第1个操作进行过”，这种关系多起来你的系统就乱了。

   2.你的URL设计会缺乏一致性。

   3.操作通常被认为是有副作用（Side Effect）的，所以很少有人基于操作去设计缓存之类的东西。

   而restful风格正是为了解决类似以上问题而产生的一个获得接口入参的设计方法。

   他提供了以下这些注释去区分相应的增删改查。

1、@GetMapping
@RequestMapping(method = RequestMethod.GET)的简写
作用：对应查询，表明是一个查询URL映射

2、@PostMapping
@RequestMapping(method = RequestMethod.POST)的简写
作用：对应增加，表明是一个增加URL映射

3、@PutMapping
@RequestMapping(method = RequestMethod.PUT)的简写
作用：对应更新，表明是一个更新URL映射

4、@DeleteMapping
@RequestMapping(method = RequestMethod.DELETE)的简写
作用：对应删除，表明是一个删除URL映射

5、@PatchMapping
Patch方式是对put方式的一种补充;
put方式是可以更新.但是更新的是整体.patch是对局部更新;

如此一来，我们就可以对于同一个url请求，便可以做出增删改查四个操作，而不是分为了四个url。

例如：对于某个对学生表的增删改查，我们正常这样来设计@requestMapping

@RequestMapping("/queryStudent")
@RequestMapping("/insertStudent")
@RequestMapping("/deleteStudent")
@RequestMapping("/updateStudent")

这就是对于这个student表的操作设计，而restful则允许我们这样去做

@GetMapping("/student")
@PutMapping("/student")
@DeleteMapping("/student")
@PostMapping("/student")

这样当我们在操作student模块时，仅仅使用一个url，用请求方式去区分增删改查，降低了url的复杂度，并且更加的统一和规范。

restful风格的入参的注解

1. @PathVariable
获取路径参数。即url/{id}这种形式
@PathVariable绑定URI模板变量值
@PathVariable是用来获得请求url中的动态参数的
@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上。//配置url和方法的一个关系@RequestMapping(“item/{itemId}”)
2.@RequestParam
获取查询参数。即url?name=这种形式
@RequestParam注解主要有哪些参数：
value：参数名字，即入参的请求参数名字，如username表示请求的参数区中的名字为username的参数的值将传入；
required：是否必须，默认是true，表示请求中一定要有相应的参数，否则将报404错误码；
defaultValue：默认值，表示如果请求中没有同名参数时的默认值，例如：
public List getItemTreeNode(@RequestParam(value=“id”,defaultValue=“0”)long parentId)
3.@RequestBody
@requestBody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。
通过@requestBody可以将请求体中的JSON字符串绑定到相应的bean上，当然，也可以将其分别绑定到对应的字符串上。
4.@ModelAttribute
在使用RESTful风格时，使用get请求，又想使用对象接收参数，就可以使用这个注解
不光适用于get请求，同样也适用于put和delete请求

 

示例代码

本文参考https://blog.csdn.net/Jae_Wang/article/details/80572819

             https://blog.csdn.net/leipeng321123/article/details/89394315#RESTful_2