当前位置:首页 > 文章列表 > Golang > Go问答 > Go text/scanner.Scanner.TokenText 怎样保留当前记号的原始文本

Go text/scanner.Scanner.TokenText 怎样保留当前记号的原始文本

来源:17golang原创 2026-11-18 15:12:46 0浏览 收藏

在用 Go 的 text/scanner 做轻量词法扫描时,一个很常见的症状是:日志里明明看到了某个记号,等把结果放进后续处理流程,原文却没有被正确保留下来。处理方式很直接:每次 Scan() 返回后,立刻调用 TokenText(),并把返回的字符串复制到自己的记录中。不要等下一轮扫描,也不要把 Scanner 当成记号文本的存储容器。

TokenText 返回最近一次 Scan() 扫到的记号对应文本;它的有效时机是扫描之后或 Scanner.Error 回调中。想长期保留原始拼写,就在当前扫描轮次马上保存返回值,同时保存记号类型和起始位置。

官方地址:https://pkg.go.dev/text/scanner#Scanner.TokenText

先把 Scan 和 TokenText 绑定在同一轮

Scan() 返回的是记号类型或单个 Unicode 字符,TokenText() 返回的是最近一次扫描所得的文本。两者要成对读取:先拿到 tok,马上复制 text,再进入下一轮。

package main

import (
    "fmt"
    "strings"
    "text/scanner"
)

func main() {
    const source = `sum := total + 42`

    var s scanner.Scanner
    s.Init(strings.NewReader(source))
    s.Filename = "config.expr"

    for tok := s.Scan(); tok != scanner.EOF; tok = s.Scan() {
        // 在下一次 Scan 之前保存当前记号的源码文本和起始位置。
        text := s.TokenText()
        position := s.Position

        // TokenString 只负责把记号类型变成可读名称,不能替代原始文本。
        fmt.Printf("%s token=%s text=%q\n", position, scanner.TokenString(tok), text)
    }
}

这里的 text 是一个独立的字符串值,适合写入日志、语法树节点或自定义切片。TokenString(tok) 只是把 scanner.Ident、scanner.Int 等类型编号变成可读名称;对于 + 这类单字符记号,Scan() 返回字符本身,TokenText() 才能提供对应的源码片段。

Go Scanner 当前记号类型、原始文本和起始位置之间的静态关系图
图1:静态说明图展示 Scan 返回的记号类型、TokenText 原始文本和 Position 起始位置的对应关系,不是截图或运行证据。

为什么必须在下一次 Scan 前保存

Scanner 表示的是“当前扫描状态”,不是一个会自动累积历史记号的集合。继续调用 Scan() 后,当前记号已经改变;如果业务还需要上一段文本,就应该在自己的结构中保存,而不是回头再次向扫描器索取旧值。

type TokenRecord struct {
    Kind  rune
    Text  string
    Start scanner.Position
}

func collect(source string) []TokenRecord {
    var s scanner.Scanner
    s.Init(strings.NewReader(source))

    records := make([]TokenRecord, 0, 8)
    for tok := s.Scan(); tok != scanner.EOF; tok = s.Scan() {
        // 这一轮先复制文本,再让循环进入下一次 Scan。
        records = append(records, TokenRecord{
            Kind:  tok,
            Text:  s.TokenText(),
            Start: s.Position,
        })
    }
    return records
}

这样后续阶段只依赖 TokenRecord,即使扫描器继续向前移动,已经收集的文本也不会因为当前状态改变而丢失。对需要重放、诊断或生成错误片段的解析器来说,Kind、Text 和 Start 应该视为一个整体。

字符串、注释和单字符记号都按源码拼写保存

默认的 Mode 是 GoTokens,会识别 Go 风格的标识符、数字、字符、字符串、原始字符串和注释,并默认跳过注释。TokenText() 的价值就在于保留当前记号对应的文本,而不是把它转换成已经解释过的值。

var s scanner.Scanner
s.Init(strings.NewReader("name == \"A\\nB\""))

for tok := s.Scan(); tok != scanner.EOF; tok = s.Scan() {
    // 保留引号、转义符和运算符的源码外形,后续再决定是否解码。
    raw := s.TokenText()
    switch tok {
    case scanner.String, scanner.RawString:
        fmt.Printf("literal=%q raw=%q\n", raw, raw)
    default:
        fmt.Printf("kind=%s raw=%q\n", scanner.TokenString(tok), raw)
    }
}

