SpringBoot接口

最新推荐文章于 2024-05-14 18:39:06 发布
最新推荐文章于 2024-05-14 18:39:06 发布
阅读量1.3k 收藏 2
点赞数
文章标签： http restful java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_47554309/article/details/120335080
版权

RESTful接口web服务

HTTP协议

简介

  HTTP协议是Hyper Text Transfer Protocol（超文本传输协议）的缩写,是用于从万维网（WWW:World Wide Web ）服务器传输超文本到本地浏览器的传送协议。。
  HTTP是一个基于TCP/IP通信协议来传递数据HTML 文件, 图片文件, 查询结果等

工作原理

HTTP协议工作于客户端-服务端架构上。浏览器作为HTTP客户端通过url向HTTP服务端即web服务器发送请求

  1. HTTP协议采用请求/相应模式。客户端发送请求，包含方法、url、协议版本等。
  2. 服务器以一状态行为作为相应，包括协议版本，成功或者失败信息，响应数据等。

web服务器有：Apache IIS
web服务器根据接受请求，向客户端发送相应信息
HTTP默认端口号为80
在这里插入图片描述

注意事项：

  1. HTTP是无连接
      每次连接只处理一个请求。服务器处理完客户的请求，收到客户端应答后，断开连接，节省传输时间
  2. HTTP是媒体独立的
      只要客户端和服务器知道如何处理数据内容，任何数据类型都可以通过HTTP发送
  3. HTTP是无状态的
      无状态协议，对事物处理无记忆能力。后续处理需要前面的信息，需要重新进行传输，导致连接传输数据量加大

HTTP请求过程

  1. 通过DNS对域名进行解析：浏览器缓存->操作系统缓存->hosts文件->DNS服务器
  2. 通过TCP协议，建立浏览器与服务器端连接
  3. 浏览器发起HTTP协议请求
  4. 服务器响应HTTP请求
  5. 浏览器解析html代码，并请求Html资源
  6. 浏览器展示内容
  7. TCP断开连接

HTTP请求方式

请求方法操作方式
GETGET方法要求服务器将url定位的资源放在响应报文的数据部分，回送给客户端
POST向服务器提交数据，将数据交由服务器处理
HEAD获取响应头
PUT替换资源
DELETE删除资源
OPTIONS允许客户端查看服务器性能
TRACE回应服务器收到的请求，用于测试或诊断

HTTP报头

