跳到内容

Barcode Scanner Emulator

条码扫描器前缀与后缀:完整指南

前缀是条码扫描器在已解码条码之前发送的数据或控制序列。后缀是它在该值之后发送的内容。同一型号可以设置不同的前缀和后缀,串口扫描器的送达方式也与键盘楔入扫描器不同。

条码扫描器的前缀发在解码值之前,后缀发在该值之后。一台扫描器可能给出这样的序列:

前缀:STX

条码:123456789

后缀:ENTER

手册里的 STX 通常指控制字符,而不是 S、T、X 这三个字母。键盘楔入扫描器上的 ENTER 通常是 Enter 键,不是插入文本框的 CR 和 LF 两个字符。实际收到哪一种,取决于型号、接口和应用程序。没有哪一项设置适用于所有情况。

条码扫描器中的 ENTER 与 TAB 后缀仍只讨论如何选择并排查这两个结束符。本指南讲的是条码四周的框架:前面来什么、后面来什么,以及 Web 应用应当如何读取两者。

什么是条码扫描器前缀?

前缀是扫描器在载荷之前发出的一段已配置序列。载荷是码制解出的文本,例如 123456789。除非扫描器被设成要加上它,前缀不属于这次解码。

常见用途:

  • 标出一条消息的起点。 串口和终端协议有时会发送一个控制字符,常称为 STX,让主机知道新的一帧已经开始。
  • 标明码制。 打开 AIM 码制标识后,扫描器可以在数字前发送一段短的可打印前缀,例如 Code 128 的 ]C1 或 EAN 的 ]E0。应用程序可以按这个标识分支。
  • 在较旧的 POS 或终端软件里分流输入。 数据前面的固定代码告诉主机,这次扫描属于哪个字段或哪台设备。
  • 标记某个工位。 两台扫描器可以配置不同的可打印前缀,日志就能看出是哪条通道发出了代码。

可打印前缀就是普通字符。它们出现在文本框里字符串的最前面。STX(0x02)这类控制字符前缀不是字母 S、T 和 X。键盘楔入扫描器可能根本打不出这个控制字符。串口扫描器可以把它当成一个字节发出。在编写只期待其中一种的代码之前,先读你这台型号的手册。

前缀不能证明输入来自扫描器。人、宏,或 Barcode Scanner Emulator 都能打出同样的字符。把前缀当作你配置的框架,再像验证其他用户输入那样验证载荷。

什么是条码扫描器后缀?

后缀是配置成在载荷之后发送的序列。它通常用来告诉应用程序扫描已经结束,或者用来移动焦点。扫描器各不相同。有的提供 Enter、Tab、CR、LF、CR+LF、自定义字符串或什么都不发。有的只提供其中一两项。

ENTER。 Enter 键。在浏览器里这是键盘事件,event.key === "Enter"。它不会写进普通文本框。

TAB。 Tab 键,event.key === "Tab"。浏览器把焦点移到下一个控件。这个键不会写进字段。

CR。 回车,ASCII 0x0D。在串口或终端接口上,它可以是载荷后面的真实字节。在键盘楔入上,标成 CR 或回车的设置通常表示 Enter 键。浏览器仍然报告 Enter。字段值里不会多出一个 CR 字符。

LF。 换行,ASCII 0x0A。它是和 CR 不同的控制字符。在串口流里它可以是自己的一个字节。键盘楔入没有像 Enter 和 Tab 那样的标准换行键。不要以为名为 LF 的菜单项会打出一个可见字符,或再打一次 Enter。

CRLF。 先 CR 后 LF,两个字节 0x0D 0x0A。有些串口和终端主机把这一对当作一行的结尾。有人按下 Enter 时,浏览器文本框不会存下这一对。

自定义字符。 # 或一小段代码这类可打印后缀会打在条码后面,所以除非应用程序把它去掉,它会成为字符串的一部分。自定义控制字符和 STX 的分界相同:串口上是字节,楔入上是按键,而且只有键盘接口实际发得出的按键。

ENTER、CR 和 LF 在手册里都是“行尾”的近义名称。它们并不能在每个应用程序里互换。楔入扫描器、串口扫描器、记事本和网页表单,对同名设置可以各自给出不同结果。

前缀与后缀

特性 前缀 后缀
位置 在条码数据之前 在条码数据之后
用途 标出开始,或给输入加标签 标出完成,或触发一个动作
示例 STX,或 ]C1 这类可打印的 AIM 标识 ENTER、TAB,或 # 这类可打印字符
常见用法 给扫描加框或辨认扫描 提交表单或移动焦点
在文本框中 可打印字符位于值的开头 可打印字符位于值的末尾。Enter 和 Tab 不会
身份 谁都可以打出的已配置标记 谁都可以打出的已配置标记

只有在你配置了那一段确切序列,并且保存的记录不该包含它时,才去掉前缀或自定义后缀。在应用程序有规则之前,把 AIM 标识留在原处。

ENTER、TAB、CR 和 LF

这些名称出现在配置表上。接收端看到的是按键还是字节,取决于接口。HID keyboard wedge 说明描述按键这条路径。串口是另一条路径:应用程序读取字节,焦点并不决定它们去哪里。

