Golang基于gettext概念的灵活翻译和人机交互插件库spreak的使用

Spreak是一个基于gettext概念的Go语言灵活翻译和人机交互库，需要Go 1.19+版本。

为什么选择另一个库？

虽然已有许多优秀的Go本地化库，但作者发现它们存在一些不足：有些使用自定义格式无法用通用工具编辑，有些仅支持单一语言或使用大量互斥锁，且没有工具能轻松提取待翻译字符串。因此开发了spreak来解决这些问题。

特性

• 内置支持po、mo和json文件格式
• 直接支持Go数据结构的人性化显示
• 支持fs.FS（如embed）
• 通过不可变性实现goroutine安全和无锁
• 强大的字符串提取器简化本地化流程（支持模板）
• 支持gettext和CLDR v44复数规则
• 支持双语和单语格式

使用方法

首先安装最新版本的库：

go get -u github.com/vorlif/spreak

基本使用示例

package main

import (
	"fmt"

	"golang.org/x/text/language"

	"github.com/vorlif/spreak"
	"github.com/vorlif/spreak/localize"
)

func main() {
	// 创建加载所需语言翻译的bundle
	// 通常一个应用只需要一个bundle
	bundle, err := spreak.NewBundle(
		// 设置程序代码/模板中使用的语言
		spreak.WithSourceLanguage(language.English),
		// 设置翻译文件加载路径
		spreak.WithDomainPath(spreak.NoDomain, "./locale"),
		// 指定要加载的语言
		spreak.WithLanguage(language.German, language.Spanish, language.Chinese),
	)
	if err != nil {
		panic(err)
	}

	// 创建Localizer选择要翻译的语言
	t := spreak.NewLocalizer(bundle, language.Spanish)

	// 翻译
	fmt.Println(t.Get("Hello world"))
	fmt.Println(t.NGetf("I have %d dog", "I have %d dogs", 2, 2))
	fmt.Println(t.Localize(GetPlanet()))

	// 输出: 
	// Hola Mundo
	// Tengo 2 perros
	// No conozco ningún planeta
}

func GetPlanet() *localize.Message {
	return &localize.Message{
		Singular: "I do not know any planet",
		Plural:   "I do not know any planets",
	}
}

提取字符串

可以使用命令行工具xspreak提取翻译字符串。安装：

go install github.com/vorlif/xspreak@latest

测试安装：

xspreak --help

提取命令示例

# 生成.pot文件
xspreak -D path/to/source/ -p path/to/source/locale
# 生成.json文件
xspreak -D path/to/source/ -p path/to/source/locale -f json

翻译文件结构

如何组织翻译文件由您决定。假设您从路径"./locale"加载域"helloworld"和语言language.Spanish：

spreak.WithDomainPath("helloworld", "./locale"),
spreak.WithLanguage(language.Spanish),

spreak默认会搜索以下文件：

./locale/es/helloworld.po
./locale/helloworld/es.po
./locale/es.po
./locale/LC_MESSAGES/es/helloworld.po

其中es是[es-ES, es_ES, spa, es]列表中的示例，文件扩展名.po是[po, mo, json]列表中的示例。

人性化包(humanize)

humanize包提供了一组函数，将Go数据结构转换为人类可读格式。它广泛适配自Django项目并使用了Django的翻译。

使用示例

package main

import (
	"fmt"
	"time"

	"golang.org/x/text/language"

	"github.com/vorlif/spreak/humanize"
	"github.com/vorlif/spreak/humanize/locale/ar"
	"github.com/vorlif/spreak/humanize/locale/es"
	"github.com/vorlif/spreak/humanize/locale/zhHans"
)

func main() {
	// 加载所需语言的翻译
	collection := humanize.MustNew(
		humanize.WithLocale(es.New(), ar.New(), zhHans.New()),
	)

	// 创建humanizer
	h := collection.CreateHumanizer(language.English)

	// 使用函数...
	fmt.Println(h.Intword(1_000_000_000))
	// 输出: 1.0 billion

	fmt.Println(h.NaturalDay(time.Now()))
	// 输出: today

	t := time.Now().Add(5 * time.Minute)
	fmt.Println(h.NaturalTime(t))
	// 输出: 5 minutes from now

	d := -80 * time.Hour
	fmt.Println(h.TimeSince(d))
	// 输出: 3 days, 8 hours

	// 为不同语言使用
	h = collection.CreateHumanizer(language.Spanish)
	fmt.Println(h.TimeSince(d))
	// 输出: 3 días, 8 horas
}

许可证

spreak采用MIT许可证。humanize包的翻译采用Django的BSD许可证。