Go regexp.Regexp FindReaderIndex 怎样定位输入流中的匹配区间

在处理日志流或逐段到达的文本时，很多人会把 FindReaderIndex 的返回值当成字符下标。真正需要记住的是：它接收 io.RuneReader，返回的 m[0]、m[1] 是匹配区间的字节偏移，匹配范围是输入的 [m[0]:m[1]]；没有匹配时返回 nil。另外，官方文档特别提醒，它可能继续从 reader 读取到返回匹配之外，所以不可回退的流不能把“已读位置”等同于“匹配结束位置”。

本文结论：如果你只需要定位整体匹配，使用 FindReaderIndex；如果还要捕获组，改用 FindReaderSubmatchIndex；如果后续还要重新读取原始输入，先在外层保留缓冲，不要依赖 reader 自动回退。

先看 FindReaderIndex 的返回语义

FindReaderIndex 的签名是 func (re *Regexp) FindReaderIndex(r io.RuneReader) (m []int)。它找的是最左侧匹配，返回两个整数：起点和结束点。这里的“点”按字节计数，这一点在中文、表情或其他多字节 UTF-8 文本中尤其容易误读。

例如输入中第一个匹配前有一个中文字符时，字符数量只增加 1，但字节位置会增加 3。拿返回值去切原始 UTF-8 字节切片时应使用字节下标；若先把同一内容转换成 rune 切片，又要重新计算 rune 下标，不能直接复用这两个数字。

package main

import (
	"fmt"
	"regexp"
	"strings"
)

func main() {
	// 使用 RuneReader 让 regexp 从字符串流中按字符读取输入。
	reader := strings.NewReader("前缀 error: disk full")
	re := regexp.MustCompile(`error: [a-z ]+`)
	match := re.FindReaderIndex(reader)
	if match == nil {
		// nil 表示没有整体匹配，不能直接访问 match[0]。
		fmt.Println("no match")
		return
	}
	// m[0] 和 m[1] 是原输入中的字节偏移，右端点不包含在匹配内。
	fmt.Printf("byte range: [%d, %d)\n", match[0], match[1])
}

代码中的 strings.Reader 实现了 io.RuneReader。示例只展示返回值的解释，不把输出数字当成所有输入都固定的结果；真实偏移取决于匹配前内容的 UTF-8 字节长度。

用 RuneReader 处理流式输入时，边界在哪里

io.RuneReader 只要求提供 ReadRune() (rune, size, error)。其中 size 是当前编码字符占用的字节数，所以 regexp 可以在字符边界上读取，同时累计原始输入的字节位置。它并不要求 reader 支持 UnreadRune，也不承诺搜索完成后把输入退回匹配结束的位置。

这带来一个工程取舍：普通字符串、文件缓冲或自己维护的 reader 通常可以接受这种读取行为；网络流、管道等不可回退来源则要在进入正则搜索前设计缓冲层。缓冲层保存的是已被读取但尚未交给后续业务的数据，业务不能假设 regexp 只消耗匹配本身。

处理 nil 和可能的超前读取

返回 nil 只有一个直接含义：整个输入中没有找到匹配。它不是空匹配的通用替代品，也不是 reader 发生错误的详细诊断。调用方至少要先判断 nil，再访问两个下标；如果业务还要区分“输入结束”“读取错误”和“确实不匹配”，就应在 reader 外层记录错误状态。

“可能读远”是使用这个 API 时最值得记住的边界：匹配已经结束，不代表底层 reader 的当前位置正好停在 m[1]。如果你需要子表达式的整体和分组区间，可以选择 FindReaderSubmatchIndex；如果需要保留原文，配合可回放缓冲或直接对已收集的字节/字符串调用 FindIndex、FindStringIndex，通常更容易控制。

按需求选择 API

可以把问题收敛成一句话：你要的是“流上的一次定位”，还是“可重复使用的原文区间”。前者适合 FindReaderIndex，后者优先把输入纳入自己的缓冲和生命周期管理。

常见问题

FindReaderIndex 返回的下标是 rune 下标吗？

不是，是匹配起止位置的字节偏移。UTF-8 多字节字符会让字节位置和字符数量不同。

找到匹配后 reader 会停在 m[1] 吗？

不能这样假设。文档允许它继续读取到返回匹配之外；需要回放时请使用外部缓冲或已收集的输入。