一. HTTP请求报文
请求报头由四部分构成，请求行、请求头、空行和请求数据

  1. 请求行
    在这里插入图片描述

  2. 请求头
    在这里插入图片描述
    ● User-Agent：产生请求的浏览器类型;
    ● Accept：客户端可识别的响应内容类型列表;星号 “ * ” 用于按范围将类型分组，用 “ / ” 指示可接受全部类型，用“ type/* ”指示可接受 type 类型的所有子类型;
    ● Accept-Language：客户端可接受的自然语言;
    ● Accept-Encoding：客户端可接受的编码压缩格式;
    ● Accept-Charset：可接受的应答的字符集;
    ● Host：请求的主机名，允许多个域名同处一个IP 地址，即虚拟主机;
    ● connection：连接方式(close 或 keepalive);
    ● Cookie：存储于客户端扩展字段，向同一域名的服务端发送属于该域的cookie;

  3. 空行
    在这里插入图片描述

  4. 请求数据
    请求包体不在 GET 方法中使用，而是在POST 方法中使用。POST 方法适用于需要客户填写表单的场合

二. HTTP响应报文
HTTP响应报文由响应行，响应头，响应体三部分组成
在这里插入图片描述
响应行主要包括

    响应协议，这个与请求协议对应，比如http,
    状态码1xx
    状态码的描述OK

响应头就是一些常见的响应名对应的响应值
响应参数就是我们真正需要的从数据库中取出的数据

  1. 状态码：三位数字组成：第一位数字表示响应类型
    （1）1xx: 服务器接收客户请求
    （2）2xx: 服务器接收请求并处理
    （3）3xx: 服务器要求客户端重定向
    （4）4xx: 客户端请求有非法内容
    （5）5xx: 服务器未能正常处理出错

状态码实例
(1) 200 OK：表示客户端请求成功;
(2) 400 Bad Request：表示客户端请求有语法错误，不能被服务器所理解;
(3) 404 Not Found：请求的资源不存在，例如，输入了错误的URL;
(4) 500 Internal Server Error：表示服务器发生不可预期的错误，导致无法完成客户端的请求;
(5) 503 Service Unavailable：表示服务器当前不能够处理客户端的请求，在一段时间之后，服务器可能会恢复正常;

  1. 响应头
    响应头包括Location，Server，Vary，Connection等
    Location：Location响应报头域用于重定向接受者到一个新的位置
    Server：Server 响应报头域包含了服务器用来处理请求的软件信息及其版本
    Vary：指示不可缓存的请求头列表
    Connection：连接方式;
  2. 空行
  3. 响应体
    服务器返回给客户端的文本信息

RESTful接口

API：一组编程接口规范，客户端与服务端通过请求响应进行数据通信
REST：表述性传递，决定了接口的形式与规则。RESTful是基于http方法的API设计风格

  1. 通过Url可以知道获取需要什么资源
  2. 通过http method获取针对资源做什么
  3. http status code知道结果

当然也不是所有的接口，都能用REST的形式来表述。在实际工作中，灵活运用，我们用RESTful风格的目的是为大家提供统一标准，避免不必要的沟通成本的浪费，形成一种通用的风格。

  1. RESTful是面向资源的
符合REST接口URI功能
GET /api/cats/{id}获取一个小猫
GET /api/cats获取所有小猫
POST /api/cats添加一个小猫
PUT /api/cats/{id}修改一个小猫
DELETE /api/cats/{id}删除一个小猫
  1. HTTP方法对资源进行操作
    GET ： 获取、读取资源
    POST ： 添加资源
    PUT ： 修改资源
    DELETE ： 删除资源
  2. HTTP状态码
      所有事情都按预期正确执行完毕 - 成功
      APP 发生了一些错误 – 客户端错误
      API 发生了一些错误 – 服务器端错误
  3. Get方法和查询参数不应改变
    修改数据是post，put，delete
  4. 是用复数名词
  5. 复杂关系固定表达
    GET /cars/711/drivers/ 返回 使用过编号711汽车的所有司机
  6. 高级用法：HATEOAS
    返回结果中提供链接，连接其他API方法，用户不查询文档，也能熟知下一步操作
    可以通过link属性得知下一步用什么Api
{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}
  1. 资源过滤，排序，选择和分页表述
  2. 版本化Api

项目实例

项目创建

在这里插入图片描述
在这里插入图片描述
默认操作next，可自行修改Group，Artifact
在这里插入图片描述
在这里插入图片描述

BaseRequestController

package com.jady.retrofitclientserver.controller;

import com.jady.retrofitclientserver.model.DeleteBody;
import com.jady.retrofitclientserver.model.ServerResult;
import com.jady.retrofitclientserver.model.User;
import com.jady.retrofitclientserver.model.UserForLogin;
import org.springframework.web.bind.annotation.*;

/**
 * Created by lipingfa on 2017/6/16.
 */
@RestController
public class BaseRequestController {
    /**
     * get请求
     *
     * @return
     */
    @GetMapping("/user/info")
    public ServerResult getUser() {
        ServerResult serverResult = new ServerResult<User>();
        serverResult.setServer_time(System.currentTimeMillis());
        serverResult.setSuccess(true);
        User user = new User("jady", 12);
        serverResult.setData(user);
        return serverResult;
    }

    @PostMapping("/user/login")
    public ServerResult login(@RequestParam String name, @RequestParam String password) {
        ServerResult serverResult = new ServerResult<String>();
        serverResult.setServer_time(System.currentTimeMillis());
        if ("jady".equals(name) && "1234".equals(password)) {
            serverResult.setSuccess(true);
            serverResult.setData("addafeas_cdedhyuj_daledage_leiaefss");
        } else {
            serverResult.setSuccess(false);
            serverResult.setErr_code("1000");
            serverResult.setMessage("用户名或密码错误");
        }
        return serverResult;
    }

