Go regexp.Expand 如何复用命名捕获组：模板边界、ExpandString 与替换验收

做日志脱敏或消息改写时，正则已经找到了目标片段，真正容易写错的却是“怎么把捕获结果放回模板”。Go 的 regexp.Expand 和 ExpandString 不负责重新匹配，它们只根据捕获索引把模板展开到目标缓冲区；因此最稳的做法是先保存 FindSubmatchIndex 的结果，再选择字节版或字符串版完成替换。

把 Expand 当作“捕获区间到模板的展开器”，不要把它当成会自动查找匹配的替换函数。模板中的 $name 必须对应正则里的命名捕获组，未参与匹配的组会展开为空。

先把匹配和展开拆成两个阶段

下面的例子处理一行带账号和手机号的日志。正则只负责找到边界，FindStringSubmatchIndex 返回整段匹配及各个捕获组的字节区间；真正生成“用户 alice，电话 13800000000”的工作交给 ExpandString。

package main

import (
    "fmt"
    "regexp"
)

var logLine = regexp.MustCompile(`user=(?P[a-z]+) phone=(?P[0-9]+)`)

func main() {
    src := "level=INFO user=alice phone=13800000000"
    idx := logLine.FindStringSubmatchIndex(src)
    if idx == nil {
        return
    }
    out := logLine.ExpandString(nil, "account=$user mobile=$phone", src, idx)
    fmt.Println(string(out))
}

这里先检查 idx == nil，避免把没有匹配的结果继续传给展开器。输出应为 account=alice mobile=13800000000，而不是包含原日志前缀的整行文本。这个边界很关键：ExpandString 只按索引读取 src，不会替你决定要保留哪些未匹配文本。

模板变量如何对应命名捕获组

命名捕获组的名字是模板展开的契约。(?P...) 对应 $user；当变量名后面紧跟普通字母时，建议使用 ${user} 明确边界，否则模板解析可能把后面的字母也当成变量名的一部分。

如果业务要求字段缺失时保留占位符，不能指望 ExpandString 自动报警。应该在展开前检查捕获组名称，或者在展开后对结果做显式校验。

字节流场景用 Expand 复用 dst

处理请求体、日志缓冲或文件片段时，输入往往已经是 []byte。这时使用 Expand，并把已有容量的切片作为 dst。函数会把展开结果追加到 dst，所以复用前要把长度清零，不能只依赖容量。

func redact(src []byte, re *regexp.Regexp) []byte {
    idx := re.FindSubmatchIndex(src)
    if idx == nil {
        return append([]byte(nil), src...)
    }

    dst := make([]byte, 0, len(src)+16)
    dst = re.Expand(dst, []byte("account=$user mobile=$phone"), src, idx)
    return dst
}

示例中 dst 从零长度开始，Expand 追加模板和捕获值后返回新的切片。若把上一次结果的完整切片直接传入，新的结果前面就会残留旧文本。需要拼接前后文时，应明确调用 append 的顺序，而不是让展开器猜测原文范围。

大批量替换前先做方案取舍

单次替换可以直接使用 ExpandString(nil, ...)；连续处理字节数据则更适合准备一个清空长度后的缓冲区。两种方式的差别不在匹配能力，而在输入类型、输出生命周期和是否需要复用容量。

• 字符串已经在内存中，结果马上转成字符串或写入响应：优先 ExpandString。
• 输入来自字节缓冲，后续还要写入编码器：优先 Expand。
• 多 goroutine 同时处理：每次调用使用自己的 dst，不要共享可变切片。

这里不要把复用容量误读成“函数内部有全局缓存”。regexp.Regexp 可以被并发安全地使用，但传入的 dst 仍是调用方的可变数据，生命周期需要调用方自己管理。

用边界用例验收输出

至少覆盖匹配成功、完全不匹配、某个可选组缺失和模板变量边界四类情况。重点不是比较一条漂亮的示例字符串，而是确认每个捕获区间都从同一份原文读取，并且输出缓冲区没有串入上一次结果。

func TestExpandBoundary(t *testing.T) {
    re := regexp.MustCompile(`user=(?P[a-z]+)(?: phone=(?P[0-9]+))?`)
    src := "user=alice"
    idx := re.FindStringSubmatchIndex(src)
    got := string(re.ExpandString(nil, "${user}_id=$phone", src, idx))
    if got != "alice_id=" {
        t.Fatalf("got %q", got)
    }
}

这个测试刻意让 phone 没有参与匹配，预期结果是空字符串，而不是报错或保留字面量 $phone。生产代码还应在 idx == nil 时单独处理，不能把 nil 索引传给展开器后再猜结果。

相关问题

Expand 会自动查找正则匹配吗？

不会。它只消费调用方提供的捕获索引；通常先调用 FindSubmatchIndex 或对应方法，再调用 Expand。

Expand 和 ExpandString 应该怎么选？

输入是 []byte 时选 Expand，输入是字符串时选 ExpandString。两者都适合把捕获组放入模板。

未匹配的命名捕获组会返回错误吗？

不会，未参与匹配的组通常展开为空。若业务不允许空值，应在展开后或展开前增加明确校验。

收尾检查

把职责拆开后，排查这类替换问题只需核对三件事：正则是否真的产生了捕获索引，模板变量是否与命名组一致，输出 dst 是否以正确长度开始。先验证这三个边界，再讨论性能和缓冲区复用，定位会快很多。