SpringBoot之RESTful 接口的实现以及Postman的使用

---

1. HTTP相关知识

HTTP协议（Hyper Text Transfer Protocol，超文本传输协议），是用于从万维网（WWW:World Wide Web）服务器传输超文本到本地浏览器的传送协议，是一种应用层的协议。其定义了客户端与服务器端之间文本传输的规范。HTTP默认使用80端口，这个端口指的是服务端的端口，而客户端使用的端口是动态分配的。当我们没有指定端口访问时，浏览器会默认帮我们添加80端口。我们也可以自己指定访问端口如：http://localhost:81。 需要注意的是，现在大多数访问都使用了HTTPS协议，而HTTPS的默认端口为443，如果使用80端口访问HTTPS协议的服务器可能会被拒绝。

1.1 HTTP 工作原理

HTTP协议定义Web客户端如何从Web服务器请求Web页面，以及服务器如何把Web页面传送给客户端。HTTP协议采用了请求/响应模型。客户端向服务器发送一个请求报文，请求报文包含请求的方法、URL、协议版本、请求头部和请求数据。服务器以一个状态行作为响应，响应的内容包括协议的版本、成功或者错误代码、服务器信息、响应头部和响应数据。
HTTP 协议采用请求/响应模型。客户端向服务器发送一个请求报文，服务器以一个状态作为响应。

1.2 HTTP请求过程

1. 首先通过DNS对域名进行解析（如果是IP地址就不用解析了），DNS解析的顺序：浏览器缓存->操作系统缓存->hosts文件->DNS服务器。
2. 通过TCP三次握手，浏览器与服务器端建立连接。
3. 浏览器发起HTTP请求。
4. 服务器响应HTTP请求。
5. 浏览器解析html代码，并请求html代码中的资源（css/js/image）。
6. 浏览器对页面内容进行渲染并展示。
7. TCP四次挥手关闭连接。

1.3 HTTP请求的方法、

HTTP/1.1协议中共定义了八种方法（有时也叫“动作”），来表明Request-URL指定的资源不同的操作方式
HTTP1.0定义了三种请求方法： GET, POST 和 HEAD方法。
HTTP1.1新增了五种请求方法：OPTIONS, PUT, DELETE, TRACE和 CONNECT 方法

请求方法	详情
GET	向指定的资源发出“显示”请求。使用GET方法应该只用在读取数据，而不应当被用于产生“副作用”的操作中，例如在Web Application中。其中一个原因是GET可能会被网络蜘蛛等随意访问。
HEAD	与GET方法一样，都是向服务器发出指定资源的请求。只不过服务器将不传回资源的本文部分。它的好处在于，使用这个方法可以在不必传输全部内容的情况下，就可以获取其中“关于该资源的信息”（元信息或称元数据）。
POST	向指定资源提交数据，请求服务器进行处理（例如提交表单或者上传文件）。数据被包含在请求本文中。这个请求可能会创建新的资源或修改现有资源，或二者皆有。
PUT	向指定资源位置上传其最新内容。
DELETE	请求服务器删除Request-URI所标识的资源。
TRACE	回显服务器收到的请求，主要用于测试或诊断。
OPTIONS	这个方法可使服务器传回该资源所支持的所有HTTP请求方法。用’*'来代替资源名称，向Web服务器发送OPTIONS请求，可以测试服务器功能是否正常运作。
CONNECT	HTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器。通常用于SSL加密服务器的链接（经由非加密的HTTP代理服务器）。

---

2. Restful接口的使用

2.1 Restful风格API

REST（Representational State Transfer）表述性状态传递，决定了接口的形式与规则。RESTful是基于http方法的API设计风格，而不是一种新的技术.

1. 看Url就知道要什么资源
2. 看http method就知道针对资源干什么
3. 看http status code就知道结果如何

2.2 Spring Boot 项目的编写

首先创建一个SpringBoot项目:

创建四个包:

在四个包下面分别创建对应的类:

Count:

package com.example.demo.bean;


public class Count {
    private int count;

    public int getCount() {
        return count;
    }

    public void setCount(int count) {
        this.count = count;
    }
}

ResourceManager:

package com.example.demo.manager;

public class ResourceManager {

    private int count = 0;

    private static ResourceManager instance = new ResourceManager();

    private ResourceManager() {

    }

    public static ResourceManager getInstance(){
        return instance;
    }

    public void initCount(int count){
        this.count = count;
    }

    public int getCount(){
        return count;
    }

    public synchronized void addCount(int count){
        this.count += count;
    }

    public synchronized void minusCount(int count){
        this.count -= count;
    }

}

ResourceService:

package com.example.demo.service;


import com.example.demo.bean.Count;
import com.example.demo.manager.ResourceManager;
import org.springframework.stereotype.Service;

@Service
public class ResourceService {
    public void addCount(Count count){
        ResourceManager.getInstance().addCount(count.getCount());
    }

    public void minusCount(Count count){
        ResourceManager.getInstance().minusCount(count.getCount());
    }

    public Count getCount(){
        Count count = new Count();
        count.setCount(ResourceManager.getInstance().getCount());
        return count;
    }

    public void initCount(Count count){
        if (count != null){
            ResourceManager.getInstance().initCount(count.getCount());
        }
    }
}

ResourceController:

package com.example.demo.controller;


import com.example.demo.bean.Count;
import com.example.demo.service.ResourceService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
public class ResourceController {

    @Autowired
    ResourceService resourceService;

    @RequestMapping(value = "/me/count", method = RequestMethod.PUT)
    @ResponseBody
    public void initCount(@RequestBody Count count){
        resourceService.initCount(count);
    }

    @RequestMapping(value = "/me/count", method = RequestMethod.POST)
    @ResponseBody
    public void modifyCount(@RequestBody Count count){
        resourceService.addCount(count);
    }

    @RequestMapping(value = "/me/count", method = RequestMethod.GET)
    @ResponseBody
    public Count getCount(){
        return resourceService.getCount();
    }

}

注意修改每个类的所属包

启动项目:

---

3. 使用Postman进行测试

新建Workspaces:

点击+：

选择Get，输入url为http://localhost:8080/me/count，点击Send：

结果如下：

Post:


post后并用get查询:

PUT:

然后用GET查询:

---

参考

HTTP基础知识
HTTP协议简介
RESTful接口与http协议状态表述
使用IDEA创建一个SpringBoot服务，并创建三个restful风格的接口