登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

Go net/textproto.Reader.ReadCodeLine 怎样解析三位数字的响应状态行

来源:17golang原创

时间:2026-11-18 09:54:04 285浏览 收藏

我在接入一类“状态码加一句话”的文本协议时,最初把 net/textproto.Reader.ReadCodeLine 当成了普通的按行读取函数。真正使用后才发现,它已经替你完成了三位数字状态码的拆分、期望码前缀判断和协议错误包装。只要把它的三个返回值和读取边界分清,代码会比手写字符串切片稳定很多。

官方地址:https://pkg.go.dev/net/textproto#Reader.ReadCodeLine

ReadCodeLine 适合读取一条形如“3 位数字 + 空格 + 消息”的单行响应。它返回 code、message 和 error;需要检查响应类别时,把期望的前缀传给 expectCode,例如 31 会接受 310 到 319。

这次我把它和手写解析、ReadResponse 放在一起比较,结论很明确:单行响应优先用 ReadCodeLine,多行响应交给 ReadResponse,只有当协议完全不是三位数字状态行时才考虑自己解析。

先看清一行响应会返回什么

官方文档把输入描述为 code message:code 是三位状态数字,message 从分隔空格之后一直到本行结束。方法签名是:

// 读取一行三位状态码响应,并返回状态、消息和错误。
func (r *Reader) ReadCodeLine(expectCode int) (code int, message string, err error)

因此调用方不需要再把字符串转成整数,也不需要先用空格切一次。最值得记住的是:code 和 message 即使在错误场景里也可能带有服务端给出的信息,所以不要只看 err != nil 就把前两个返回值丢掉。

Go ReadCodeLine 将三位数字状态行拆成状态码、消息和错误的静态结构说明图
图1:ReadCodeLine 从单行响应到三个返回值的结构说明图;这是原创说明图,不是运行截图。
package main

import (
	"bufio"
	"fmt"
	"net/textproto"
	"strings"
)

func main() {
	// 用内存中的协议行演示 Reader 的输入形状,不代表线上服务输出。
	input := "220 ready for requests\r\n"
	r := textproto.NewReader(bufio.NewReader(strings.NewReader(input)))

	// 0 表示不检查期望码,只读取并拆出三位状态和消息。
	code, message, err := r.ReadCodeLine(0)
	if err != nil {
		// 底层读取或协议格式错误都必须交给调用方处理。
		fmt.Println("read failed:", err)
		return
	}
	fmt.Printf("code=%d message=%q\n", code, message)
}

这段示例中,code 是 220,message 是 ready for requests。返回的消息不包含行尾换行,调用方可以直接用于日志、分支判断或错误上下文。

expectCode 检查的是三位码的前缀

第二个体验点是 expectCode 的含义。它不是要求完整状态码相等,而是按传入数字的十进制前缀做范围判断。传入 31 时,310 到 319 都被视为匹配;传入 250 时,则只接受完整的 250。

expectCode接受范围适合的调用意图
0 或负数不检查状态码先读取原始响应,再自行决定策略
31310–319接受同一类临时响应
250仅 250要求一个明确的成功状态
func readReady(r *textproto.Reader) error {
	// 31 表示允许 310 到 319,适合协议把同一类响应细分编号的场景。
	code, message, err := r.ReadCodeLine(31)
	if err != nil {
		// 不匹配时 err 通常携带服务端返回的 code 和 message。
		return fmt.Errorf("ready response rejected: code=%d message=%q: %w", code, message, err)
	}
	// 成功分支仍可保留 code,便于记录具体的三位状态。
	_ = code
	_ = message
	return nil
}

我觉得这里比“读取后自己判断 code/100”更直观:期望的是哪个协议类别,直接写在调用点里。若业务规则不是前缀,而是多个离散状态的集合,仍然应该先读取,再用明确的 switch 表达集合,不要把多个语义压进一个模糊的数字。

成功、码不符和读取失败要分开处理

使用时最容易混在一起的是三种错误:服务端返回了不符合预期的三位码;输入不是合法的状态行;底层 reader 在读到完整行之前返回了 I/O 错误。它们的修复动作不同,不能统一写成“重试一次”。

  • 期望码不符:返回的 err 是 *textproto.Error,其中包含服务端状态码和消息,通常应按协议决定是否转入下一步或终止会话。
  • 格式不符合协议:可能得到 textproto.ProtocolError,说明响应行本身破坏了读取器预期。
  • 底层读取失败:例如连接关闭或读取超时,应保留原始错误用于网络层处理。
