基于MVCRESTful风格的实现

1.RESTful风格阐述

REST服务是一种ROA(Resource-Oriented Architecture,面向资源的架构)应用。主要特点是方法信息存在于HTTP协议的方法中(GET,POST,PUT,DELETE),作用域存在于URL中。例如,在一个获取设备资源列表的GET请求中,方法信息是GET,作用域信息是URI种包含的对设备资源的过滤、分页和排序等条件

良好的REST API不需要任何文档

1.1REST风格资源路径

REST风格的资源路径设计是面向资源的,资源的名称应该是准确描述该资源的名词。

资源路径概览:sheme://host:port/path?queryString

例:http://localhost:8080/bywlstudio/users/user?username=xiuer

1.2HTTP方法

GET用于读取、检索、查询、过滤资源

PSOT用于创建一个资源

PUT用于修改、更新资源、创建客户端维护主键信息的资源

DELETE用于删除资源

资源地址和HTTP方法结合在一起就可以实现对资源的完整定位

1.3RESTful风格API设计

上文讲述了通过HTTP方法和资源路径对服务器的一个资源进行定位的过程

接下来看一个REST风格API的设计

功能 描述
添加/创建 POST/users
PUT/users{id}[^创建客户端维护主键信息的资源]
删除 DELETE/users/{id}
修改/更新 PUT/users/{id}
查询全部 GET/users
主键查询 GET/users/{id}
GET/users?id=26
分页作用域查询 GET/users?start=0&size=10
GET/users?07,2019-07,2020

可以看到通过这个RESTAPI都是通过对同一个资源的操作,所不同的就是通过不同的HTTP方法来实现对资源不同的处理。

2.MVCREST的支持

1.1主要通过注解来实现
  • @Controller声名一个处理请求的控制器

  • @RequestMapping请求映射地址,它存在几个子注解对于实现REST风格来说更加具有语义性

    • @GETMapping GET请求
    • @PUTMapping PUT请求
    • @POSTMapping POST请求
    • @DELETEMapping DELETE请求
  • @ResponseBody 将响应内容转换为JSON格式

  • @RequestBody 请求内容转换为JSON格式

  • @PathVariable("id")用于绑定一个参数

  • @RESTController 等同于@Controller+@ResponseBody在类上写了这个注解,标识这个类的所有方法只返回数据,而不进行视图跳转

1.2返回HTTP状态码

REST风格API一个最鲜明的特点通过返回对应的HTTPStatus来判断客户端的操作是否完成

下面是spring中关于Http状态码描述的枚举类,本文列举了常见的状态码(读者若对此感兴趣可以查看HttpStatus源码)

  1. public enum HttpStatus{
  2. OK(200, "OK"),//用于服务器有实体响应
  3. CREATED(201, "Created"),//创建了新实体,响应该实体
  4. NO_CONTENT(204, "No Content"),//服务器正常响应,但无实体响应
  5. BAD_REQUEST(400, "Bad Request"),//客户端请求语法错误
  6. NOT_FOUND(404, "Not Found"),//目标资源不存在
  7. INTERNAL_SERVER_ERROR(500, "Internal Server Error"),//服务器内部错误
  8. NOT_IMPLEMENTED(501, "Not Implemented"),//服务器不支持当前请求
  9. }

Spring返回状态码是通过@ResponseStatus注解或者ResponseEntity<?>类实现的。

@ResponseStatus方式

  1. @GetMapping(path = "/user/{id}" , produces = "application/json;charset=utf-8")
  2. @ResponseStatus(HttpStatus.OK)
  3. public User findUserById(@PathVariable("id")Integer id){
  4. User user = userService.findUserById(id);
  5. return user ;
  6. }

ResponseEntity<?>方式

  1. @GetMapping(produces = "application/json;charset=utf-8")
  2. public ResponseEntity<List<User>> findAll(){
  3. List<User> users = userService.findAll();
  4. return new ResponseEntity<List<User>>(users , HttpStatus.OK);
  5. }
1.3由于MVC默认不支持PUTDELETE方法,所以需要手动开启

