Go处理net包读超时错误时internal包引用报错方案咨询

问题描述 #

使用conn.SetReadDeadline为网络连接conn设置读超时后，若conn.Read等待数据包时长超过设定阈值，会返回*net.OpError类型错误——这是net包对所有非io.EOF类错误统一包装后的返回类型。
通过Unwrap()方法可以拿到包装前的原始错误，读超时对应的原始错误类型为*poll.DeadlineExceededError，因此最初编写了如下代码尝试精准识别读超时场景：

import "internal/poll"

_, err = conn.Read(p)

if err != nil {
    if pe, ok := err.(*net.OpError); ok {
        err = pe.Unwrap()
        if timeout, ok := err.(*poll.DeadlineExceededError); ok {
            log.Error(fmt.Sprintf("%T, %s", timeout, timeout))
        }
    }
    return
}

代码编译时抛出use of internal package internal/poll not allowed错误，提示internal包不允许外部项目引用。网上有方案称删除internal文件夹即可解决该问题，需要确认该方案是否合规，以及是否存在标准的实现方式。

解答 #

删除internal文件夹完全不是合规的最终解决方案。这种操作会直接破坏Go标准库的目录结构，后续Go版本升级、交叉编译、依赖构建都会出现不可预期的异常，属于风险极高的野路子做法，完全不推荐使用。
Go设计internal目录机制的核心目的就是对外隐藏内部实现逻辑，这些内部包的类型定义、API、实现逻辑没有任何跨版本兼容性承诺，哪怕是小版本迭代都可能发生调整，本身就不应该被外部业务代码直接引用。

针对读超时错误识别，标准库已经提供了稳定的公共API，不需要依赖任何内部包，有两种通用实现方案：

• 方案一：使用net.Error接口内置的Timeout()方法判断，该接口从Go早期版本就已稳定提供，所有网络类超时错误都实现了该方法，兼容性最好：

import (
    "errors"
    "net"
)

// ...

if err != nil {
    var opErr *net.OpError
    if errors.As(err, &opErr) && opErr.Timeout() {
        log.Error("connection read timeout", "err", err)
        // 在此处编写读超时的专属处理逻辑
    }
    return
}

• 方案二：Go 1.13及以上版本支持错误链判断，可以直接用errors.Is匹配标准库对外暴露的公共错误值os.ErrDeadlineExceeded，不需要手动逐层Unwrap错误：

import (
    "errors"
    "os"
)

// ...

if err != nil {
    if errors.Is(err, os.ErrDeadlineExceeded) {
        log.Error("read deadline exceeded", "err", err)
        // 在此处编写读超时的专属处理逻辑
    }
    return
}

两种方案都不需要感知net.OpError内部包装的具体错误类型，哪怕后续Go版本调整内部超时错误的实现，只要是通过SetDeadline触发的超时，上述判断逻辑都能正常生效，不存在版本兼容性问题。

内容的提问来源于stack exchange，提问作者江南薛