shell脚本的国际化——gettext与pot、po、mo

大家好，欢迎来到IT知识分享网。

博客主页：https://tomcat.blog.csdn.net
博主昵称：农民工老王
主要领域：Java、Linux、K8S
期待大家的关注💖点赞👍收藏⭐留言💬

简介

在编写shell脚本时，我们可能需要shell脚本在运行时，根据用户操作系统的语言环境，自动选择对应语言的字符串进行输出。这个时候，就需要用到gettext和消息数据库。

与消息数据库相关的是三种语言文件：pot，po，mo。当mo文件存放在规定路径的文件夹中时，这个文件夹就可以称之为一个消息数据库。

pot是Portable Object Template的缩写。由英文名称可知，这是一类模板文件。
po是Portable Object的缩写，可由pot文件生成，可以看做是pot文件的子类，因为pot文件和po文件从语法上来看是一致的，只不过填充了翻译的内容。
mo指Machine Object的缩写，由po文件生成，是一个二进制数据文件，是Linux实现国际化时，实际使用的文件。

pot和po格式的文件都是文本文件，可以直接在文本编辑器中编写，也可以通过特定软件生成。mo文件不可以直接阅读，但可以反编译为po文件后再阅读。

所用到的软件是gettext，该软件为程序员、翻译人员甚至用户提供了一套集成良好的工具和文档。gettext旨在最大限度地减少国际化对程序源的影响。

具体来说，gettext提供了以下功能：

• 在程序源代码中添加gettext的相关声明信息及本地化运行环境检测代码;
• 为需要翻译的交互语句设置标记;
• 使用gettext工具提取源代码中的交互语句，生成pot文件;
• 使用msginit工具将pot文件转化成一个特定语言版本的po文件; 或者使用msgmerge将更新了的pot文件与旧的po文件合并生成新的po文件;
• 编辑po文件，将交互语句逐条翻译;
• 使用msgfmt工具将po文件转化成mo文件。

gettext的在线帮助文档为：https://www.gnu.org/software/gettext/manual/html_node/

准备测试脚本

gettext的组件可以直接从代码中提取需要国际化的字符串，因此我们要先准备一段测试脚本。

#!/bin/bash # ------------------------------------------ # Filename : test.sh # Version : 1.0 # Date : 2023-9-20 18:30:23 # Author : 农民工老王@CSDN # Email :  # Website : https://blog.csdn.net/monarch91 # Description : 国际化测试shell # ------------------------------------------ export TEXTDOMAINDIR="./locale" export TEXTDOMAIN="laowangtest" getStr(){ 
    gettext -e -s "$1" } printf_loc(){ 
    local myStr=$(getStr "$1") shift printf "${myStr}\n" "$@" } printf_loc "WELCOME_WORDS" printf_loc "INTRODUCE" Laowang 32 

代码中调用了gettext这一关键函数，在这里介绍一下，该函数的用法：

用法：gettext [选项] [[文本域] MSGID] 或： gettext [选项] -s [MSGID]... 显示某原文消息的本地语言翻译。 -d, --domain=文本域 由<文本域>读取翻译后的消息 -e 允许展开某些转义字符 -E (为了兼容性存在的选项，不会造成任何影响) -h, --help 显示此段说明消息并退出 -n 禁用尾随的换行符 -V, --version 显示版本信息并退出 [文本域] MSGID 由<文本域>读取相应于 MSGID 的翻译消息 

生成pot

具体命令如下：

xgettext test.sh -o msg.pot \ --language=shell \ --keyword=printf_loc \ --add-comments --add-location --no-wrap \ --copyright-holder="laowang" \ --package-name="test" \ --package-version="V1.0"\ --msgid-bugs-address="" 

上面命令中的xgettext函数是用于从指定文件中提取需要被翻译的字符串，常用参数为：

 -o, --output=文件 指定输出文件路径。 -L, --language=NAME 识别指定的语言，如：C,C++,C#,PO,Shell,Python,Java,awk,PHP,JavaScript。 -c, --add-comments 在输出文件中以关键词开启一行，并放置所有注释块 -k, --keyword 不使用默认关键字 -n, --add-location 生成“#: 文件名:行号”位置行(默认) --no-wrap 不将超过输出页宽度的长消息行断为多行 --copyright-holder=字符串 在输出中设置版权占位符 --package-name=PACKAGE 输出时设定软件包名字 --package-version=VERSION 输出时设定软件包版本 --msgid-bugs-address=EMAIL@ADDRESS 设置报告 msgid 错误的地址 

编辑pot

生成的pot有时候需要修改，主要是处理误生成的冗余文本。如下图所示20,21,22行就需要删除。这可能算是一个bug，即使在指定了keyword的情况下，生成pot时，还是会扫描到gettext那一行。
不过，在写shell脚本时，可以把自定义的方法放在另一个shell脚本中，通过source读取后再调用。这样生成的pot文件，就不会有额外的内容。

生成po

po通过pot文件生成，示例命令如下，其中-i参数设置pot路径，-l参数设置语言，-o参数设置po文件的输出路径。

# 生成中文po msginit -i msg.pot -l zh_CN.UTF-8 -o zh_CN.po # 生成英语po msginit -i msg.pot -l en_US.UTF-8 -o en_US.po 

生成的zh_CN.po原文件：

# Chinese translations for test package # test 软件包的简体中文翻译. # Copyright (C) 2023 laowang # This file is distributed under the same license as the test package. # <>, 2023. # msgid "" msgstr "" "Project-Id-Version: test V1.0\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2023-09-20 14:31+0800\n" "PO-Revision-Date: 2023-09-20 15:36+0800\n" "Last-Translator: <>\n" "Language-Team: Chinese (simplified)\n" "Language: zh_CN\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: test.sh:12 msgid "WELCOME_WORDS" msgstr "" #: test.sh:13 msgid "INTRODUCE" msgstr "" 