tomcat服务器的web.xml文件中开启一下配置

  1. <servlet>
  2. <servlet-name>default</servlet-name>
  3. <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
  4. <init-param>
  5. <param-name>debug</param-name>
  6. <param-value>0</param-value>
  7. </init-param>
  8. <init-param>
  9. <param-name>listings</param-name>
  10. <param-value>false</param-value>
  11. </init-param>
  12. <init-param>
  13. <param-name>readonly</param-name>
  14. <param-value>true</param-value><!--开启这个-->
  15. </init-param>
  16. <load-on-startup>1</load-on-startup>
  17. </servlet>

在项目的web.xml中配置

  1. <filter>
  2. <filter-name>HiddenHttpMethodFilter</filter-name>
  3. <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
  4. </filter>
  5. <filter-mapping>
  6. <filter-name>HiddenHttpMethodFilter</filter-name>
  7. <servlet-name>dispathcherServlet</servlet-name>
  8. </filter-mapping>

3.MVC实现REST代码实现

3.1实例环境
  • JDK1.8
  • maven3.60
  • tomcat9
3.2API设计
URI Description Response HTTPStatus
GET/users 获取全部用户 JSON 200
GET/users/{id} 获取指定主键的用户 JSON 200
PUT/users/{id} 修改指定的主键的用户信息 JSON 200/201
POST/users 增加一个用户 JSON 201
DELETE/users/{id} 删除一个用户 void 204
3.3控制层代码
  1. @RestController
  2. @RequestMapping("/users")
  3. public class UserControler {
  4. @Autowired
  5. private IUserService userService ;
  6. //REST风格实现方法
  7. /**
  8. * 查询所有
  9. * @return
  10. */
  11. @GetMapping(produces = "application/json;charset=utf-8")
  12. public ResponseEntity<List<User>> findAll(){
  13. List<User> users = userService.findAll();
  14. return new ResponseEntity<List<User>>(users , HttpStatus.OK);
  15. }
  16. /**、
  17. * 根据ID查询
  18. * @param id
  19. * @return
  20. */
  21. @GetMapping(path = "/{id}" , produces = "application/json;charset=utf-8")
  22. @ResponseStatus(HttpStatus.OK)
  23. public User findUserById(@PathVariable("id")Integer id){
  24. User user = userService.findUserById(id);
  25. return user ;
  26. }
  27. /**
  28. * 增加一个用户
  29. * 返回该用户
  30. */
  31. @PostMapping(produces = "application/json;charset=utf-8")
  32. @ResponseStatus(HttpStatus.CREATED)
  33. public User addUser(@RequestBody User user){
  34. User newUser = userService.addUser(user);
  35. return newUser ;
  36. }
  37. /**
  38. * 更新
  39. * @param user
  40. */
  41. @PutMapping(path = "/{id}" ,produces = "application/json;charset=utf-8")
  42. public ResponseEntity<User> updateUser(@PathVariable("id") Integer id , @RequestBody User user){
  43. user.setUid(id);
  44. //资源是否修改
  45. boolean flag = userService.updateUser(user);
  46. User deUser = userService.findUserById(id);
  47. if(flag)
  48. return new ResponseEntity<User>(deUser,HttpStatus.CREATED);
  49. return new ResponseEntity<User>(deUser,HttpStatus.OK);
  50. }
  51. @DeleteMapping(path = "/{id}" , produces = "application/json;charset=utf-8")
  52. @ResponseStatus(HttpStatus.NO_CONTENT)
  53. public void delUser(@PathVariable("id") Integer id){
  54. User user = userService.findUserById(id);
  55. userService.delUser(id);
  56. }
  57. }

更多原创文章和Java学习资料清关注@公众号MakerStack

