在浏览器中正确调用 Go WebSocket JSON-RPC 服务的完整指南

阿瑶酱_8621

阿瑶酱_8621

2026-05-28

316人浏览

原创

在浏览器中正确调用 Go WebSocket JSON-RPC 服务的完整指南

Go 的 net/rpc/jsonrpc 不兼容浏览器原生 WebSocket,因其底层期望裸 TCP 流而非 WebSocket 帧;需改用自定义 WebSocket Codec 或协议适配层,才能让浏览器通过 new WebSocket() 安全发起 JSON-RPC 调用。

go 的 `net/rpc/jsonrpc` 不兼容浏览器原生 websocket,因其底层期望裸 tcp 流而非 websocket 帧;需改用自定义 websocket codec 或协议适配层,才能让浏览器通过 `new websocket()` 安全发起 json-rpc 调用。

你遇到的问题本质是协议语义错位:浏览器使用标准 WebSocket 协议(RFC 6455)建立连接并发送 JSON-RPC 格式的消息帧,而 jsonrpc.ServeConn(ws.UnderlyingConn()) 实际接管的是 WebSocket 底层的 net.Conn,并期望接收原始、无帧头的 JSON-RPC 字节流(即 JSON-RPC over raw TCP)。但 ws.UnderlyingConn() 在 gorilla/websocket 中并非真正的裸 TCP 连接——它已被 WebSocket 协议栈封装/解包,直接传给 jsonrpc.ServeConn 会导致协议解析失败,服务端在读取第一个“帧”时即触发错误(如 io: read/write on closed pipe 或 websocket: close 1006),随即关闭连接,因此你完全看不到 RPC 方法被调用的日志。

✅ 正确解法:实现 WebSocket-aware ServerCodec

要使浏览器 WebSocket 客户端与 Go net/rpc 无缝协作,必须绕过 jsonrpc.ServeConn,转而构建一个 WebSocket 原生的 RPC 编解码器(ServerCodec),它能:

  • 在 ReadRequestHeader / ReadRequestBody 中主动从 *websocket.Conn 读取完整 JSON-RPC 请求帧(ReadMessage);
  • 解析 JSON-RPC 2.0 请求结构(含 method, params, id);
  • 将 params 反序列化为 Go 结构体,并注入连接上下文(如远程地址、header);
  • 在 WriteResponse 中将响应按 JSON-RPC 2.0 格式序列化后,通过 WriteMessage 发送回客户端。

以下是一个轻量、生产可用的实现示例:

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
// websocket_codec.go
package main

import (
    "context"
    "encoding/json"
    "net/rpc"
    "net/rpc/jsonrpc"
    "reflect"

    "github.com/gorilla/websocket"
)

type WebSocketCodec struct {
    conn *websocket.Conn
}

func NewWebSocketCodec(conn *websocket.Conn) *WebSocketCodec {
    return &WebSocketCodec{conn: conn}
}

func (c *WebSocketCodec) ReadRequestHeader(r *rpc.Request) error {
    _, data, err := c.conn.ReadMessage()
    if err != nil {
        return err
    }
    var req struct {
        JSONRPC string      `json:"jsonrpc"`
        Method  string      `json:"method"`
        Params  interface{} `json:"params"`
        ID      interface{} `json:"id"`
    }
    if err := json.Unmarshal(data, &req); err != nil {
        return err
    }
    r.ServiceMethod = req.Method
    r.Seq = uint64(0) // Seq unused in HTTP/WebSocket mode; ID handled in body
    return nil
}

func (c *WebSocketCodec) ReadRequestBody(x interface{}) error {
    _, data, err := c.conn.ReadMessage()
    if err != nil {
        return err
    }
    return json.Unmarshal(data, x)
}

func (c *WebSocketCodec) WriteResponse(r *rpc.Response, body interface{}) error {
    resp := map[string]interface{}{
        "jsonrpc": "2.0",
        "result":  body,
        "id":      r.Seq, // Note: real impl should track ID from request
    }
    data, _ := json.Marshal(resp)
    return c.conn.WriteMessage(websocket.TextMessage, data)
}

func (c *WebSocketCodec) Close() error {
    return c.conn.Close()
}

? 服务端集成(修正 serveWS)

func serveWS(w http.ResponseWriter, r *http.Request) {
    ws, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Println("Upgrade failed:", err)
        return
    }
    defer ws.Close() // Ensure cleanup on exit

    // 使用自定义 Codec 替代 jsonrpc.ServeConn
    codec := NewWebSocketCodec(ws)
    server := rpc.NewServer()
    server.RegisterName("Service", new(Service))
    server.ServeCodec(codec)
}

? 浏览器端注意事项(index.html 补充)

你的前端 JSON-RPC 请求需严格遵循 JSON-RPC 2.0 规范(推荐):

function send() {
  const msg = {
    jsonrpc: "2.0",
    method: "Service.Echo",
    params: ["hello"], // 注意:params 必须是数组(即使单参数)
    id: Date.now()     // 非零值,用于匹配响应
  };
  ws.send(JSON.stringify(msg));
}

同时,监听响应时应解析 id 和 result 字段:

ws.onmessage = function(ev) {
  const resp = JSON.parse(ev.data);
  if (resp.id && resp.result !== undefined) {
    alert("Response: " + resp.result);
  }
};

⚠️ 关键注意事项

  • ❌ 不要再调用 ws.UnderlyingConn() —— 它在 WebSocket 升级后已不可靠,且违反协议分层;
  • ✅ 必须手动管理 *websocket.Conn 生命周期:ServeCodec 返回后需确保 Close() 被调用(上述 defer ws.Close() 位置错误,应移至 ServeCodec 调用之后或使用 context 控制);
  • ? net/rpc/jsonrpc 包本身不支持 WebSocket 传输层,这是设计限制,非 bug;强行桥接需完全替换编解码逻辑;
  • ? 若需获取客户端 IP 或 header,请在 serveWS 中将 r.RemoteAddr 或 r.Header 注入 context.Context,再通过反射注入到 Args.Context 字段(参考知识库中 WebSocketContextCodec 方案);
  • ? 性能提示:每个 WebSocket 连接对应一个独立 rpc.Server 实例或共享 rpc.DefaultServer,注意并发安全(rpc.Server 是线程安全的)。

通过以上改造,你的浏览器即可像调用任意 WebSocket API 一样,与 Go 后端完成标准 JSON-RPC 2.0 交互,既保持协议兼容性,又规避了底层网络抽象泄漏风险。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json 浏览器 websocket

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3349

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2368

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1300

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1258

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2238

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3640

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16775

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习