Go 正则 Compile 失败时怎样把语法错误定位到输入

Go 里调用 regexp.Compile 失败，通常不是“文本没匹配上”，而是规则本身还没有通过解析。处理这类问题的关键顺序是：先保留 error，再用 regexp/syntax.Error 取出错误类别和问题表达式；只有编译成功后，MatchString 返回 false 才表示当前输入没有命中。

一、先把 Compile 失败和匹配不到分开

regexp.Compile 做的是“解析并构造正则对象”。例如配置里少写了一个右括号，函数会返回错误，此时没有可用的 *regexp.Regexp。不要在运行期规则上直接使用 MustCompile，因为它会把解析失败变成 panic。

package main

import (
	"fmt"
	"regexp"
)

func compileRule(pattern string) (*regexp.Regexp, error) {
	// 动态规则必须保留 error，让调用方决定如何提示或回退。
	re, err := regexp.Compile(pattern)
	if err != nil {
		return nil, fmt.Errorf("正则规则 %q 无法编译: %w", pattern, err)
	}
	return re, nil
}

这里的错误上下文包含原始输入，便于把配置项、请求字段或规则版本一起记录。若 compileRule 成功，后续才可以调用 re.MatchString(text)；匹配失败只返回 false，不会再次产生解析错误。

二、用 syntax.Error 取出错误类型和问题表达式

普通打印 err.Error() 能看到人类可读的提示，但排错时还可以用 errors.As 解包为 *syntax.Error。官方类型包含 Code 和 Expr：前者说明是缺少括号、非法转义还是不支持的语法，后者给出解析器认为有问题的表达式。

package main

import (
	"errors"
	"fmt"
	"regexp"
	"regexp/syntax"
)

func describeRule(pattern string) error {
	// Compile 阶段只检查规则语法，不代表它一定能匹配业务文本。
	_, err := regexp.Compile(pattern)
	if err == nil {
		return nil
	}
	var parseErr *syntax.Error
	if errors.As(err, &parseErr) {
		// Code 适合机器判断，Expr 适合给排错日志定位输入。
		return fmt.Errorf("规则解析失败: code=%s expr=%q: %w", parseErr.Code, parseErr.Expr, err)
	}
	return fmt.Errorf("规则编译失败: %w", err)
}

要注意一个边界：Expr 是解析器报告的问题表达式，不是带行号和列号的编辑器诊断对象。若规则很长，日志还应保留原始字符串、配置键和请求标识；不要把 Expr 误解为精确字符偏移。

三、区分语法错误、匹配不到和字面量误解释

例如搜索框要查找用户输入的 a.b，直接拼接会把点解释成“任意字符”。这不是 Compile 失败，而是语义错误，应该在构造规则时明确区分“用户提供正则”还是“用户提供普通文本”。

func literalRule(word string) (*regexp.Regexp, error) {
	// QuoteMeta 将正则元字符转为字面量，避免输入改变规则含义。
	return regexp.Compile(`^` + regexp.QuoteMeta(word) + `$`)
}

四、确定 MustCompile 和测试边界

MustCompile 适合包级变量或固定规则：规则随代码发布、单元测试覆盖，启动时 panic 能尽早暴露程序错误。来自数据库、环境变量、管理员配置或请求参数的规则则应使用 Compile，把 Code、Expr 和配置来源返回给调用方。

测试时至少覆盖三组：缺少括号等确定的语法错误；合法但匹配不到的文本；包含元字符的普通字面量。这样可以避免修复了错误提示，却把运行期匹配语义一起改坏。

相关问题

为什么不能用 MustCompile 统一处理错误？

它的契约是解析失败就 panic，适合固定源码规则，不适合把外部输入变成进程级故障。

MatchString 返回 false 是正则写错了吗？

不一定。只要 Compile 成功，false 只说明当前文本没有匹配，先检查输入、锚点和字符类。

怎样记录最有用的正则错误？

同时记录配置键、原始规则、syntax.Error 的 Code 和 Expr，再关联请求或配置版本；不要只保留一段没有上下文的字符串。