Go go/scanner.ErrorList.Add 怎样保留多个源码位置对应的扫描错误
来源:17golang原创
时间:2026-11-18 09:51:15 459浏览 收藏
在使用 go/scanner 扫描一段可能包含多处语法问题的 Go 源码时,不要只保留最后一次回调。把 Scanner.Init 的错误处理器连接到一个 scanner.ErrorList,每次收到位置和消息就调用 ErrorList.Add,即可得到一组可排序、可去重、可统一返回的诊断信息。
官方文档:https://pkg.go.dev/go/scanner#ErrorList.Add
ErrorList.Add本身不负责发现错误,它只把一个token.Position和一条消息封装成*scanner.Error追加到列表。真正的多错误保留发生在错误回调中;扫描结束后再根据需要调用Sort、RemoveMultiples和Err。
先看清 Add 的参数和返回值
它的签名是 func (p *ErrorList) Add(pos token.Position, msg string)。第一个参数描述错误对应的文件、行、列和偏移,第二个参数是面向调用方的诊断文本。方法没有返回值,调用后列表长度增加一项。
ErrorList 是 []*scanner.Error 的切片类型,零值就是空列表,因此通常不需要额外的构造函数。指针接收者意味着应把列表地址传给回调,但不代表必须先分配一个复杂对象。
var errors scanner.ErrorList
// 把一次扫描回调转换成一个带源码位置的错误条目。
errors.Add(token.Position{Filename: "demo.go", Line: 3, Column: 7}, "缺少右括号")
// 空列表时 Err 返回 nil;有条目时返回等价的 error。
if err := errors.Err(); err != nil {
fmt.Println(err)
}
这段写法适合手动补充诊断,但在真实扫描中一般让 Scanner 每次发现问题时自动调用一个闭包。

用 ErrorHandler 保留多个位置
Scanner.Init 的第三个参数类型是 scanner.ErrorHandler,也就是接收 token.Position 和消息的函数。闭包捕获 errors 后,每次回调都追加一条记录,不会覆盖前一条。
package main
import (
"fmt"
"go/scanner"
"go/token"
)
func collectScanErrors(src []byte) error {
var errors scanner.ErrorList
fset := token.NewFileSet()
file := fset.AddFile("demo.go", fset.Base(), len(src))
var s scanner.Scanner
s.Init(file, src, func(pos token.Position, msg string) {
// 每次回调都追加,不要用单个 error 变量覆盖之前的位置。
errors.Add(pos, msg)
}, scanner.ScanComments)
for {
_, tok, _ := s.Scan()
if tok == token.EOF {
break
}
}
// 扫描器可能继续给出 token,错误仍要通过列表判断。
errors.Sort()
return errors.Err()
}
func main() {
if err := collectScanErrors([]byte("package main\nfunc main( {\n")); err != nil {
// Err 返回的值仍可交给标准 error 处理链。
fmt.Println(err)
}
}
这里的关键是“回调次数对应条目数量”,而不是循环次数。扫描器遇到错误后可能尽量继续扫描,所以不能因为仍然拿到了合法 token,就推断源码没有问题。
排序和按行去重怎么选
多处错误收集完成后,可以先调用 Sort,让带位置的错误按源码位置排列。若同一行上出现多个诊断,而调用方只希望每行看到第一条,可再调用 RemoveMultiples;它会排序并移除每行除第一条之外的错误。
var errors scanner.ErrorList
// 同一行保留两条不同问题,演示“全部保留”和“每行一条”的差别。
errors.Add(token.Position{Filename: "demo.go", Line: 2, Column: 5}, "缺少标识符")
errors.Add(token.Position{Filename: "demo.go", Line: 2, Column: 12}, "表达式不完整")
errors.Add(token.Position{Filename: "demo.go", Line: 4, Column: 1}, "意外的右括号")
errors.Sort() // 只排序,不减少条目。
// errors.RemoveMultiples() // 需要按行压缩时再启用,会修改列表。
for _, item := range errors {
// Error.Pos 保留文件、行、列,Error.Msg 保留诊断文本。
fmt.Printf("%s:%d:%d: %s\n", item.Pos.Filename, item.Pos.Line, item.Pos.Column, item.Msg)
}
如果编辑器需要精确标记列,使用 Sort 而不要调用 RemoveMultiples。如果页面只展示每行一条摘要,后者可以减少重复提示,但它不是“去掉同一条错误”的通用去重器,而是按行保留第一项。

Err、Error 和 PrintError 的使用边界
Err 适合作为函数的统一返回值:空列表返回 nil,有错误时返回一个等价于列表的 error。如果需要在命令行按行打印,可以使用 scanner.PrintError;它识别 ErrorList 时会逐条输出,否则输出普通错误文本。
需要注意三个边界:
Add不会替你校正位置。传入的token.Position应来自扫描器回调或同一文件集合的正确位置。RemoveMultiples会改变列表内容,调用前先确定调用方是否需要同一行的多个列级诊断。- 扫描结果中没有
token.ILLEGAL,也不能单独证明没有语法错误;应检查错误处理器是否被调用,或检查Scanner.ErrorCount。
一张表记住最小选择
| 目标 | 调用 | 结果 |
|---|---|---|
| 保存一次位置和消息 | errors.Add(pos, msg) | 追加一个 *scanner.Error |
| 保持源码顺序 | errors.Sort() | 按位置排序,不删除条目 |
| 每行只留第一条 | errors.RemoveMultiples() | 排序并按行压缩 |
| 作为函数错误返回 | errors.Err() | 空列表为 nil |
常见问题
为什么要用 ErrorList,而不是只返回最后一个 error?
因为扫描器的错误处理器可能被调用多次。单个变量会覆盖前一处位置,ErrorList 则能保留每条诊断的行列信息,便于一次展示给用户。
调用 Add 后需要手动分配 Error 吗?
不需要。Add 会创建带有 Pos 和 Msg 的错误条目并追加到列表;直接准备一个零值 ErrorList 即可。
什么时候不该调用 RemoveMultiples?
当编辑器或接口消费者需要同一行不同列的完整诊断时不要调用。它适合摘要展示,不适合保留所有细粒度定位。
因此,保留多个源码位置的最小方案就是:把 ErrorHandler 的每次回调交给同一个 ErrorList.Add,扫描完成后按展示需求排序或按行压缩,最后用 Err 交回上层。这样既不会丢失早期位置,也不会把扫描器继续产出 token 误认为扫描成功。
-
278 收藏
-
483 收藏
-
291 收藏
-
195 收藏
-
412 收藏
-
265 收藏
-
257 收藏
-
173 收藏
-
449 收藏
-
301 收藏
-
Golang · Go教程 | 1天前 | 标准库 · 错误处理 · Go教程 · net/http · Go Response.Body Request.Body io.ReadCloser http.ErrBodyReadAfterClose465 收藏
-
371 收藏
-
314 收藏
-
127 收藏
-
490 收藏
-
409 收藏
-
176 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习