ENTER

在键盘楔入扫描器上,ENTER 就是 Enter 键。在单行文本框里,当前浏览器用这个键提交所在表单。查询框可以在这个事件上确认扫描。多字段表单可能在后面的字段填完之前就提交。页面应当留下这个值并停在原地时,在 submit 事件上,或在 Enter 的 keydown 上调用 preventDefault()。Enter 只在一处处理。一个 keydown 监听器和一个 submit 监听器都接受这次扫描时,会记两次。

有些扫描器发送小键盘 Enter。event.key 仍然是 "Enter"。event.code 可能是 "NumpadEnter",而不是 "Enter"。两个键都应当确认字段时,检查 event.key。

条码扫描器中的 ENTER 与 TAB 后缀比较这两种选择在 POS 和网页表单上的差别。条码扫描器缺少 ENTER说明扫描器打出条码之后就停下的情况。

TAB

TAB 是 Tab 键。浏览器在 keydown 之后移动焦点。在这个 keydown 处理函数里、字段仍有焦点时读取字段;下一个控件应当接到光标时,保留默认动作。preventDefault() 会把焦点留在当前字段。

Shift+Tab 是按住 Shift 的同一个键。扫描器的 Tab 后缀是不带 Shift 的 Tab。如果键盘用户必须能在表单里向后移动,就忽略 event.shiftKey。

CR

回车在终端里把光标移到行首。字节是 0x0D。串口扫描器可以把这个字节加在载荷后面。名为 CR 的键盘楔入设置通常发送 Enter 键,而不是把 0x0D 插进文本。在浏览器输入框里按 Enter,不会把 CR 字符写进 input.value。

主机如果是终端或 COM 口监听程序,就查找这个字节。主机如果是网页,就查找 event.key === "Enter"。

LF

换行在终端里把光标下移一行。字节是 0x0A。有的主机把单独的 LF 当作换行。有的主机只有在 CR 先到时才理会它。把 LF 列为后缀的楔入扫描器,可能发送一个操作系统不会变成换行的键,也可能发送文本框不会保留的内容。在应用程序代码里处理所谓的 LF 之前,先用键盘事件测试器把这个键捕获下来。

CRLF

CRLF 是先 CR 后 LF 的两个控制字符。Windows 风格的文本文件和许多串口设备把它当作一次换行。配置页上写着“CRLF 后缀”,意思是扫描器会在它正在使用的接口上,尝试在载荷之后发送这一对。

在浏览器里,按 Enter 不会在文本框内部产生字面的 CRLF 序列。表单收到的是键盘事件。<textarea> 可能在用户按 Enter 时插入换行,那个换行是浏览器自己的编辑行为,不能证明扫描器发出了字节 0x0D 0x0A。串口读取程序可以收到这两个字节,并且只有在该扫描器被配置为发送它们时,才应当把它们当作结束符。不要从允许包含它们的载荷中间剥掉 CR 或 LF。

前缀和后缀如何影响 Web 应用

一次键盘楔入扫描,是打进当前有焦点控件的一串按键。页面并不打开扫描器。焦点若在另一个字段,前缀、条码和后缀都会进到那里。

keydown 对每一个键触发,包括 Enter 和 Tab,并且发生在浏览器插入字符或移动焦点之前。event.key 是操作系统应用键盘布局之后的字符或键名。可打印的前缀和后缀字符通过 input 事件出现在字段里。Enter 和 Tab 不会。

下面的监听器在 Enter 到达时确认字段。它不会补上扫描器没发的后缀。如果扫描器不发 Enter,值就留在字段里,直到别的东西来读它。

const field = document.querySelector('#barcode')

if (!(field instanceof HTMLInputElement)) {
  throw new Error('Barcode field was not found.')
}

field.addEventListener('keydown', (event) => {
  if (event.key !== 'Enter') {
    return
  }

  event.preventDefault()
  const value = field.value.trim()
  if (!value) {
    return
  }

  console.log(value)
  field.value = ''
})

扫描前先聚焦 #barcode。preventDefault() 阻止外层表单再提交一次。输入不在表单里、并且你想要浏览器原生提交时,去掉 preventDefault()。

没有后缀时,等待一个明确动作:按钮、操作员稍后按下的 Enter,或流程里的下一步。空闲计时器可以把一次停顿当成扫描结束。这个计时器是启发式判断。慢的扫描器、Bluetooth 延迟或打字很快的人,都可能落在错误的一侧。流程需要确定的结尾时,优先使用已配置的后缀。

读到值之后,可以去掉已知的可打印前缀:

function withoutConfiguredPrefix(value, prefix) {
  if (prefix && value.startsWith(prefix)) {
    return value.slice(prefix.length)
  }
  return value
}

只传入你配置的那个前缀,例如 ']C1'。不要从每一次扫描里剥掉任意个数的字符。

还要处理 Tab、空输入和第二次扫描的完整表单,见如何在 Web 应用中测试条码扫描器。

如何配置前缀和后缀

前缀和后缀的设置在扫描器上。按键名称和改法因厂商而异。没有一条配置条码能用于所有品牌,本指南也不印出这样一条。