如果业务要得到字符串的实际值,应在保存原文之后另行解析;不要用解析后的值反推源码。比如双引号、反斜杠和换行转义都属于原始文本的一部分,而 TokenText() 的职责只是返回最近扫描记号对应的字符串。

错误回调里可以读取当前记号文本

官方文档明确把 TokenText() 的有效场景扩展到了 Scanner.Error 回调。遇到词法错误时,可以把位置、错误消息和当前文本一起记录,帮助定位哪个源码片段触发了问题。

var s scanner.Scanner
s.Init(strings.NewReader("value = \"unterminated"))
s.Error = func(sc *scanner.Scanner, message string) {
    // 错误回调中读取当前上下文,避免只记录一条没有位置的消息。
    fmt.Printf("%s: %s, text=%q\n", sc.Position, message, sc.TokenText())
}

for tok := s.Scan(); tok != scanner.EOF; tok = s.Scan() {
    // 错误由 Scanner.Error 处理;正常记号仍按同样规则保存。
    _ = s.TokenText()
}

错误回调里的 Position 可能需要结合 Pos() 理解:Position 是最近一次扫描记号的起始位置,而 Pos() 返回上一次 Scan() 或 Next() 之后的位置。两者不要混成“当前文本的结束位置”。

Go Scanner 当前状态与自有 TokenRecord 保存对象之间的静态边界图
图2:静态说明图展示 Scanner 的当前状态、Error 回调和自有 TokenRecord 的边界关系,强调保存后不再依赖扫描器状态,不是截图或运行证据。

四个容易误用的状态边界

场景应怎样处理原因
刚完成 Scan()立即读取并保存 TokenText()这是文档保证的正常读取时机
下一轮 Scan() 已开始使用之前保存的字符串扫描器已经进入新的当前记号
调用 Next()不要把它当成记号扫描接口Next() 读取单个 Unicode 字符,不更新记号语义
到达 EOF 或刚 Init()按无当前记号处理此时没有可供业务保存的最近记号

尤其不要写成“先连续扫描,最后再调用一次 TokenText()”。那样只能得到最后一个有效记号附近的状态,无法还原此前的记号序列。若需要所有文本,应该在扫描循环中逐条建立记录。

把处理方式固化成排查清单

  1. 确认循环每次都先调用 Scan(),再调用 TokenText()。
  2. 确认返回值已经复制到业务结构,而不是只保存 Scanner 指针。
  3. 确认是否需要保留引号、转义符、注释或单字符运算符的源码外形。
  4. 确认日志同时记录 Position 和记号类型,避免只看文本猜测上下文。
  5. 确认错误回调中只读取当前有效上下文,并把错误记录和扫描结果分开。

一句话总结:TokenText() 适合“当前记号刚被扫描出来时取原文”,不适合替代历史存储。把它和 Scan() 放在同一轮,把文本、类型、位置一起保存,后续解析和排错就不会被扫描器的移动状态牵着走。

相关问题

TokenText 会把字符串字面量自动解码吗?

不会。它返回最近扫描记号对应的文本;如果业务需要实际字符串值,应在保存源码文本之后单独执行解码或语义解析。

TokenText 和 TokenString 有什么区别?

TokenText() 面向源码文本,TokenString(tok) 面向记号类型的可读名称。一个回答“源码里是什么”,另一个回答“扫描器把它归为什么类型”。

怎样保留所有扫描结果?

在每次 Scan() 返回后把 tok、TokenText() 和 Position 写入自定义切片或语法树节点,不要等循环结束后再回读扫描器。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
PHP IntlCalendar.getFirstDayOfWeek 怎样读取日历采用的一周起始日PHP IntlCalendar.getFirstDayOfWeek 怎样读取日历采用的一周起始日
上一篇
PHP IntlCalendar.getFirstDayOfWeek 怎样读取日历采用的一周起始日
Java FileStore.getBlockSize 怎样查询文件系统块大小
下一篇
Java FileStore.getBlockSize 怎样查询文件系统块大小
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    1095次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    1092次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    1256次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    1197次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    1046次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码