生成的en_US.po原文件：

# English translations for test package. # Copyright (C) 2023 laowang # This file is distributed under the same license as the test package. # <>, 2023. # msgid "" msgstr "" "Project-Id-Version: test V1.0\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2023-09-20 14:31+0800\n" "PO-Revision-Date: 2023-09-20 15:36+0800\n" "Last-Translator: <>\n" "Language-Team: English\n" "Language: en_US\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" #: test.sh:12 msgid "WELCOME_WORDS" msgstr "WELCOME_WORDS" #: test.sh:13 msgid "INTRODUCE" msgstr "INTRODUCE" 

观察上文的代码可知：每个.po文件都由一个或多个翻译单元(entry)组成，各翻译单元之间由空行分隔。每个翻译单元内，包含一个待翻译语句和相对应的翻译版本。

po文件中的翻译单元(entry)的语义格式如下：

#后紧接着空格符的注释内容，是文件属性信息；
#后紧接着:的注释是待翻译语句在源代码中的位置信息；
#后紧接着|的注释是这条待翻译语句之前的相关翻译信息；
msgid行是从源代码中提取出的待翻译语句；
msgstr行是对应的翻译版本。

编辑po

观察通过pot生成的中文po文件，发现原始的po文件只有一个基础的框架，仅仅比pot文件多了一些编辑者和语种的信息，这些内容实际上都不是必须的，甚至可以删除。英文的po文件，虽然填充了msgstr，但就是把msgid复制了一次，是无法使用的。因此生成的po文件最重要的翻译文本仍然空缺，需要人工填写。

po文件的修改，可以通过文本编辑器进行，也可以通过Poedit这一专门的软件进行，如下图所示。如果你是将翻译工作交由非开发人员完成，那么使用Poedit是一个更好的选择。

修改后的zh_CN.po文件：

# Chinese translations for test package # test 软件包的简体中文翻译. # Copyright (C) 2023 laowang # This file is distributed under the same license as the test package. # <>, 2023. # msgid "" msgstr "" "Project-Id-Version: test V1.0\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2023-09-20 14:31+0800\n" "PO-Revision-Date: 2023-09-20 15:36+0800\n" "Last-Translator: <>\n" "Language-Team: Chinese (simplified)\n" "Language: zh_CN\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: test.sh:12 msgid "WELCOME_WORDS" msgstr "您好，欢迎来到Linux的世界。" #: test.sh:13 msgid "INTRODUCE" msgstr "我的名字是%s，年龄是%d岁。" 

修改后的en_US.po文件：

# English translations for test package. # Copyright (C) 2023 laowang # This file is distributed under the same license as the test package. # <>, 2023. # msgid "" msgstr "" "Project-Id-Version: test V1.0\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2023-09-20 14:31+0800\n" "PO-Revision-Date: 2023-09-20 15:36+0800\n" "Last-Translator: <>\n" "Language-Team: English\n" "Language: en_US\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" #: test.sh:12 msgid "WELCOME_WORDS" msgstr "Hello,Welcome to the world of Linux." #: test.sh:13 msgid "INTRODUCE" msgstr "My name is %s , aged %d." 

生成mo

mo文件由po文件生成，mo文件也可以反编译为po文件。示例代码如下：

#po转为mo  msgfmt xxxx.po -o xxxx.mo #mo转为po msgunfmt xxxx.mo -o xxxx.po 

本文案例的操作如下：

mkdir -p locale/zh_CN/LC_MESSAGES mkdir -p locale/en_US/LC_MESSAGES msgfmt zh_CN.po -o locale/zh_CN/LC_MESSAGES/laowangtest.mo msgfmt en_US.po -o locale/en_US/LC_MESSAGES/laowangtest.mo 

需要说明的是，不建议将mo文件直接生成在当前文件夹，而应该生成在locale/${语言代号}/LC_MASSAGES这样一个目录层级中。因为这个目录结构是gettext要求的，这样的locale文件夹就是一个上文提到的“消息数据库”。
默认的l消息数据库的路径是/usr/share/locale，如下图所示，该文件夹存储了操作系统和各个软件提供的本地化文件。

实现国际化

消息数据库的使用需要注意三个全局变量。

• LC_MESSAGES： 指定语言环境，如果提供，则会覆盖消息的 LANG。
• TEXTDOMAIN： 指定文本域名，它与不带有 .mo 后缀的消息目标文件名相同。
• TEXTDOMAINDIR： 指定消息数据库的路径名。如果提供，则会替换 /usr/lib/locale。

另外，我们既可以通过TEXTDOMAINDIR指定消息数据库的路径，也可以将我们创建的消息数据库复制到默认消息数据库的路径/usr/lib/locale，这样的话，测试脚本中的export TEXTDOMAINDIR="./locale"就可以删除。
同时，文本域名还可以通过gettext的-d参数指定，所以测试脚本中的export TEXTDOMAIN="laowangtest"这一行可以删除，只需要将gettext -e -s "$1"改成gettext -e -s -d "laowangtest" "$1"。
因此在locale文件夹复制到/usr/lib/后，测试脚本也可以写成这样。

#!/bin/bash getStr(){ 
    gettext -e -s -d "laowangtest" "$1" } printf_loc(){ 
    local myStr=$(getStr "$1") shift printf "${myStr}\n" "$@" } printf_loc "WELCOME_WORDS" printf_loc "INTRODUCE" Laowang 32 

无论是哪种写法，都可以得到如下测试效果。

如需转载，请注明本文的出处：农民工老王的CSDN博客https://blog.csdn.net/monarch91 。