    @PostMapping(path = "/user/loginByBody")
    public ServerResult login(@RequestBody UserForLogin userForLogin) {
        ServerResult serverResult = new ServerResult<String>();
        serverResult.setServer_time(System.currentTimeMillis());
        if ("jady".equals(userForLogin.getName()) && "1234".equals(userForLogin.getPassword())) {
            serverResult.setSuccess(true);
            serverResult.setData("addafeas_cdedhyuj_daledage_leiaefss");
        } else {
            serverResult.setSuccess(false);
            serverResult.setErr_code("1000");
            serverResult.setMessage("用户名或密码错误");
        }
        return serverResult;
    }

    @PutMapping(path = "/user/update")
    public ServerResult updateUserInfo(@RequestHeader("access_token") String accessToken, @RequestParam(required = false) String name, @RequestParam(required = false) String age) {
        ServerResult serverResult = new ServerResult();
        serverResult.setServer_time(System.currentTimeMillis());
        if ("1234".equals(accessToken)) {
            //更新用户信息
            serverResult.setSuccess(true);
        } else {
            serverResult.setSuccess(false);
            serverResult.setErr_code("10001");
            serverResult.setMessage("更新接口token错误");
        }
        return serverResult;
    }

    @DeleteMapping(path = "/feed/delete")
    public ServerResult deleteFeed(@RequestHeader("access_token") String accessToken, @RequestBody DeleteBody body) {
        ServerResult serverResult = new ServerResult();
        serverResult.setServer_time(System.currentTimeMillis());
        if ("1234".equals(accessToken)) {
            //删除feed
            serverResult.setSuccess(true);
        } else {
            serverResult.setSuccess(false);
            serverResult.setErr_code("10001");
            serverResult.setMessage("删除接口token错误");
        }
        return serverResult;
    }
}

FileUploadController

package com.jady.retrofitclientserver.controller;

import com.jady.retrofitclientserver.model.DeleteBody;
import com.jady.retrofitclientserver.model.ServerResult;
import com.jady.retrofitclientserver.model.User;
import com.jady.retrofitclientserver.model.UserForLogin;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;

import javax.servlet.http.HttpServletRequest;
import java.io.*;
import java.util.List;
import java.util.Map;

/**
 * Created by lipingfa on 2017/6/16.
 */
@RestController
public class FileUploadController {
    /**
     * 单文件上传
     *
     * @return
     */
    @PostMapping("/file/upload/single")
    public ServerResult uploadFile(@RequestParam("file") MultipartFile file) {

        ServerResult serverResult = new ServerResult<String>();
        serverResult.setServer_time(System.currentTimeMillis());

        if (!file.isEmpty()) {
            try {
                BufferedOutputStream out = new BufferedOutputStream(
                        new FileOutputStream(new File("files/" + file.getOriginalFilename())));
                out.write(file.getBytes());
                out.flush();
                out.close();
                serverResult.setSuccess(true);
            } catch (Exception e) {
                e.printStackTrace();
                serverResult.setSuccess(false);
                serverResult.setErr_code("10010");
                serverResult.setMessage("上传失败:" + e.getMessage());
            }
        } else {
            serverResult.setSuccess(false);
            serverResult.setErr_code("10010");
            serverResult.setMessage("上传失败，文件是空的");
        }
        return serverResult;
    }

