golang_gin_restful_api.pdf资源-CSDN文库

需积分: 10 169 浏览量 2019-08-29 18:03:59 上传评论 1 收藏 20.45MB PDF 举报

资源详情

资源评论

基于 Go 语言构建企业级的 RESTful API 服务 - 雷克斯

本小册所实现的 API 功能

本小册所实现的功能

本小册通过实现一个账号系统，来演示如何构建一个真实的 API 服务器，构建方法和技术是笔者根据多年的大

型 API 服务器开发经验不断优化沉淀而成。通过实战展示了 API 构建过程中各个流程（准备 -> 设计 -> 开发 -

> 测试 -> 部署）的实现方法，小册涵盖的内容如下（包括但不限于）：

详细为：

如何安装和配置 Go 开发环境

如何安装和配置 Vim IDE

设计阶段

API 构建技术选型

API 基本原理

API 规范设计

如何读取配置文件

如何管理和记录日志

如何做数据库的 CURD 操作

如何自定义错误 Code

基于 Go 语言构建企业级的 RESTful API 服务 - 雷克斯

RESTful API 介绍

什么是 API

API（Application Programming Interface，应用程序编程接口）是一些预先定义的函数或者接口，目的是提

供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无须访问源码，或理解内部工作机制

的细节。

要实现一个 API 服务器，首先要考虑两个方面：API 风格和媒体类型。Go 语言中常用的 API 风格是 RPC 和

REST，常用的媒体类型是 JSON、XML 和 Protobuf。在 Go API 开发中常用的组合是 gRPC + Protobuf 和

REST + JSON。

REST 简介

REST 代表表现层状态转移（REpresentational State Transfer），由 Roy Fielding 在他的论文中提出。

REST 是一种软件架构风格，不是技术框架，REST 有一系列规范，满足这些规范的 API 均可称为 RESTful

API。REST 规范中有如下几个核心：

1. REST 中一切实体都被抽象成资源，每个资源有一个唯一的标识 —— URI，所有的行为都应该是在资源上的

CRUD 操作

2. 使用标准的方法来更改资源的状态，常见的操作有：资源的增删改查操作

3. 无状态：这里的无状态是指每个 RESTful API 请求都包含了所有足够完成本次操作的信息，服务器端无须保

持 Session

无状态对于服务端的弹性扩容是很重要的。

REST 风格虽然适用于很多传输协议，但在实际开发中，REST 由于天生和 HTTP 协议相辅相成，因此 HTTP 协

议已经成了实现 RESTful API 事实上的标准。在 HTTP 协议中通过 POST、DELETE、PUT、GET 方法来对应

REST 资源的增、删、改、查操作，具体的对应关系如下：

HTTP 方法行为 URI 示例说明

GET 获取资源列表 /users 获取用户列表

GET 获取一个具体的资源 /users/admin 获取 admin 用户的详细信息

POST 创建一个新的资源 /users 创建一个新用户

PUT 以整体的方式更新一个资源 /users/1 更新 id 为 1 的用户

DELETE 删除服务器上的一个资源 /users/1 删除 id 为 1 的用户

RPC 简介

根据维基百科的定义：远程过程调用（Remote Procedure Call，RPC）是一个计算机通信协议。该协议允许运

行于一台计算机的程序调用另一台计算机的子程序，而程序员无须额外地为这个交互作用编程。

通俗来讲，就是服务端实现了一个函数，客户端使用 RPC 框架提供的接口，调用这个函数的实现，并获取返回

值。RPC 屏蔽了底层的网络通信细节，使得开发人员无须关注网络编程的细节，而将更多的时间和精力放在业

务逻辑本身的实现上，从而提高开发效率。

RPC 的调用过程如下（图片来自 How RPC Works）：

1. Client 通过本地调用，调用 Client Stub

2. Client Stub 将参数打包（也叫 Marshalling）成一个消息，然后发送这个消息

3. Client 所在的 OS 将消息发送给 Server

4. Server 端接收到消息后，将消息传递给 Server Stub

5. Server Stub 将消息解包（也叫 Unmarshalling）得到参数

