Go x/text/secure/bidirule Direction 怎样区分文本方向

如果你要判断一个标签整体是从左到右、从右到左，还是同时包含两种方向，Go 的 golang.org/x/text/secure/bidirule 可以直接给出方向结果。string 输入使用 DirectionString，[]byte 输入使用 Direction；两个函数都返回 golang.org/x/text/unicode/bidi 包里的 Direction，结果不能只简单地压缩成“左”或“右”。

官方地址：https://pkg.go.dev/golang.org/x/text/secure/bidirule

最小选择规则是：字符串用 DirectionString(s)，字节切片用 Direction(b)；拿到返回值后分别处理 LeftToRight、RightToLeft、Mixed 和 Neutral。如果还要判断标签是否符合 Bidi Rule，再调用 ValidString 或 Valid，不要把方向结果当作合法性结论。

一、先确定你要读取的是方向还是合法性

bidirule 同时提供方向读取和规则校验接口，名字相近但结果不同：

方向回答“文本整体往哪边流动”，合法性回答“这个标签是否符合规则”。例如，业务界面可能只需要根据方向选择布局；域名标签或标识符入口则可能还要先做规则校验。先拆开两个问题，后面的分支会更清楚。

二、Direction 的四种结果分别表示什么

bidi.Direction 不是一个只有两个值的布尔开关。官方类型定义包含四种整体方向：

• LeftToRight：没有从右到左字符，并且有从左到右字符，或者应用了左到右默认方向。
• RightToLeft：没有从左到右字符，并且有从右到左字符，或者应用了右到左默认方向。
• Mixed：文本同时包含从左到右和从右到左字符。
• Neutral：没有这两类方向字符，也没有默认方向。

这意味着“不是 LeftToRight”并不等于“就是 RightToLeft”。包含两种方向的标识应保留为 Mixed，只包含中性字符的输入则可能是 Neutral。

三、string 和 []byte 两种入口怎么选

如果上游数据本来就是 Go 字符串，优先使用 DirectionString，这样调用处不需要额外转换。文件、协议或已经完成编码处理的数据如果以字节切片存在，则使用 Direction。两者表达的是同一类方向判断，主要差异在输入形态。

package main

import (
	"fmt"

	"golang.org/x/text/secure/bidirule"
	"golang.org/x/text/unicode/bidi"
)

// directionName 把库的枚举结果转换成业务层容易展示的名称。
func directionName(d bidi.Direction) string {
	switch d {
	case bidi.LeftToRight:
		return "LeftToRight"
	case bidi.RightToLeft:
		return "RightToLeft"
	case bidi.Mixed:
		return "Mixed"
	case bidi.Neutral:
		return "Neutral"
	default:
		// 保留未知值，避免未来扩展时静默误判成右到左。
		return "Unknown"
	}
}

func main() {
	text := "service.example"
	bytes := []byte("service.example")

	// string 直接走 DirectionString，字节切片走 Direction。
	fromString := bidirule.DirectionString(text)
	fromBytes := bidirule.Direction(bytes)

	fmt.Println("string:", directionName(fromString))
	fmt.Println("bytes:", directionName(fromBytes))
}

示例中的两个调用都只读取方向。它们不会替你完成业务策略，例如是否允许混合方向、是否需要拒绝中性标签、是否还要做长度和字符集检查，这些仍应由调用方明确决定。

四、用 switch 保留 Mixed 和 Neutral

实际项目中，最好在靠近输入边界的位置把枚举映射成业务结果。不要写成 if d == bidi.LeftToRight { ... } else { ... }，因为那会把 Mixed 和 Neutral 合并到同一条路径。

package direction

import (
	"errors"

	"golang.org/x/text/secure/bidirule"
	"golang.org/x/text/unicode/bidi"
)

var errUnsupportedDirection = errors.New("unsupported text direction")