    /**
     * 多文件上传
     *
     * @return
     */
    @PostMapping("/file/upload/multiple")
    public ServerResult uploadFiles(HttpServletRequest request) {
        ServerResult serverResult = new ServerResult<String>();
        serverResult.setServer_time(System.currentTimeMillis());

        Map<String, MultipartFile> files = ((MultipartHttpServletRequest) request).getFileMap();
        BufferedOutputStream stream = null;
        for (MultipartFile multipartFile : files.values()) {
            if (!multipartFile.isEmpty()) {
                try {
                    byte[] bytes = multipartFile.getBytes();
                    stream = new BufferedOutputStream(new FileOutputStream(new File("files/" + multipartFile.getOriginalFilename())));
                    stream.write(bytes);
                    stream.close();
                } catch (Exception e) {
                    stream = null;
                    serverResult.setSuccess(false);
                    serverResult.setErr_code("10010");
                    serverResult.setMessage("上传失败:" + e.getMessage());
                    return serverResult;
                }
            } else {
                serverResult.setSuccess(false);
                serverResult.setErr_code("10010");
                serverResult.setMessage("上传失败，文件是空的");
                return serverResult;
            }
        }
        serverResult.setSuccess(true);
        return serverResult;
    }
}

ResourceManager

package com.example.redis.resource.manager;

public class ResourceManager {
    private int count =0;
    private static ResourceManager instance = new ResourceManager();
    private ResourceManager(){}

    public static ResourceManager getInstance(){
        return instance;
    }

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

    public synchronized void minusCount(int i){
        count =count+i;
    }

    public int getCount(){
        return count;
    }

    public void initCount(int i){
        count =i;
    }
}