func readAndClassify(r *textproto.Reader, expect int) (int, string, error) {
	// 先读取一次,避免为了判断错误类型而重复消费协议流。
	code, message, err := r.ReadCodeLine(expect)
	if err == nil {
		return code, message, nil
	}

	var protocolErr textproto.ProtocolError
	if errors.As(err, &protocolErr) {
		// 协议格式错误不能盲目重试,先结束当前会话或记录原文。
		return code, message, fmt.Errorf("invalid response line: %w", err)
	}

	var codeErr *textproto.Error
	if errors.As(err, &codeErr) {
		// 状态码不符合预期,交给业务层按 code 决定分支。
		return code, message, fmt.Errorf("unexpected response code %d: %w", codeErr.Code, err)
	}

	// 其余错误保留原始链,便于识别 EOF、超时或连接中断。
	return code, message, err
}

这里的顺序也有讲究:先判断协议错误,再判断状态码错误,最后保留其他错误。调用方仍然可以从返回值拿到读到的数字和消息,但不能在 err != nil 时假定这两个值一定有业务意义。

ReadCodeLine 还是 ReadResponse

我第一次接入时差点用错了方法:把服务端的多行响应当成一行读取。两者的区别不是“一个简单、一个复杂”,而是协议边界不同。ReadCodeLine 读到一行就结束;ReadResponse 负责识别首行的连字符、继续读取中间行,并等待相同三位码加空格的终止行。

Go textproto 单行 ReadCodeLine 与多行 ReadResponse 的选择边界关系图
图2:单行与多行文本协议读取器的选择边界说明图;这是原创说明图,不是运行截图。
响应形态优先方法原因
220 readyReadCodeLine读取一行并拆出状态与消息
220-first\r\n220-second\r\n220 done 这类结束标记协议ReadResponse需要持续消费直到终止行
不是三位数字状态行按协议单独实现不要伪装成 textproto 的输入

如果错把多行响应交给 ReadCodeLine,它只能处理当前行,剩余行还留在 reader 中。下一次调用会从中间状态开始,后续错误看起来像是随机发生,实际是读取边界已经被破坏。

把一次读取收拢成可复用函数

在业务代码里,我通常不会让每个调用点都直接散落 ReadCodeLine。可以把期望码、原始响应和错误上下文收拢到一个小函数里,让上层只决定“成功后做什么、非预期状态是否结束连接”。

package client

import (
	"bufio"
	"errors"
	"fmt"
	"net/textproto"
)

func readStatus(br *bufio.Reader, expect int) (int, string, error) {
	// 每次调用都从同一个缓冲读取器消费一整行状态响应。
	r := textproto.NewReader(br)
	code, message, err := r.ReadCodeLine(expect)
	if err != nil {
		// 包装上下文但保留原始错误,调用方仍可使用 errors.As。
		return code, message, fmt.Errorf("read status line: %w", err)
	}
	return code, message, nil
}

func isUnexpectedCode(err error) bool {
	// 只把状态码不匹配识别为业务分支,避免把 EOF 当成协议拒绝。
	var codeErr *textproto.Error
	return errors.As(err, &codeErr)
}

这里有一个实际取舍:如果同一个连接需要连续读取多条响应,应该复用同一个 *textproto.Reader,而不是每次都围绕同一个 bufio.Reader 新建包装器。示例函数适合演示边界;长连接客户端应把 reader 作为会话对象的一部分保存。

几个容易踩到的边界

  • 不要把 31 当成状态码 31:它是三位状态码的前缀匹配规则。
  • 不要用它读取整段多行消息:单行方法成功返回后,协议流可能仍有后续行。
  • 不要丢掉 code 和 message:非预期状态往往需要它们来决定是否重试。
  • 不要给 reader 无限输入:textproto.NewReader 接收的底层 bufio.Reader 应结合有限读取器,避免异常响应无限增长。
  • 不要把任何错误都当作可重试:协议格式错误、状态码拒绝和连接中断是三个不同层次。

最后用一张表做选择

你的问题建议关键理由
响应是一行三位码加消息吗?用 ReadCodeLine直接获得 code、message、err
只允许某个状态类别吗?传入前缀,如 31按 310–319 做范围匹配
响应跨多行并有终止行吗?用 ReadResponse让读取器消费完整协议结构
错误是网络、格式还是码不符?用 errors.As 分型不同错误需要不同处理动作

对我来说,ReadCodeLine 的价值不在于少写几行字符串处理,而在于把“状态行长什么样”和“期望码怎样匹配”固定成一个可复用的协议边界。只要调用方不把单行和多行混用,并保留原始错误上下文,这个小方法足以覆盖大多数 code-message 读取场景。

相关问题

  • expectCode 传 0 会怎样?会关闭状态码检查,但仍会读取并解析三位状态行。
  • ReadCodeLine 能处理多行响应吗?不适合;多行协议应使用 ReadResponse。
  • 状态码不匹配时为什么还要看 message?因为服务端消息通常包含下一步处理所需的原因或提示。
声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>