基于MVC的RESTFul风格API实战的更多相关文章

  1. 基于MVC的RESTful风格的实现

    基于MVC的RESTful风格的实现 1.RESTful风格阐述 REST服务是一种ROA(Resource-Oriented Architecture,面向资源的架构)应用.主要特点是方法信息存在于 ...

  2. Restful风格API接口开发springMVC篇

    Restful风格的API是一种软件架构风格,设计风格而不是标准,只是提供了一组设计原则和约束条件.它主要用于客户端和服务器交互类的软件.基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机 ...

  3. 第03章—打造RESTful风格API

    spring boot 系列学习记录:http://www.cnblogs.com/jinxiaohang/p/8111057.html 码云源码地址:https://gitee.com/jinxia ...

  4. Restful风格API中用put还是post做新增操作有什么区别?

    Restful风格API中用put还是post做新增操作有什么区别? 转 头条面试归来,有些话想和Java开发者说!>>> 这个是华为面试官问我的问题,回来我找了很多资料,想验证这个 ...

  5. 通过beego快速创建一个Restful风格API项目及API文档自动化

    通过beego快速创建一个Restful风格API项目及API文档自动化 本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界 ...

  6. 通过beego快速创建一个Restful风格API项目及API文档自动化(转)

    通过beego快速创建一个Restful风格API项目及API文档自动化 本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界 ...

  7. day2(RESTful风格API)

    1.RESTful风格API  详情查看博客地址:https://www.cnblogs.com/xiaonq/p/10053234.html 1.1 什么是RESTful REST与技术无关,代表的 ...

  8. SpringBoot实战(二)Restful风格API接口

    在上一篇SpringBoot实战(一)HelloWorld的基础上,编写一个Restful风格的API接口: 1.根据MVC原则,创建一个简单的目录结构,包括controller和entity,分别创 ...

  9. 【Spring学习笔记-MVC-18.1】Spring MVC实现RESTful风格-同一资源,多种展现:xml-json-html

    概要 要实现Restful风格,主要有两个方面要讲解,如下: 1. 同一个资源,如果需要返回不同的形式,如:json.xml等: 不推荐的做法: /user/getUserJson /user/get ...

随机推荐

  1. unity 3d 三、空间与运动

    3D游戏编程第三次作业 简答并用程序验证[建议做] 游戏对象运动的本质是什么? 游戏对象运动的本质是游戏对象Position.Rotate.Scale属性数值的变化. 请用三种方法以上方法,实现物体的 ...

  2. [Angular JS教程] HeroService: getHeroes failed: undefined 问题解决方法

    最近在学习入门Angular JS,学习资源是https://angular.cn/tutorial, 在学习到 "https://angular.cn/tutorial/toh-pt6模拟 ...

  3. Python实现的数据结构与算法之队列详解

    本文实例讲述了Python实现的数据结构与算法之队列.分享给大家供大家参考.具体分析如下: 一.概述 队列(Queue)是一种先进先出(FIFO)的线性数据结构,插入操作在队尾(rear)进行,删除操 ...

  4. MySQL计算月份间隔的函数

    要求忽视具体日期,即 2020-01-31 与 2020-02-01 的月份间隔为:1 -- 格式必须为: '%Y%m' SELECT PERIOD_DIFF("202008" , ...

  5. K8S-kubeadm-集群证书续签

    ETCD证书 自签证书颁发机构(CA) ca.crt ca.key etcd集群中相互通信事业的客户端证书 peer.crt peer.key pod中定义Liveness探针事业的客户端证书 hea ...

  6. docker容器命令2

    docker容器命令2 启动守护式容器 docker run -d 镜像名字 [root@tzh ~]# docker images REPOSITORY TAG IMAGE ID CREATED S ...

  7. 你还在手撕微服务?快试试 go-zero 的微服务自动生成

    0. 为什么说做好微服务很难? 要想做好微服务,我们需要理解和掌握的知识点非常多,从几个维度上来说: 基本功能层面 并发控制&限流,避免服务被突发流量击垮 服务注册与服务发现,确保能够动态侦测 ...

  8. 多测师讲解seleniun_ ACTIONCHAUNS定位_高级讲师肖sir

    1.传统方法定位 2.模拟鼠标定位

  9. python面试题-django相关

    1.中间件 中间件一般做认证或批量请求处理,django中的中间件,其实是一个类,在请求和结束后,django会根据自己的规则在合适的时机执行中间件中相应的方法, 如请求过来 执行process_re ...

  10. 【C语言入门学习笔记】如何把C语言程序变成可执行文件!

    环境 在ANSI的任何一种实现中,存在两种不同的环境. 翻译环境:在这个环境里,源代码被转换为可执行的机器指令. 执行环境:用于实际执行代码. 翻译环境 组成一个程序的每个源文件通过编译过程分别转成目 ...