给Go的Gin web框架增加 WebSocket 功能,让WebSocket 更好用

简介: 给Go的Gin web框架增加 WebSocket 功能,让WebSocket 更好用

Gin 是一个 go 的 web 框架,它具有轻量级,高性能,运行速度快,分组的路由器,良好的崩溃捕获和错误处理,非常好的支持中间件,rest api和json。


总之在 Go语言开发领域是一款值得好好研究的 Web 框架。官方地址:https://github.com/gin-gonic/gin


但是最近想尝试下websocket功能,发现Gin框架里没有。


Go 官方没有提供对 WebSocket 的支持,必须选择第三方提供的包。


常用的有两种,golang.org/x/net/websocket和 https://github.com/gorilla/websocket


《Go Web 编程》一书中的例子使用的是golang.org/x/net/websocket


其中gorilla/websocket更常用些,Apache的Paho GO mqtt client库中和go的另外一个web框架iris中,就使用的是gorilla/websocket库。


是不是直接把gorilla/websocket引入进gin框架就可以了?


但是还得需要自己完成封装,若不花功夫封装好,不是很好用,稳定性更难保证。


网上找到gin中使用gorilla的websocket库的例子,都只是一些简单的测试,一点儿都不好用。


接下来,为了让websocket在gin中更好用些,移植iris框架中的websocket功能到gin框架中,使用起来就简单啦,使用如下:


github 地址: https://github.com/yangyongzhen/gin-websocket.git


package main
import (
  "fmt"
  //"github.com/gin-contrib/cors"
  "github.com/gin-gonic/gin"
  "net/http"
  "strings"
  "websockTest/websocket"
)
func main() {
  ws := websocket.New(websocket.Config{
    ReadBufferSize:  1024,
    WriteBufferSize: 1024,
  })
  ws.OnConnection(handleConnection)
  r := gin.Default()
  //允许跨域
  //config := cors.DefaultConfig()
  //config.AllowOrigins = []string{"http://127.0.0.1:9090"}
  //r.Use(Cors())
  //静态资源
  r.Static("/static", "./static")
  r.LoadHTMLGlob("views/*")
  r.GET("/api/v3/device", ws.Handler())
  r.GET("/test", func(c *gin.Context) {
    c.HTML(http.StatusOK, "test.html", gin.H{
      "title": "this is a test",
    })
  })
  r.Run(":9090")
}
func handleConnection(c websocket.Connection) {
  fmt.Println("client connected,id=", c.ID())
  c.Write(1, []byte("welcome client"))
  // 测试从浏览器中读取事件
  c.On("chat", func(msg string) {
    // 将消息打印到控制台
    fmt.Printf("%s sent: %s\n", c.Context().ClientIP(), msg)
    // 将消息写回客户端消息所有者:
    // c.Emit("chat", msg)
    c.To(websocket.All).Emit("chat", msg)
  })
  c.OnMessage(func(msg []byte) {
    fmt.Println("received msg:", string(msg))
    c.Write(1, []byte("hello aa"))
    c.To(websocket.All).Emit("chat", msg)
  })
  c.OnDisconnect(func() {
    fmt.Println("client Disconnect,id=", c.ID())
  })
}


附,网上找到的一些测试代码如下:


