站长家园(原代码之家)(www.adminjie.com)网站源码,微信源码,游戏源码,商业源码分享平台。
当前位置:网站首页 技术文章 网络编程 正文

教你用GIN构建一个WEB服务

时间:2022-01-10 [网络编程]作者:fabuyuan 浏览:5 次

本文由golang教程栏目给大家介绍怎么用 GIN 构建一个 WEB 服务,希望对需要的朋友有所帮助!

快速启动一个 api

目录

├── api  \\ 服务入口
├── cmd   \\ 服务启动入口
├── config
├── doc
 └── chaper1.md├── go.mod
├── internal \\ 业务逻辑
├── main.go
├── pkg   \\ 三方包初始化
└── router \\ Api 路由

GIN && Cobra

一般 WEB 服务,都会包含多个模块: API 接口、定时任务、消费 MQ 常驻进程等等,在这种情况下,很显然直接使用 GIN 来启动就只能开启 API 模块,十分不便。

我们用 Cobra 来管理项目的启动,现在不用关心 Cobra 如何使用,现在要的是满足我们需求。

很多时候人会陷入到细节里,就无法宏观的把控全局设计。无论是做需求还是设计框架,都应该梳理整个流程,每个流程需要什么样的技术,而技术细节反而不是最需要关心的。互联网发展到今天,你遇到的问题一定有人遇到过要把关注点放到你的设计上。

初始化一个 rootCmd 来管理项目中所有的模块

// main.go

func main() {
 cmd.Execute()}

// cmd/root.go
var rootCmd = &cobra.Command{
 Use:   "提供WebApi服务", Short: "webApi",}

func init() {
 rootCmd.AddCommand(apiCmd)}

func Execute() {
 if err := rootCmd.Execute(); err != nil { fmt.Println("[错误]启动失败:", err) }}

// cmd/api.go
var httpServer *http.Server
var apiCmd = &cobra.Command {
             Use:   "api", 
            Short: "apiCmd", 
            Long:  `apiCmd 提供api接口服务`, 
            Run: func(cmd *cobra.Command, args []string) {
                address := fmt.Sprintf("%v:%v", "0.0.0.0", 8080)
                 engine := gin.New()
                httpServer = &http.Server{
                    Addr:        address, 
                    Handler:     engine, 
                    IdleTimeout: time.Minute, 
                } 
            if err := httpServer.ListenAndServe(); err != nil &&             err != http.ErrServerClosed { 
                fmt.Println("启动失败", err) 
            }},

            }
}

这个时候启动一下, 可以看到需要传一个命令行参数:

➜  gin-web-layout git:(master) ✗ go run main.go                  
webApi

Usage:
 提供WebApi服务 [command]
Available Commands:
 api         apiCmd completion  Generate the autocompletion script for the specified shell help        Help about any command

使用 go run main.go api 就可以启动服务了

➜  gin-web-layout git:(master) ✗ go run main.go api              
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release - using code:  gin.SetMode(gin.ReleaseMode)

首先开始接入路由, 所见即所得,能快速的看到自己写的成果

router/router.go

func InitRouter(engine *gin.Engine) {
 engine.GET("/", func(c *gin.Context) { c.JSON(200, "ok") })}

在 cmd/api.go 增加以下代码

engine := gin.New()
router.InitRouter(engine)

这样一个 hello world 就完成了,这个也是 gin 快速开始的内容。 启动后访问一下:

➜  gin-web-layout git:(master) ✗ curl http://0.0.0.0:8080  
"ok"%

这个时候我们来完善一下启动模块的代码,加上平滑重启,设置 5 秒后退出

// cmd/api.go
// 只展示核心代码,完整代码可以在 github 查看

// 等待 5 秒 timeout = 5 *time.sencond
func OnServiceStop(timeout time.Duration) {
    quit := make(chan os.Signal)
    signal.Notify(quit, signals.Get()...)
    <-quit

    ctx, cancel := context.WithTimeout(context.Background(), timeout)
    defer cancel()
    err := httpServer.Shutdown(ctx)
    if err != nil {
        log.Fatalf("service stop error:%v", err)
    }
    log.Println("service is stopping")
}

这样就支持了热启动,然后就编译启动,ctrl+c, 他为什么没阻塞 5 秒,直接就退出了?

