
本文档旨在提供一个基于 go-gettext 库的 Go Web 应用国际化 (I18n) 的实用指南。它将引导你完成设置、代码修改、模板生成、翻译以及最终部署的整个过程,并提供示例代码和详细步骤,帮助你轻松实现应用的本地化。
环境准备与 go-gettext 安装
首先,你需要确保你的 Go 开发环境已经搭建好。然后,安装 go-gettext 库。假设你的项目结构如下:
~appname/ |~app/ | `-app.go |+github.com/ `-app.yaml
在项目根目录下执行以下命令:
$ cd appname $ git clone git://github.com/samuel/go-gettext.git github.com/samuel/go-gettext
这会将 go-gettext 库克隆到你的 github.com 目录下。
代码修改:使用 GetText 函数进行翻译
由于 Go 中下划线 _ 的特殊性,go-gettext 不支持使用 _("String to be translated") 这种简写形式。我们需要使用一个自定义的函数名,例如 GetText。
下面是一个最小化的工作示例:
package app
import (
"fmt"
"log"
"net/http"
"github.com/samuel/go-gettext"
)
func init() {
http.HandleFunc("/", home)
}
func home(w http.ResponseWriter, r *http.Request) {
d, err := gettext.NewDomain("appname", "locale")
if err != nil {
log.Fatal("Failed at NewDomain.")
}
cat := d.GetCatalog("fr_FR")
if cat == gettext.NullCatalog {
log.Fatal("Failed at GetCatalog.")
}
fmt.Fprintf(w, cat.GetText("Yes."))
}在这个例子中,我们首先创建了一个名为 "appname" 的 domain,并指定了 locale 目录为 "locale"。然后,我们获取了 "fr_FR" (法语) 的 catalog。最后,我们使用 cat.GetText("Yes.") 来获取 "Yes." 对应的法语翻译。
注意事项:
- gettext.NewDomain 的第一个参数是你的应用名称,第二个参数是存放 locale 文件的目录名。
- cat.GetText 函数用于根据当前 locale 获取翻译后的字符串。
生成模板:使用 xgettext
为了提取需要翻译的字符串,我们需要使用 xgettext 工具生成一个 .pot 文件 (Portable Object Template)。
$ xgettext -d appname -kGetText -s -o appname.pot app/app.go
参数说明:
- -d appname: 指定 domain 名称为 "appname"。
- -kGetText: 告诉 xgettext 查找名为 GetText 的函数。 重要:如果没有这个参数,xgettext 将不会识别 GetText 函数,导致生成空的 .pot 文件。
- -s: 添加源代码位置到 .pot 文件中。
- -o appname.pot: 指定输出文件名为 appname.pot。
- app/app.go: 指定要扫描的 Go 代码文件。
创建和编辑翻译文件
接下来,我们需要为目标语言创建翻译文件。这里以法语 (fr_FR) 为例:
$ mkdir -p locale/fr_FR/LC_MESSAGES $ msginit -l fr_FR -o french.po -i appname.pot
参数说明:
- mkdir -p locale/fr_FR/LC_MESSAGES: 创建存放翻译文件的目录结构。
- msginit -l fr_FR -o french.po -i appname.pot: 根据 .pot 文件初始化法语翻译文件 french.po。
现在,你需要编辑 french.po 文件,将 msgid 对应的字符串翻译成法语。
# Appname l10n # Copyright (C) 2013 Wombat Inc # This file is distributed under the same license as the appname package. # Wombat <[email protected]>, 2013. # msgid "" msgstr "" "Project-Id-Version: appname v0.1\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2013-01-13 11:03+1300\n" "PO-Revision-Date: 2013-01-13 11:10+1300\n" "Last-Translator: Rich <[email protected]>\n" "Language-Team: French\n" "Language: fr\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Plural-Forms: nplurals=2; plural=(n > 1);\n" #: app/app.go:15 msgid "Yes." msgstr "Oui."
将 msgid "Yes." 对应的 msgstr 修改为 msgstr "Oui."。
生成二进制翻译文件
最后,我们需要将 .po 文件编译成 .mo 文件 (Machine Object),这是 go-gettext 运行时需要加载的二进制文件。
$ msgfmt -c -v -o locale/fr_FR/LC_MESSAGES/appname.mo french.po
参数说明:
- -c: 检查翻译文件中的错误。
- -v: 显示详细的编译信息。
- -o locale/fr_FR/LC_MESSAGES/appname.mo: 指定输出文件名为 appname.mo,并存放到正确的目录下。
最终目录结构
完成以上步骤后,你的项目目录结构应该如下所示:
~appname/ |~app/ | `-app.go |~github.com/ | `~samuel/ | `~go-gettext/ | +locale/ | |-catalog.go | |-domain.go | `-mo.go |~locale/ | `~fr_FR/ | `LC_MESSAGES/ | `-appname.mo `-app.yaml
注意: go-gettext 库的 locale 目录下的内容是测试数据,可以移除。
运行与测试
现在,你可以运行你的 Go Web 应用。如果一切顺利,访问你的应用应该会显示法语翻译 "Oui."。
总结:
使用 go-gettext 可以有效地实现 Go Web 应用的国际化。 关键步骤包括:
- 使用 GetText 函数包裹需要翻译的字符串。
- 使用 xgettext 生成 .pot 模板文件,务必使用 -kGetText 参数。
- 使用 msginit 创建 .po 翻译文件。
- 编辑 .po 文件,进行翻译。
- 使用 msgfmt 将 .po 文件编译成 .mo 文件。
- 确保目录结构正确,go-gettext 能够找到 .mo 文件。
通过以上步骤,你就可以轻松地为你的 Go Web 应用添加国际化支持。