package server
import (
  "fmt"
  "net"
  "net/http"
  "time"
  "github.com/gorilla/websocket"
)
const (
  // Time allowed to write a message to the peer.
  writeWait = 10 * time.Second
  // Maximum message size allowed from peer.
  maxMessageSize = 8192
  // Time allowed to read the next pong message from the peer.
  pongWait = 60 * time.Second
)
type WsServer struct {
  listener net.Listener
  addr     string
  upgrade  *websocket.Upgrader
}
func NewWsServer() *WsServer {
  ws := new(WsServer)
  ws.addr = "0.0.0.0:9090"
  ws.upgrade = &websocket.Upgrader{
    ReadBufferSize:  4096,
    WriteBufferSize: 1024,
    CheckOrigin: func(r *http.Request) bool {
      if r.Method != "GET" {
        fmt.Println("method is not GET")
        return false
      }
      if r.URL.Path != "/ws" {
        fmt.Println("path error")
        return false
      }
      return true
    },
  }
  return ws
}
func (self *WsServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  if r.URL.Path != "/ws" {
    httpCode := http.StatusInternalServerError
    reasePhrase := http.StatusText(httpCode)
    fmt.Println("path error ", reasePhrase)
    fmt.Println("path error,url=", r.URL.Path)
    http.Error(w, reasePhrase, httpCode)
    return
  }
  conn, err := self.upgrade.Upgrade(w, r, nil)
  if err != nil {
    fmt.Println("websocket error:", err)
    return
  }
  fmt.Println("client connect :", conn.RemoteAddr())
  go self.connHandle(conn)
}
func (self *WsServer) connHandle(conn *websocket.Conn) {
  defer func() {
    conn.Close()
  }()
  stopCh := make(chan int)
  go self.send(conn, stopCh)
  conn.SetReadLimit(maxMessageSize)
  conn.SetReadDeadline(time.Now().Add(pongWait))
  conn.SetPongHandler(func(string) error {
    fmt.Println("this is PongHandler")
    conn.SetReadDeadline(time.Now().Add(pongWait))
    if err := conn.WriteMessage(websocket.PongMessage, nil); err != nil {
      fmt.Println("resp pong error", err)
    } else {
      fmt.Println("resp pong ok")
    }
    return nil
  })
  for {
    conn.SetReadDeadline(time.Now().Add(time.Millisecond * time.Duration(60000)))
    _, msg, err := conn.ReadMessage()
    if err != nil {
      // 判断是不是超时
      if netErr, ok := err.(net.Error); ok {
        if netErr.Timeout() {
          fmt.Printf("ReadMessage timeout remote: %v\n", conn.RemoteAddr())
          close(stopCh)
          return
        }
      }
      // 其他错误,如果是 1001 和 1000 就不打印日志
      if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseNormalClosure) {
        fmt.Printf("ReadMessage other remote:%v error: %v \n", conn.RemoteAddr(), err)
      }
      //close(stopCh)
      return
    }
    fmt.Println("收到消息:", string(msg))
  }
}
//测试一次性发送 10万条数据给 client, 如果不使用 time.Sleep browser 过了超时时间会断开
func (self *WsServer) send10(conn *websocket.Conn) {
  for i := 0; i < 1; i++ {
    data := fmt.Sprintf("hello websocket test from server %v,count=%d", time.Now().UnixNano(), i+1)
    err := conn.WriteMessage(1, []byte(data))
    if err != nil {
      fmt.Println("send msg faild ", err)
      return
    }
    //time.Sleep(time.Millisecond * 1)
  }
}
func (self *WsServer) send(conn *websocket.Conn, stopCh chan int) {
  self.send10(conn)
  for {
    select {
    case <-stopCh:
      fmt.Println("connect closed")
      return
      // case <-time.After(time.Second * 1):
      //  fmt.Println("time after....")
    }
  }
}
func (w *WsServer) Start() (err error) {
  w.listener, err = net.Listen("tcp", w.addr)
  if err != nil {
    fmt.Println("net listen error:", err)
    return
  }
  err = http.Serve(w.listener, w)
  if err != nil {
    fmt.Println("http serve error:", err)
    return
  }
  return nil
}


