REST风格
REST简介
REST即表述性状态传递(英文:Representational State Transfer,简称REST),是Roy Fielding博士2000年在他的博士论文中提出来的一种软件架构风格。它是一种针对网络应用的设计和开发方式,可以降低开发的复杂性,提高系统的可伸缩性。
表述性状态转移是一组架构约束条件和原则,满足这些约束条件和原则的应用程序或设计就是RESTful。需要注意的是,REST是设计风格而不是标准。REST通常基于HTTP,URL,和XML(标准通用标记语言下的一个子集)以及HTML(标准通用标记语言下的一个应用)这些现有的广泛流行的协议和标准使用。
用一句话来表述REST的实质:通过名词(复数)定位资源,用HTTP协议中的动词(GET、POST、PUT、DELETE)来实现资源的增删改查。
请求方式
请求方式 | 含义 |
---|---|
GET(SELECT) | 从服务器取出资源(一项或多项) |
POST(CREATE) | 在服务器新建一个资源 |
PUT(UPDATE) | 在服务器更新资源(更新完整资源) |
DELETE(DELETE) | 从服务器删除资源 |
RESTful与传统风格对比
功能 | 传统 | REST | REST后台接收 |
---|---|---|---|
查询 | http://localhost:8080/employee/list?id=1 | http://localhost:8080/employees/1 | @RequestMapping(value = “/employees/{id}”, method = RequestMethod.GET) @ResponseBody public Employee getById(@PathVariable Integer id){} |
添加 | http://localhost:8080/employee/add | http://localhost:8080/employees | @RequestMapping(value = “/employees”, method = RequestMethod.POST) @ResponseBody public Employee add(@RequestBody Employee employee) {} |
修改 | http://localhost:8080/employee/update | http://localhost:8080/employees | @RequestMapping(value = “/employees”, method = RequestMethod.PUT) @ResponseBody public Employee update(@RequestBody Employee employee) {} |
删除 | http://localhost:8080/employee/delete | http://localhost:8080//employees/{id} | @RequestMapping(value = “/employees/{id}”, method = RequestMethod.DELETE) @ResponseBody public Boolean delete(@PathVariable Integer id) {} |
注:
- 当参数较多时,采用@RequestBody注解通过JSON数组的方式传递数据;
- 当参数较少时,采用@PathVariable注解通过URL中参数来传递数据;
- 当参数名比较敏感时,可以通过参数路径的方式来隐藏参数名
相关注解
注解 | 作用 |
---|---|
@RestController | 由 @Controller + @ResponseBody组成(返回 JSON 数据格式) |
@PathVariable | URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到控制器处理方法的形参中 |
@RequestMapping | 注解用于请求地址的解析,是最常用的一种注解 |
@GetMapping | 查询请求 |
@PostMapping | 添加请求 |
@PutMapping | 更新请求 |
@DeleteMapping | 删除请求 |
@RequestParam | 将请求参数绑定到控制器的方法参数上(是springmvc中接收普通参数的注解) |