使用go-xmpp连接ejabberd时多用户并发发消息出现随机错误

问题现象 #

使用github.com/mattn/go-xmpp/xmpp包向ejabberd发送消息时，偶发以下随机错误：

• 客户端错误：预期成功或失败结果，在http://etherx.jabber.org/streams中获取到错误
• 客户端错误：反序列化iq：预期元素类型为iq但获取到error
• 客户端错误：反序列化features：预期元素类型为features但未获取到对应元素

原始代码如下：

package main

import (
    "log"
    "time"
    "github.com/mattn/go-xmpp/xmpp"
)

func main() {
    options := xmpp.Options{
        Host:        "your_ejabberd_host",
        User:        "your_username",
        Password:    "your_password",
        Debug:       true,
        NoTLS:       false,
        DialTimeout: time.Second * 10,
    }

    conn, err := options.NewClient()
    if err != nil {
        log.Fatal("Failed to create XMPP client:", err)
    }

    // Send a sample message
    err = conn.Send(xmpp.Chat{
        Remote: "recipient_jid@example.com",
        Type:   "chat",
        Text:   "Hello, this is a test message!",
    })
    if err != nil {
        log.Fatal("Failed to send message:", err)
    }
    conn.Close()
    return
}

可能原因 #

这些偶发错误本质是XMPP流交互的时序不匹配或连接状态异常：

• 网络波动导致流数据传输不完整，客户端解析XML时出现元素缺失/顺序错误
• 服务器握手阶段返回的扩展元素未被客户端正确处理
• 连接关闭时未完成XMPP流的正常终止流程，引发服务器异常响应
• 客户端初始化时未显式指定XMPP版本，服务器返回兼容模式流导致解析冲突

解决方案 #

针对上述问题，可通过以下优化解决：

1. 添加连接重试逻辑
   偶发的初始化错误可通过重试规避，设置合理的重试次数和间隔

2. 确保流的正确终止
   使用defer延迟关闭连接，并在关闭前发送流终止指令（部分场景下conn.Close()未完整处理流终止）

3. 发送前检查连接状态
   发送消息前确认连接处于活跃状态，避免向已断开的连接发送数据

4. 显式指定XMPP版本
   在Options中设置Version: "1.0"，强制服务器使用标准XMPP 1.0流格式

修改后的代码 #

package main

import (
    "log"
    "time"
    "github.com/mattn/go-xmpp/xmpp"
)

const maxRetry = 3
const retryInterval = time.Second * 2

func createXMPPClient(options xmpp.Options) (*xmpp.Client, error) {
    var conn *xmpp.Client
    var err error
    // 连接重试逻辑
    for i := 0; i < maxRetry; i++ {
        conn, err = options.NewClient()
        if err == nil {
            return conn, nil
        }
        log.Printf("Connection attempt %d failed: %v, retrying...", i+1, err)
        time.Sleep(retryInterval)
    }
    return nil, err
}

func main() {
    options := xmpp.Options{
        Host:        "your_ejabberd_host",
        User:        "your_username",
        Password:    "your_password",
        Debug:       true,
        NoTLS:       false,
        DialTimeout: time.Second * 10,
        Version:     "1.0", // 显式指定XMPP 1.0版本
    }

    conn, err := createXMPPClient(options)
    if err != nil {
        log.Fatal("Failed to create XMPP client after retries:", err)
    }
    defer func() {
        // 显式发送流终止指令
        if err := conn.SendRaw("</stream:stream>"); err != nil {
            log.Printf("Failed to close stream properly: %v", err)
        }
        conn.Close()
    }()

    // 检查连接状态
    if !conn.IsConnected() {
        log.Fatal("XMPP client is not connected")
    }

    // Send a sample message
    err = conn.Send(xmpp.Chat{
        Remote: "recipient_jid@example.com",
        Type:   "chat",
        Text:   "Hello, this is a test message!",
    })
    if err != nil {
        log.Fatal("Failed to send message:", err)
    }

    log.Println("Message sent successfully")
    return
}

额外排查建议 #

• 查看Debug日志中的XML流交互内容，定位具体是哪个阶段出现异常元素
• 检查ejabberd的日志，确认服务器是否返回了错误流或异常响应
• 调整DialTimeout和读写超时（可通过options.SetReadTimeout设置），适配网络环境

内容的提问来源于stack exchange，提问作者Anoop Kumar