RESTful API更规范的编程接口风格

最新推荐文章于 2024-08-22 17:05:21 发布

CodeWhite7

最新推荐文章于 2024-08-22 17:05:21 发布

阅读量474

点赞数 1

分类专栏： Java框架 JavaEE 文章标签：网络 java http restful spring boot

本文链接：https://blog.csdn.net/weixin_46146269/article/details/106428315

版权

Java框架同时被 2 个专栏收录

18 篇文章 0 订阅

订阅专栏

JavaEE

14 篇文章 0 订阅

订阅专栏

在这里插入图片描述

写在前面：本文使用SpringMVC的HiddentHttpMethodFilter过滤器演示Restful的模拟增删改查
作者还在学习阶段，本文内容不深，若写得不好请见谅。
公众号：小白编码

本文目录

REST 风格 URL介绍

什么是 rest：

REST（英文：Representational State Transfer，简称 REST） 描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，他是 HTTP 规范的主要编写者之一。在目前主流的三种 Web 服务交互方案中，REST 相比于 SOAP（Simple Object Access protocol，简单对象访问协议）以及 XML-RPC 更加简单明了，无论是对 URL 的处理还是对 Payload 的编码，REST 都倾向于用更加简单轻量的方法设计和实现。值得注意的是 REST 并没有一个明确的标准，而更像是一种设计的风格。
它本身并没有什么实用性，其核心价值在于如何设计出符合 REST 风格的网络接口。

restful 的优点:
它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。

restful 的特性：

资源（Resources）：网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的存在。可以用一个 URI（统一资源定位符）指向它，每种资源对应一个特定的 URI 。要获取这个资源，访问它的 URI 就可以， 因此 URI 即为每一个资源的独一无二的识别符

表现层（Representation）： 把资源具体呈现出来的形式，叫做它的表现层（Representation）。
比如，文本可以用 txt 格式表现，也可以用 HTML 格式、XML 格式、JSON 格式表现，甚至可以采用二进制格式。

状态转化（State Transfer）：每发出一个请求，就代表了客户端和服务器的一次交互过程。
HTTP 协议，是一个无状态协议，即所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生“状态转化”（State Transfer）。而这种转化是建立在表现层之上的，所以就是 “表现层状态转化”。
具体说，就是 HTTP 协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET 用来获取资源，POST 用来新建资源，PUT 用来更新资源，DELETE 用来删除资源。

传统的url路径

每个方法对应不同的url路径:传统的url路径：每个方法对应不同的url路径:

@RequeMapping("/user/delete")
public void delete(){
}

@RequeMapping("/user/findAll")
public void findAll(){
}

@RequeMapping("/user/add")
public void add(){
}

Rest风格的url：

@RequeMapping(value = "/user", method = RequestMethod.DELETE)
public void delete(){  // delete请求
}

@RequeMapping(value = "/user",method = RequestMethod.GET)
public void findAll(){ // get请求
}

@RequeMapping(value = "/user",method = RequestMethod.POST)
public void add(){	//post请求
}

在这里插入图片描述

使用HiddentHttpMethodFilter示例演示Restful风格url：

作用：由于浏览器 form 表单只支持 GET 与 POST 请求，而DELETE、PUT 等 method 并不支持，Spring3.0 添加了一个过滤器，可以将浏览器请求改为指定的请求方式，发送给我们的控制器方法，使得支持 GET、POST、PUT 与DELETE 请求。

源码：
在这里插入图片描述
使用方法：

第一步：在web.xml中配置该过滤器。

第二步：请求方式必须使用post请求。

第三步：按照要求提供_method请求参数，该参数的取值就是我们需要的请求方式(使用隐藏域）。

1.web.xml配置过滤器：

<filter>
    <!-- 
        配置 org.springframework.web.filter.HiddenHttpMethodFilter: 
        可以把 POST 请求转为 DELETE 或 POST 请求 
    -->
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

2.jsp:请求的地址都是/user

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<h3>Hello,World</h3>
<!-- 保存 -->
<form action="user" method="post">
    用户名称：<input type="text" name="uname"><br/>
    <!-- <input type="hidden" name="_method" value="POST"> -->
    <input type="submit" value="保存">
</form>
<hr/>
<!-- 更新 -->
<form action="user/1" method="post">
    用户名称：<input type="text" name="uname"><br/>
<%--    需要在发送 POST 请求时携带一个 name="_method" 的隐藏域, 值为 DELETE 或 PUT--%>
    <input type="hidden" name="_method" value="PUT">
    <input type="submit" value="更新">
</form>
<hr/> <!-- 删除 -->
<form action="user/1" method="post">
<%--    需要在发送 POST 请求时携带一个 name="_method" 的隐藏域, 值为 DELETE 或 PUT--%>
    <input type="hidden" name="_method" value="DELETE">
    <input type="submit" value="删除">
</form>
<hr/> <!-- 查询一个 -->
<form action="user/1" method="post">
    <input type="hidden" name="_method" value="GET">
    <input type="submit" value="查询">
</form>
</body>
</html>

3.Restful风格url定义：

/**
 * @author codewhite
 * @create 2020-05-29 16:11
 */
@Controller
public class RestController {

    /**
     * post请求：保存用户
     */
    @RequestMapping(value = "/user", method = RequestMethod.POST)
    public String testRestfulURLPOST(User user) {
        System.out.println("rest测试 post：" + user);
        return "success";
    }

    /**
     * put请求：根据用户id更新用户
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.PUT)
    public String testRestfulURLPUT(@PathVariable("id") Integer id, User user) {
        System.out.println("rest测试 put：" + id + "," + user);
        return "success";
    }

    /**
     * delete请求：根据id删除用户
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
    public String testRestfulURLDELETE(@PathVariable("id") Integer id) {
        System.out.println("rest测试 delete： " + id);
        return "success";
    }

    /**
     * get请求：根据id查询用户
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    public String testRestfulURLGET(@PathVariable("id") Integer id) {
        System.out.println("rest测试 get：" + id);
        return "success";
    }

}

Debug测试：

1.保存用户：post请求过来了！请求地址是：/user

在这里插入图片描述
从浏览器获取过来了：小白，并且将小白，封装到user中

控制台得到：user：

在这里插入图片描述

2.更新用户：put请求！请求地址是/user/1
在这里插入图片描述 )]
从浏览器获取过来了：小黑，并且将小黑，封装到user中，此方法由过滤器转为PUT请求

控制台：

3.删除用户：delete请求！请求地址是/user/1
在这里插入图片描述
收到delete请求里的id=1，实现删除用户功能

控制台：
在这里插入图片描述
4.查询用户：get请求！请求地址/user/1

在这里插入图片描述
get请求地址发送了一个id为1，查询1号。

控制台：
在这里插入图片描述

总结：

restful风格的url，所有方法的路径都是一样的：/user，通过发送的请求方式 get/post/delete/put 来确定使用哪个方法，如果两个方法的请求方式是相同的，则根据所带参数来判断调用哪个方法. 如上述代码的：put请求：根据用户id更新用户，delete请求：根据id删除用户。