登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

Go token.File.Name 怎样取回注册时的源码文件名

来源:17golang原创

时间:2026-11-19 07:08:31 182浏览 收藏

在 go/ast、源码格式化器或静态分析工具里,拿到一个 token.File 后通常还要把它显示成“哪个源文件”。最直接的做法是调用 file.Name():它返回注册这个文件时传给 FileSet.AddFile 的 filename,不会根据 token.Pos 重新推导路径,也不会替你清理路径。

要点速览
  • token.File.Name() 只读取文件对象保存的注册名,返回值类型是 string。
  • FileSet.File(pos) 负责从位置找到文件;找到以后再调用 Name()。
  • 空字符串、重复文件名和相对路径都可以是调用方登记的数据,不能当作 Name 自动修复失败。

token.File.Name 取回的是注册元数据

token.File 由 FileSet.AddFile(filename, base, size) 创建。Name() 的职责很窄:把 filename 原样作为文件标识返回。它不是文件系统查询,也不验证文件是否存在;传入 internal/parser/input.go,读到的就是这个字符串。

因此,源码分析工具应在登记文件时就决定好展示名。如果需要绝对路径、统一斜杠或脱敏,应在进入 AddFile 前由调用方完成,而不是期待 Name() 负责路径规范化。

Go token.File.Name 说明图:FileSet.AddFile 保存 filename,File.Name 返回源码文件标识且不查询磁盘
图1:token.File.Name 的元数据结构说明图,不是截图或运行证据。

最小读取方式:File 对象直接调用 Name

下面的例子只构造一个文件位置对象,重点是观察数据流:AddFile 保存文件名,Name 再把它取出;第二次调用则展示从位置反查文件后再读取名称的写法。

package main

import (
    "fmt"
    "go/token"
)

func main() {
    fset := token.NewFileSet()
    // filename 是分析工具希望展示的源码标识,base=-1 表示使用下一个可用基址。
    file := fset.AddFile("internal/parser/input.go", -1, 24)

    // Name 只返回登记时的文件名,不读取磁盘,也不改变路径。
    fmt.Println(file.Name())

    // 先用文件内偏移构造 Pos,再从 FileSet 找回所属文件。
    pos := file.Pos(3)
    found := fset.File(pos)
    if found == nil {
        // Pos 不属于当前 FileSet 时,避免对 nil 调用 Name。
        fmt.Println("file not found")
        return
    }
    fmt.Println(found.Name())
}

这里的两次输出会使用同一个登记名。示例没有打开 input.go,所以它表达的是 token 位置表中的元数据关系,不是一次磁盘读取成功的证明。

File.Name、FileSet.File、PositionFor 不要混用

这三个 API 经常连续出现,但解决的是三个不同问题。先把 token.Pos 映射回 *token.File,再读取名称;如果还要展示行列位置,才继续调用 PositionFor。

API输入结果适合场景
File.Name()无注册文件名显示文件标识
FileSet.File(pos)token.Pos*token.File 或 nil从位置反查所属文件
FileSet.PositionFor(pos, adjusted)token.Pos 与调整开关行、列、文件名等 Position生成诊断位置

如果手里只有 Pos,直接调用 Name() 没有对象可用;如果只想显示登记名,也不必为了这个目的先做行列换算。把查询链拆开,排查“文件名显示不对”时会更快。

Go token 位置 API 边界图:token.Pos 反查 File、读取 Name 与转换 Position 的职责区别
图2:三个 token 位置 API 的职责边界结构图,不是截图或运行证据。

空文件名、重复名和路径字符串的边界

AddFile 接收的文件名是调用方提供的字符串。空字符串会让 Name() 返回空字符串;相对路径不会自动变成绝对路径;多个 token.File 也可以登记相同文件名。工具若要求名称非空或唯一,应在登记阶段增加自己的约束,并把文件对象或位置区间作为内部唯一标识。

另一个常见误区是把 FileSet.File(pos) 返回 nil 当成文件名为空。前者表示这个位置不在当前集合的任何文件区间,后者表示找到了文件但登记名本身为空,处理逻辑应分开。

相关问题

File.Name 会检查文件是否存在吗?

不会。它只返回登记时保存的字符串,与磁盘上是否存在同名文件无关。

怎样从 token.Pos 取得文件名?

先调用 fset.File(pos) 得到 *token.File,确认结果非 nil 后再调用 file.Name()。

需要行号时还要调用 Name 吗?

可以直接使用 fset.PositionFor(pos, true) 得到位置结构;若要单独读取文件标识,仍可使用所属 File 的 Name()。

把 Name() 当作“登记名读取器”,把 FileSet.File 当作“位置反查器”,把 PositionFor 当作“诊断位置转换器”,这三个边界清楚后,源码工具中的文件名显示问题通常不需要修改 token 偏移计算。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>