常见做法:

  • 扫描该确切型号手册里的配置条码。配置页按设置分组:后缀、前缀、键盘布局、码制。
  • 使用厂商的配置程序,再通过 USB 把结果写入扫描器。
  • 一次更新很多台时,使用该产品线的设备管理工具。

改完之后,扫描一个已知条码,把结果和手册对你所选设置的说明对照。用另一个品牌的恢复出厂设置,可能让扫描器毫无变化,也可能把它放进意外模式。条码扫描器配置指南概括通常要紧的设置。它不能代替手册。

Barcode Scanner Emulator 可以打入你选择的值,然后发送 ENTER、TAB,或不发送后缀。需要在没有硬件时演练前缀处理,就把可打印前缀放进那个值。模拟器不发出串口 CR/LF 字节对,也不读取标签。

如何测试前缀和后缀行为

使用处于键盘模式的扫描器,即 USB HID 键盘或 Bluetooth HID 键盘。

  1. 接上它,等到它显示出已经通电。
  2. 打开条码输入测试器。
  3. 点击开始测试,或点击扫描区域。就绪时它会变成蓝色。页面不会自己取得焦点。
  4. 扫描一个你已经知道载荷的条码。
  5. 读取捕获到的值和字符数。可打印的前缀或后缀字符就在这个字符串里面。前缀这一行用于第一个字符之前到达的命名键,例如修饰键。它不会把 ]C1 这种打进去的前缀从条码文本里抽出来。
  6. 查看后缀。测试器报告 ENTER、TAB 或无。自动捕获打开时,结果会在 Enter、Tab,或按键停止后的短暂停顿之后出现。关掉自动捕获,就会一直保持这次捕获,直到你按停止。Enter 和 Tab 不属于条码字符串。
  7. 把这个结果和你打算使用的配置比较。需要按顺序看到每一次 keydown,包括 key、code 和时间时,再打开键盘事件测试器扫描一次。

输入测试器记录浏览器能看见的键盘事件。它读不了串口,所以不能把 CR 或 LF 显示成原始字节。楔入测试不能证明串口设置会发出什么。

排查

扫描器不发送 ENTER。 条码出现了,光标仍留在字段里。输入测试器报告无。后缀被关掉了,或者设成了 Enter 以外的东西。参见条码扫描器缺少 ENTER。

TAB 意外移动了焦点。 扫描器正在发送 Tab 键。这就是已配置的后缀。表单应当提交时用 Enter;流程应当前进时,在 Tab 的 keydown 上读取值。细节见条码扫描器中的 ENTER 与 TAB 后缀。

表单提交了两次。 浏览器在 Enter 上提交,同时一个 keydown 监听器也接受了这次扫描。只保留一条完成路径,并在另一条上调用 preventDefault()。

前缀出现在条码里面。 可打印前缀是捕获字符串的一部分。要么在扫描器上关掉它,要么在应用程序里去掉这一段确切序列。打开的码制标识常常是开头一个 ] 再加两个字符的来源。楔入打不出来的控制前缀会缺失,而不是显示出来。

字符不对。 扫描器布局和操作系统布局可能不一致,前缀字符和标点会变,长度却不变。参见条码扫描器键盘布局错误。

应用程序始终看不到扫描结束。 没有后缀,页面却在等 Enter。加上与表单匹配的后缀,或在一个明确动作上完成这个值。靠时间猜测会漏掉一些真实扫描,也会收下一些打字。

CR/LF 在不同应用程序里不一样。 记事本收到 Enter 时插入新行。网页文本框保留条码并触发按键事件。串口程序可能收到 0x0D、0x0A,或两者都收到。改扫描器之前先比较接口。如果没有任何应用程序收到字符,从条码扫描器不工作开始。

对焦点、重复扫描和 POS 流程的更宽检查,见如何测试条码扫描器输入。

测试矩阵

配置这一列是你在扫描器上设置的内容;当用例是键盘后缀时,也可以是你用模拟器打出的内容。预期行为是应用程序应当做的事。串口 CRLF 用例和浏览器里的 Enter 键不是同一次测试。

配置 应用程序的预期行为
无前缀,无后缀 收到条码值,没有完成键到达。在应用程序读取之前,值一直留着。
无前缀,ENTER 后缀 应用程序收到一次完成键,保存载荷时不含结束字符。
无前缀,TAB 后缀 焦点可能移到下一个控件。应用程序在移动之前读取值。
自定义可打印前缀 前缀字符出现在解码数据之前。应用程序有意地保留或去掉这一段确切前缀。
自定义可打印后缀 后缀字符出现在解码数据之后。Enter 和 Tab 是键,所以不会出现在字符串里。
CRLF 序列 串口或终端主机处理已配置的 CR 和 LF 字节。浏览器文本框不会从一次 Enter 按键得到这些字节。

键盘那几行在楔入扫描器上跑;没有硬件时,用模拟器的 ENTER、TAB 和无后缀设置。CRLF 那一行在应当承载这些字节的接口上跑。实际结果仍然取决于那个接口和应用程序。