相关文章
|
2月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
52 4
|
2月前
|
XML JSON API
ServiceStack:不仅仅是一个高性能Web API和微服务框架,更是一站式解决方案——深入解析其多协议支持及简便开发流程,带您体验前所未有的.NET开发效率革命
【10月更文挑战第9天】ServiceStack 是一个高性能的 Web API 和微服务框架,支持 JSON、XML、CSV 等多种数据格式。它简化了 .NET 应用的开发流程,提供了直观的 RESTful 服务构建方式。ServiceStack 支持高并发请求和复杂业务逻辑,安装简单,通过 NuGet 包管理器即可快速集成。示例代码展示了如何创建一个返回当前日期的简单服务,包括定义请求和响应 DTO、实现服务逻辑、配置路由和宿主。ServiceStack 还支持 WebSocket、SignalR 等实时通信协议,具备自动验证、自动过滤器等丰富功能,适合快速搭建高性能、可扩展的服务端应用。
138 3
|
1月前
|
设计模式 前端开发 数据库
Python Web开发:Django框架下的全栈开发实战
【10月更文挑战第27天】本文介绍了Django框架在Python Web开发中的应用,涵盖了Django与Flask等框架的比较、项目结构、模型、视图、模板和URL配置等内容,并展示了实际代码示例,帮助读者快速掌握Django全栈开发的核心技术。
151 45
|
9天前
|
开发框架 Go 计算机视觉
纯Go语言开发人脸检测、瞳孔/眼睛定位与面部特征检测插件-助力GoFly快速开发框架
开发纯go插件的原因是因为目前 Go 生态系统中几乎所有现有的人脸检测解决方案都是纯粹绑定到一些 C/C++ 库,如 OpenCV 或 dlib,但通过 cgo 调用 C 程序会引入巨大的延迟,并在性能方面产生显著的权衡。此外,在许多情况下,在各种平台上安装 OpenCV 是很麻烦的。使用纯Go开发的插件不仅在开发时方便,在项目部署和项目维护也能省很多时间精力。
|
18天前
|
Go API 数据库
Go 语言中常用的 ORM 框架,如 GORM、XORM 和 BeeORM,分析了它们的特点、优势及不足,并从功能特性、性能表现、易用性和社区活跃度等方面进行了比较,旨在帮助开发者根据项目需求选择合适的 ORM 框架。
本文介绍了 Go 语言中常用的 ORM 框架,如 GORM、XORM 和 BeeORM,分析了它们的特点、优势及不足,并从功能特性、性能表现、易用性和社区活跃度等方面进行了比较,旨在帮助开发者根据项目需求选择合适的 ORM 框架。
47 4
|
1月前
|
缓存 前端开发 中间件
go语言中Web框架
【10月更文挑战第22天】
42 4
|
1月前
|
SQL 安全 PHP
探索PHP的现代演进:从Web开发到框架创新
PHP是一种流行的服务器端脚本语言,自诞生以来在Web开发领域占据重要地位。从简单的网页脚本到支持面向对象编程的现代语言,PHP经历了多次重大更新。本文探讨PHP的现代演进历程,重点介绍其在Web开发中的应用及框架创新,如Laravel、Symfony等。这些框架不仅简化了开发流程,还提高了开发效率和安全性。
26 3
|
1月前
|
前端开发 JavaScript 开发工具
从框架到现代Web开发实践
从框架到现代Web开发实践
39 1
|
1月前
|
SQL 安全 PHP
探索PHP的现代演进:从Web开发到框架创新
PHP 自发布以来一直在 Web 开发领域占据重要地位,历经多次重大更新,从简单的脚本语言进化为支持面向对象编程的现代语言。本文探讨 PHP 的演进历程,重点介绍其在 Web 开发中的应用及框架创新。自 PHP 5.3 引入命名空间后,PHP 迈向了面向对象编程时代;PHP 7 通过优化内核大幅提升性能;PHP 8 更是带来了属性、刚性类型等新特性。
27 3
|
1月前
|
安全 数据库 开发者
Python Web开发:Django框架下的全栈开发实战
【10月更文挑战第26天】本文详细介绍了如何在Django框架下进行全栈开发,包括环境安装与配置、创建项目和应用、定义模型类、运行数据库迁移、创建视图和URL映射、编写模板以及启动开发服务器等步骤,并通过示例代码展示了具体实现过程。
51 2