Go go/scanner.ErrorList.Sort 怎样按源码位置整理扫描诊断
来源:17golang原创
时间:2026-11-18 18:18:50 321浏览 收藏
扫描器把错误交给回调后,诊断顺序通常取决于错误被发现和追加的时机,不一定符合读者从文件第一行往下看的习惯。需要在输出前整理时,直接调用 scanner.ErrorList.Sort() 即可:它会原地重排当前列表,按文件名、行号、列号比较位置,同一位置再按错误消息比较。
官方文档:https://pkg.go.dev/go/scanner#ErrorList.Sort
Sort()没有返回值,也不会创建第二个错误列表。调用完成后继续使用原来的ErrorList即可;它只负责排序,不负责删除重复诊断。
先还原“错误顺序不对”的现场
在扫描源码时,错误通常通过 ErrorHandler 逐条追加到 ErrorList。如果扫描器先遇到一个会影响后续判断的异常,或者不同文件的扫描任务交错执行,追加顺序就可能偏离源码位置顺序。直接打印列表,读者看到的可能是后面的行先出现。
ErrorList 的底层类型是 []*scanner.Error,每个元素包含 token.Position 和消息文本。它的零值可以直接使用,因此适合先收集、后整理。

Sort 到底按什么顺序比较
官方实现不是简单比较 token.Position.Offset。它依次比较 Filename、Line、Column,这三个字段都相等时再比较 Msg。这样做是为了让跨文件诊断和同一位置的多条消息都有确定顺序。
特别要注意源码中的 //line 指令可能改变行信息。官方实现明确指出,单独比较字节偏移并不能完整反映修改后的行信息,所以不要自己用 Offset 替代 Sort() 的比较逻辑。

收集结束后调用 Sort
最小用法是先准备 token.FileSet 和 scanner.Scanner,让错误回调把位置和消息追加到列表,扫描结束后调用 errors.Sort(),最后按整理后的顺序输出。
package main
import (
"fmt"
"go/scanner"
"go/token"
)
func main() {
// src 是待扫描的源码;这里故意放入一个不完整的表达式来产生诊断。
src := []byte("package demo\nfunc main( {\n")
fset := token.NewFileSet()
file := fset.AddFile("demo.go", fset.Base(), len(src))
var errors scanner.ErrorList
var s scanner.Scanner
// 回调只负责收集位置和消息,不在收集阶段假定顺序已经正确。
s.Init(file, src, func(pos token.Position, msg string) {
errors.Add(pos, msg)
}, 0)
for {
_, tok, _ := s.Scan()
if tok == token.EOF {
break
}
}
// Sort 原地整理底层切片,调用后仍然使用 errors 读取结果。
errors.Sort()
for _, item := range errors {
fmt.Println(item)
}
}
这里的关键不是让 Scan() 返回某种特定错误,而是把“收集”和“展示”分开。回调里只记录事实,所有错误收集完成后再统一排序,输出层就不会依赖扫描过程中偶然的发现顺序。
为什么 Sort 没有返回值
调用形式是 errors.Sort(),而不是 sorted := errors.Sort()。原因在于 ErrorList 实现了 sort.Interface 所需的 Len、Less 和 Swap,Sort() 内部直接对这份切片排序。
方法虽然是值接收者,但复制的只是切片头,底层数组仍然是同一块数据。因此排序后,原变量中的元素顺序已经改变;同时它不会改变列表长度,也不会替调用方重新赋值。
// 这个辅助函数只负责把诊断排序后输出,不需要返回新的 ErrorList。
func printDiagnostics(errors scanner.ErrorList) {
// 空列表调用 Sort 也是安全的,结果仍然是空列表。
errors.Sort()
for _, item := range errors {
fmt.Printf("%s: %s\n", item.Pos, item.Msg)
}
}
Sort 不负责去重或筛选
排序只改变元素的先后位置,不会判断两条消息是不是重复,也不会按行保留一条。如果同一行存在多个诊断,排序后它们仍然都在,只是会按照位置和消息顺序排列。
如果业务目标是“每行只保留第一条错误”,那是另一个明确的处理动作。go/scanner 还提供了 ErrorList.RemoveMultiples(),它会先排序再按行移除后续错误;不要因为文章需要稳定输出,就在自己的排序函数里顺手删数据。
几个容易误判的边界
| 问题 | 正确理解 |
|---|---|
| Sort 会返回排好序的新列表吗? | 不会。方法无返回值,直接重排原列表的底层数组。 |
| 只比较 Offset 可以吗? | 不建议。官方比较顺序包含文件名、行号、列号和消息,行信息被调整时 Offset 不能代表完整显示位置。 |
| Sort 会删除重复错误吗? | 不会。它只排序;去重或按行合并需要单独的业务规则。 |
| 应该在回调里每追加一次就 Sort 吗? | 通常不需要。先收集完,再统一排序,逻辑更清楚,排序次数也更少。 |
把它放进诊断输出边界
一个可复用的判断方式是:错误回调只负责把 Position 和消息交给列表;扫描结束后,准备输出、日志记录或返回上层之前调用一次 Sort();如果还要去重,再明确调用独立的处理函数。这样既保留了收集阶段的原始信息,也让最终展示顺序稳定。
如果程序只处理单条错误,或者调用方本身已经保证顺序,那么不必为了形式调用排序。只有当列表包含多个诊断、且读者需要按源码位置阅读时,ErrorList.Sort() 才真正解决问题。
常见问题
Sort 排序后需要重新赋值吗?
不需要。直接调用 errors.Sort() 即可;排序结果已经体现在 errors 的元素顺序中。
为什么同一行的两条错误顺序还会变化?
同一文件、行号和列号都相同时,官方实现会继续比较 Msg。因此消息文本不同,最终顺序仍然可以确定。
能用标准库 sort.Slice 自己排吗?
可以写出自定义比较器,但除非确实需要不同的业务排序,否则优先使用 ErrorList.Sort()。它已经表达了 go/scanner 对源码位置和消息的默认排序规则,也避免遗漏文件名或行信息的边界。
小结
Go go/scanner.ErrorList.Sort 解决的是“扫描诊断收集顺序不适合阅读”的问题。它在错误收集完成后原地排序,比较键依次是文件名、行号、列号和消息,不返回新列表,也不承担去重职责。把调用放在诊断输出前,并把筛选、去重等动作另行表达,就能得到稳定且不丢信息的错误展示。
-
369 收藏
-
344 收藏
-
278 收藏
-
464 收藏
-
327 收藏
-
136 收藏
-
400 收藏
-
473 收藏
-
126 收藏
-
213 收藏
-
409 收藏
-
376 收藏
-
121 收藏
-
441 收藏
-
248 收藏
-
319 收藏
-
351 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习