// LayoutDirection 给布局层返回有限且明确的方向策略。
func LayoutDirection(label string) (string, error) {
	d := bidirule.DirectionString(label)

	// 逐项处理四种结果，避免 Mixed 或 Neutral 被误当成 RTL。
	switch d {
	case bidi.LeftToRight:
		return "ltr", nil
	case bidi.RightToLeft:
		return "rtl", nil
	case bidi.Mixed:
		return "mixed", nil
	case bidi.Neutral:
		return "neutral", nil
	default:
		return "", errUnsupportedDirection
	}
}

布局策略可以把 ltr、rtl、mixed 和 neutral 交给上层，但不要在这个转换函数里偷偷加入“混合文本一定非法”的规则。方向读取与业务约束分开，后续更容易测试和调整。

五、方向判定不等于 Bidi Rule 合法性校验

Direction 和 DirectionString 的返回类型是方向枚举；Valid 和 ValidString 才是布尔校验入口。包文档说明它实现 RFC 5893 定义的 Bidi Rule，因此需要检查标签是否符合该规则时，应直接读取布尔结果。

package main

import (
	"fmt"

	"golang.org/x/text/secure/bidirule"
)

func checkLabel(label string) {
	// 先读取方向，满足布局或展示层的需要。
	direction := bidirule.DirectionString(label)

	// 再单独检查规则；方向枚举本身不能替代合法性检查。
	valid := bidirule.ValidString(label)

	fmt.Printf("label=%q direction=%v valid=%v\n", label, direction, valid)
}

func main() {
	checkLabel("service.example")
	checkLabel("שלום")
}

这段代码故意保留两个结果：一个用于方向决策，一个用于规则决策。即使当前业务只关心其中一个，也不要根据另一个结果推断出未定义的安全结论。

六、什么时候需要 Transformer

bidirule.New 返回一个实现 transform.Transformer 的对象，它的职责不是返回一个方向枚举，而是验证输入是否遵循 Bidi Rule，并通过 Transform、Span 等转换接口参与流式处理。文档特别说明这个 Transformer 有状态，复用同一个实例处理下一段输入前需要调用 Reset。

因此可以按下面的路径选择：

1. 只要整体方向：调用 DirectionString 或 Direction。
2. 只要一次性合法性判断：调用 ValidString 或 Valid。
3. 要接入 transform 的流式处理链：使用 New，并管理 Transformer 的生命周期。
4. 同一个 Transformer 要处理下一段独立输入：先按接口契约调用 Reset，不要假设它是无状态函数。

方向判定、一次性校验和流式转换属于三个不同层次。把它们混在一个函数里，通常会让调用者误以为拿到方向就等于完成了规则验证。

七、常见误区与排查顺序

误区 1：把 Mixed 当成 RightToLeft

混合方向意味着输入同时出现两类方向字符。若界面需要镜像布局、文本需要分段渲染或标识符有额外规则，应保留这个状态，而不是直接降级到 rtl。

误区 2：用 ValidString 的结果代替方向

ValidString 只返回是否符合 Bidi Rule，不告诉你布局方向。需要两种信息时分别调用对应 API。

误区 3：把 []byte 当成任意编码文本

Direction 接收字节切片，但调用方仍应明确字节内容的编码和生命周期。不要把尚未完成编码处理的任意网络片段直接当作完整标签做最终业务决策。

误区 4：跨输入复用 Transformer 却不 Reset

Transformer 带状态，跨独立输入复用时要遵守 Reset 契约。若只是一次性判断，不需要为了“看起来更底层”而引入 Transformer。

八、最后的速查表

围绕这个标题，最稳妥的实现顺序是：先按输入类型选择 DirectionString 或 Direction，再完整处理四种方向结果；需要规则保证时另加 ValidString/Valid，只有确实需要流式转换时才引入 Transformer。

相关问题

• 为什么不能用 direction != bidi.LeftToRight 直接判断 RTL？因为还存在 Mixed 和 Neutral。
• DirectionString 和 Direction 的主要区别是什么？主要区别是输入分别为 string 和 []byte。
• 什么时候用 ValidString？当业务需要判断字符串是否符合 Bidi Rule，而不只是读取方向时。
• Transformer 能否跨请求直接复用？它有状态，独立输入之间应按契约调用 Reset 并自行管理并发访问边界。