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

Go net/textproto.Writer.DotWriter 怎样写入需要点转义的协议正文

来源:17golang原创

时间:2026-11-18 18:21:16 450浏览 收藏

如果协议正文允许普通文本,却规定“单独一行的点”表示正文结束,直接调用 Write 很容易把数据边界写错。Go 的 net/textproto.Writer.DotWriter 专门处理这种点编码文本块:它会为需要转义的行首点补点,把换行写成协议常用的 \r\n,并在关闭时补上结束行。

官方文档:https://pkg.go.dev/net/textproto#Writer.DotWriter

这篇只解决一个问题:怎样把一段正文安全地交给 DotWriter。核心顺序是 bufio.Writer → textproto.Writer → DotWriter() → Write → Close → Flush。其中 Close 负责结束点编码块,Flush 负责把外层缓冲区的字节送出去,两者不是同一个动作。

先划清 DotWriter 的目标和边界

点编码正文通常按行组织:正文以 \r\n 结束,单独一行的 .\r\n 表示正文结束;如果正文中的某行本来就以点开头,就要额外再写一个点,避免接收方误判为结束行。DotWriter 把这些协议细节封装起来,调用者只需要写入未编码的正文。

它适合文本协议中的正文块,不是任意二进制文件的通用编码器,也不会替你完成 SMTP 命令、状态码或连接管理。要写一条普通协议行,仍然应该使用 PrintfLine 或外层的普通写入方法;要写正文块,才进入 DotWriter 生命周期。

bufio.Writer、textproto.Writer、DotWriter 和点编码正文之间的静态结构关系
图1:写入链结构说明图,展示 DotWriter 如何挂在 textproto.Writer 与协议正文之间;这是原创静态说明图,不是运行截图。

从 bufio.Writer 到 DotWriter

创建对象时,先准备一个 *bufio.Writer,再交给 textproto.NewWriter。DotWriter() 返回的是 io.WriteCloser,所以正文阶段要围绕这个短生命周期对象处理写入和关闭错误。

package main

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

func writeDotBody() (string, error) {
    var dst bytes.Buffer
    buffered := bufio.NewWriter(&dst)
    writer := textproto.NewWriter(buffered)

    body := writer.DotWriter()
    // 正文按未编码形式写入,行首的点交给 DotWriter 处理。
    if _, err := body.Write([]byte("Subject: demo\n.line starts with dot\nlast line\n")); err != nil {
        return "", fmt.Errorf("写入点编码正文失败: %w", err)
    }
    // Close 会写入点编码块的结束行,必须在继续使用 writer 前完成。
    if err := body.Close(); err != nil {
        return "", fmt.Errorf("关闭点编码正文失败: %w", err)
    }
    // DotWriter 的 Close 不等于外层缓冲区 Flush,最后仍要刷新 buffered。
    if err := buffered.Flush(); err != nil {
        return "", fmt.Errorf("刷新协议缓冲区失败: %w", err)
    }
    return dst.String(), nil
}

这里的关键不是把 DotWriter 当成一个普通的 io.Writer 用到底,而是把它看成“一个正文块的写入会话”。写入正文、关闭会话、刷新外层缓冲区,分别对应三个责任。

Write、Close 和 Flush 各自负责什么

Write:接收未编码正文。遇到行首点时,写入器会补上额外的点;输入中的换行会按文档规则转换为 \r\n。因此正文不要提前为了“看起来像协议格式”重复转义,否则可能把内容改成双重转义。

Close:结束当前点编码块,并添加最终的 .\r\n。它可能返回底层写入错误,所以不建议只写一个没有错误处理的 defer body.Close()。如果函数后面还要调用 writer.PrintfLine,更应该显式关闭。

Flush:只属于外层的 bufio.Writer。即使 body.Close() 已成功,数据仍可能留在缓冲区;只有 Flush 成功后,才完成从应用写入到下层流的交接。

阶段对象关注点
正文写入io.WriteCloser行首点和换行由 DotWriter 处理
正文结束body.Close()写入点编码结束行并返回错误
缓冲交付buffered.Flush()把外层缓冲区内容交给下层 Writer
DotWriter 的 Write、Close、Flush 与 PrintfLine 生命周期边界说明图
图2:生命周期边界说明图,对比 DotWriter 的文本块职责与 Flush、PrintfLine 的相邻职责;这是原创结构说明图,不是执行结果截图。

什么时候不要使用 DotWriter

如果当前内容只是状态码、命令或一条普通协议行,不需要点终止语义,就不要为了统一而套一层 DotWriter。PrintfLine 的职责是写一行并处理行结束;DotWriter 的职责是维护一个可能包含行首点的多行正文块。把两者混在同一个未关闭的会话里,最容易造成结束行位置错误。

另外,正文写入完成后不要继续向同一个 DotWriter 写数据,也不要在未关闭它之前调用 textproto.Writer 的其他方法。先关闭正文块,再写后续协议内容,最后统一处理外层缓冲错误,边界会清晰很多。

常见问题

为什么写了正文却没有结束行?

通常是只调用了 Write,没有调用 Close。DotWriter 的结束行属于关闭动作,不是第一次写入自动完成的。

Close 成功后还要 Flush 吗?

要看外层是否使用了 bufio.Writer。如果用了,就继续检查 Flush;Close 结束的是点编码块,Flush 刷新的是缓冲区。

正文里本来就有一个点,应该手动写两个点吗?

不应该。把未编码正文交给 DotWriter,由它根据行位置完成点转义。手动预先加点会让内容语义和协议编码混在一起。

速查:正文用 DotWriter,普通行用 PrintfLine;正文结束先 Close,缓冲交付再 Flush;遇到行首点不手动重复转义。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>