6. Server Stub 调用服务端的子程序（函数），处理完后，将最终结果按照相反的步骤返回给 Client

Stub 负责调用参数和返回值的流化（serialization）、参数的打包解包，以及负责网络层的通信。Client 端

一般叫 Stub，Server 端一般叫 Skeleton。

REST vs RPC

在做 API 服务器开发时，很多人都会遇到这个问题 —— 选择 REST 还是 RPC。RPC 相比 REST 的优点主要有

3 点：

1. RPC+Protobuf 采用的是 TCP 做传输协议，REST 直接使用 HTTP 做应用层协议，这种区别导致 REST 在调

用性能上会比 RPC+Protobuf 低

2. RPC 不像 REST 那样，每一个操作都要抽象成对资源的增删改查，在实际开发中，有很多操作很难抽象成资

源，比如登录操作。所以在实际开发中并不能严格按照 REST 规范来写 API，RPC 就不存在这个问题

3. RPC 屏蔽网络细节、易用，和本地调用类似

这里的易用指的是调用方式上的易用性。在做 RPC 开发时，开发过程很烦琐，需要先写一个 DSL 描述文

件，然后用代码生成器生成各种语言代码，当描述文件有更改时，必须重新定义和编译，维护性差。

但是 REST 相较 RPC 也有很多优势：

1. 轻量级，简单易用，维护性和扩展性都比较好

剩余131页未读，继续阅读

评论收藏

内容反馈

golang_gin_restful_api.pdf

评论0

最新资源

golang_gin_restful_api.pdf

评论0

最新资源

相关推荐

Golang Gin RESTFul API with SQLite

apig, Golang RESTful API服务器生成器.zip

golang-gin-restfulAPI-example-app：带有[Gin，MongoDB，gin-jwt，gin-sessions，gin-authz，gin-swagger，validate.v9，casbin，go-ini]的Golang Restful API示例

Gin+Gorm开发Golang API快速开发脚手架-Golang开发

Todo-List:Golang + Gin Framework + JWT + MongoDB + RestfulAPI实践

基于 Gin 进行模块化设计的 API 框架，封装了常用功能，使用简单，致力于进行快速的业务研发.zip

gin-web:由gin + gorm + jwt + casbin组合实现的RBAC权限管理脚手架Golang版, 搭建完成即可快速、高效投入业务开发

gorsk-gin：using使用Gin的惯用Golang Restful入门套件

gin-swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 gin 中间件

go-api-server:使用golang制作一个宁静的api服务器

Building Microservices with Go-Packt Publishing(2017).pdf

singo:Gin+Gorm开发Golang API快速开发脚手架

ginrpc：gin自动绑定，grpc和带注释的路由，gin注解路由，grpc，自动参数绑定工具

zeus-admin：Zeus基于Golang Gin + casbin，致力于做企业统一权限和账号中心管理系统。包含账号管理，数据权限，功能权限，应用管理，多数据库适配，可docker一键运行。社区活跃，版本重组快，加群免费技术支持

go-todo-app:带有Gin框架的干净架构Todo Restful Api

Go，Clean Architecture，SOLID，Golang 1.21

gorm-gin：具有gin和gorm的简单api

gorsk：惯用的Golang Restful入门套件

go-fly:开源客服系统GO语言开发GO-FLY，免费客服系统golang的开源实时客户聊天

python大作业 含爬虫、数据可视化、地图、报告、及源码（整和为一个文件）（2014-2020全国各地区原油加工量）.rar

仿真电路以及操作方法

【纯干货啊】华为IPD流程管理(完整版).pptx

可编程语言标准IEC61131-3中文版.pdf

OFDM完整仿真过程与教程.zip

信号与系统——保研复习资料.pdf

Landsat_WRS2.zip

最全的Visio形状/图形库

AxureRP9项目原型50套、案例20个、元件库1套.zip

北理工+成电+东南——通信/信号保研面试真题.pdf

python大作业含爬虫、数据可视化、地图、报告、及源码（整和为一个文件）（2014-2020全国各地区原油加工量）.rar