```

在这里插入图片描述

测试

POSTMan进行测试：
查询接口，服务启动，count默认值为0
在这里插入图片描述
初始化
post：
在这里插入图片描述
put:
在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

总结

Postman工作原理
在这里插入图片描述
当在postman单机send按钮，服务器将会接受请求并在接口中显示响应

GET
HTTP GET请求方法是从服务器检索数据
数据由唯一的Uri表示
GET请求可以使用“Query String Parameters”将参数传递给服务器
用法：不输入id时，使用默认值

参考

手把手教你学spring boot 2.x(持续更新)
HTTP基础知识
HTTP报头
【SpringBoot】使用IDEA创建一个SpringBoot服务，并创建三个restful风格的接口

Tarbet
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot接口加密解密统一处理
08-25
主要为大家详细介绍了SpringBoot接口加密解密统一处理，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
解决Vue调用springboot接口403跨域问题
10-16
主要介绍了解决Vue调用springboot接口403跨域问题,本文给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
JAVA面试题
weixin_45067832的博客
11-05 170
作者：希望秋招拿到offer 链接：https://www.nowcoder.com/discuss/452732?type=all&order=time&pos=&page=3&channel=0&source_id=search_all 来源：牛客网 1、牛客刷题 ●RabbitMQ有以下几种工作模式 ： 简单模式：一个生产者，一个消费者 work模式：一个生产者，多个消费者，每个消费者获取到的消息唯一。 订阅模式：一个生产者发送的消息会被多个消费者获取。 路由模
java程序员要知道的500个基础小知识
m0_61402516的博客
11-09 2418
基础不牢 地动山摇
springboot常用接口
我们不创新代码，我们只是代码的搬运工！！！
04-10 998
ApplicationListener可以监听某个事件event，通过实现这个接口，传入一个泛型事件，在run方法中就可以监听这个事件，从而做出一定的逻辑，比如在等所有bean加载完之后执行某些操作. Spring典型的观察者设计模式。同时这个事件还可以直接读取到IOC容器中所有被实例化的对象Spring内置事件ApplicationContext 被初始化或刷新时，该事件被发布。这也可以在 ConfigurableApplicationContext接口中使refresh() 方法来发生。
（一）还不会用springboot写接口？快看这里，手把手操作，一发入魂~
热门推荐
隐风的博客
03-12 1万+
springboot入门项目，包括简单的接口开发（api），数据库操作（mybatis plus）和接口文档调试生成（knife4j）。
SpringBoot 接口整理
菜鸟记录
09-03 2127
⏹SpringBoot 接口整理
Springboot接收http参数总结（最简单易懂）
qq_51114283的博客
10-10 692
Springboot接收http参数总结（最简单易懂），如何接收application/octet-stream，@RequestBody和@RequestParam讲解
Spring Boot 后端接口规范大全，告别混乱代码
竹林幽深
06-07 529
一个后端接口大致分为四个部分组成：接口地址（url）、接口请求方式（get、post等）、请求数据（request）、响应数据（response）。虽然说后端接口的编写并没有统一规范要求，而且如何构建这几个部分每个公司要求都不同，没有什么“一定是最好的”标准，但其中最重要的关键点就是看是否规范。一个接口一般对参数（请求数据）都会进行安全校验，参数校验的重要性自然不必多说，那么如何对参数进行校验就有讲究了。一般来说有三种常见的校验方式，我们使用了最简洁的第三种方法业务层校验。
自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏
08-11
自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏 自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏 自定义注解结合Hutool对SpringBoot接口返回数据进行脱敏 自定义注解结合Hutool对SpringBoot接口返回...
springboot实现接口签名
06-06
为了保证数据传输的安全性，跟其他系统进行数据交互时，双方应该约定好密钥，把数据进行加密，接口签名，这样双方调用接口时，验证接口签名一致时就表明数据传输过程中没有被修改。
springboot接口工具常用模板
05-13
springboot接口工具常用模板
基于 Spring Boot 的 RESTful API 设计与实现
ceshiren_com的博客
05-31 398
本文节选自霍格沃兹测试学院内部教材 RESTful 是一种规范，符合 RESTful 的 Api 就是 RESTful Api。简单的说就是可联网设备利用 HTTP 协议通过 GET、POST、DELETE、PUT、PATCH 来操作具有 URI 标识的服务器资源，返回统一格式的资源信息，包括 JSON、XML、CSV、ProtoBuf、其他格式。 RESTful 的核心思想是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如，GET /case 这个命令，GET 是动词，/cas...
springboot写接口
weixin_43335170的博客
11-03 7614
今天来写一下springboot的接口，也是初学者，有报错的自己调试哈 第一步，创建项目 点击下一步就是了 勾选这几项 数据库选择mySQL,勾选mybatis,后续用mabatis写sql语句。 好，接下来就是。。。 等待项目的生成。 项目生成之后就是这鸟样了。。 个人喜好用yml的写法，看起来舒服些 接下来我们来创建表 mysql数据库客户端个人建议用下面这玩意，看着挺舒服的 创建了一个名为练习的库，然后往这个库里添加表，添加数据就可以...
SpringBoot——SpringBoot接口设计和实现
庄小焱
03-31 3574
本博文主要介绍SpringBoot接口设计和实现。帮助大家更好的学习和理解SpringBoot原理。帮助大家在项目中把springboot使用的更好。
【SpringBoot框架篇】10.API接口限流实战
皓亮君的博客
05-21 9505
文章目录简介限流算法漏桶算法令牌桶算法基于guava的RateLimiter实现引入依赖自定义注解自定义切面类编写web接口压测 简介 对接口限流的目的是通过对并发访问/请求进行限速，或者对一个时间窗口内的请求进行限速来保护系统，一旦达到限制速率则可以拒绝服务、排队或等待、降级等处理 限流算法 常用的限流算法由：楼桶算法和令牌桶算法。 漏桶算法 漏桶(Leaky Bucket)算法思路很简单,水(请求)先进入到漏桶里,漏桶以一定的速度出水(接口有响应速率),当水流入速度过大会直接溢出(访问频率超过接口响应速
spring 远程接口访问及集群方案(二)
大河湾的专栏
07-09 274
针对spring远程接口访问,本文给出一个实际的例子供参考,如果有不足之处,尚请原谅   RMI调用的过程，我的理解大致如下： 1   客户端和服务器端约定好要用于远程调用的方法的接口(包括方法名和输入输出参数)。 2      服务器端将远程服务绑定到某个端口，进行TCP/IP监听(例如监听地址为rmi://127.0.0.1:1099)。 3      客户端与服务器建立TCP/IP...
Http常见问题
最新发布
qq_51240148的博客
05-14 255
.
springboot 接口
07-25
Springboot并没有定义独立的接口。它是基于Spring框架的一个扩展，主要通过自动装配的机制来简化Spring应用的配置。在Springboot中，我们可以使用Spring框架中的各种接口来实现自定义的功能。比如，我们可以使用...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值