因为 ctrl+c 的时候,会检查是否有待处理的请求,如没有就会直接退出。我们可以模拟一个耗时请求:

// router/router.go
    engine.GET("/", func(c *gin.Context) {
        time.Sleep(5 * time.Second)
        c.JSON(200, "ok")
    })

重新启动后,再次 ctrl+c 会发现 5 秒后项目才退出完成。

题外话,线上的服务是如何发布部署的?

一般线上服务都会用网关调度流量,当我们一个服务接受到 kill(重启脚本一般用 kill,杀掉 pid) 信号,就不再接受新请求。

这一点可以用我们刚配置的热重启验证一下,把 timeout 设置 10s, 伪造一个耗时 10s 的请求,启动后执行退出(用 ctrl+c 或者 kill, 本质都是发送一个信号), 然后再访问服务,
会得到

➜  gin-web-layout git:(master) ✗ curl http://0.0.0.0:8080
curl: (7) Failed to connect to 0.0.0.0 port 8080: Connection refused

网关和服务会有心跳监测,无法提供服务后,网关自动踢掉服务,不再发流量,待恢复后再重新发流量。但是实际部署部署是另有方案,因为心跳是有间隔的,这个间隔期间服务退出了,就会造成大量的 502

实际线上操作为,当一台服务要退出的时候,会先到网关摘流量,再执行平滑退出,启动新服务,到网关挂上流量。 网关一般用的是阿里的 slb,也有人用 kong,都是一样的套路。

以上就是教你用GIN构建一个WEB服务的详细内容,更多请关注站长家园其它相关文章!

本文标签:  gogolanggo教程

转载请注明来源:教你用GIN构建一个WEB服务

本文永久链接地址:https://www.adminjie.com/post/7465.html

免责声明:
本站所发布的一切资源仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。您必须在下载后的24个小时之内,从您的电脑中彻底删除上述内容。如果您喜欢该程序,请支持正版软件,购买注册,得到更好的正版服务。

附:
二○○二年一月一日《计算机软件保护条例》第十七条规定:为了学习和研究软件内含的设计思想和原理,通过安装、显示、传输或者存储软件等方式使用软件的,可以不经软件著作权人许可,不向其支付报酬!鉴于此,也希望大家按此说明研究软件!

版权声明:
一、本站致力于为软件爱好者提供国内外软件开发技术和软件共享,着力为用户提供优资资源。
二、本站提供的部分源码下载文件为网络共享资源,请于下载后的24小时内删除。如需体验更多乐趣,还请支持正版。
三、我站提供用户下载的所有内容均转自互联网。如有内容侵犯您的版权或其他利益的,若有侵犯你的权益请:提交版权证明文件到邮箱 2225329873#qq.com(#换为@) 站长会进行审查之后,情况属实的会在三个工作日内为您删除。

  • 站长家园(原代码之家)会员升级
  • 最新文章
    • oracle中not的用法是什么

      oracle中not的用法是什么

      在oracle中,not用于对指定的条件取反,当指定的条件为真时,not的结果就是假,当指定的条件为假时,not的结果就是真,语法为“Selectwhere...

    • Vue3中5个可以提高开发效率的小知识【整理分享】

      Vue3中5个可以提高开发效率的小知识【整理分享】

      本篇文章给大家聊聊Vue3开发,整理分享5个可以提高开发效率的小知识,让你在Vue3的项目开发中更加丝滑,希望对大家有所帮助!最近鼓捣了一下Vue3+...

    • php5.6.31如何编译安装

      php5.6.31如何编译安装

      php5.6.31编译安装的方法:1、添加epel源;2、安装依赖;3、下载并解压php5.6.31;4、修改php-fpm.conf;5、启动php-fpm即...

    • oracle怎样进行空值替换

      oracle怎样进行空值替换

      在oracle中,可利用nvl()函数进行空值替换,该函数用于从两个表达式中返回一个非null值,语法为“nvl(字段值,替换值)”;当字段值的结果为null值...

    • oracle数据库有什么用

      oracle数据库有什么用

      oracle数据库的作用:1、oracle可以按照数据结构来组织、存储和管理数据;2、oracle能够适用于大型、中型和微型计算机的关系数据库管理。本教程操作环...

    热门文章