本文探讨了在Revel框架中批量获取特定模块和语言的所有国际化字符串的挑战与解决方案。鉴于Revel默认的国际化机制是基于消息（即需要原始字符串才能获取翻译），直接访问所有翻译键值对并不直接。文章提出了通过自定义函数、向Revel贡献代码或采用本地代码复制等多种方法来绕过这一限制，并提供了实现思路和注意事项，旨在帮助开发者构建支持多语言的API服务。
理解Revel的国际化机制
Revel框架的国际化（i18n）功能设计类似于gettext，它采用基于消息的翻译模式。这意味着，要获取某个字符串的翻译，您通常需要提供原始的（通常是英文）字符串作为键。Revel内部将这些翻译字符串存储在i18n.go文件中的messages映射中，该映射按语言进行分类，每个语言的翻译又存储在Config对象中。
然而，messages映射是一个未导出的私有成员，这意味着Revel框架的外部代码无法直接访问它来批量获取所有翻译字符串。对于需要向API客户端返回特定模块（例如home或news）和特定语言（例如en-US）的所有键值对翻译的场景，Revel的默认设计并未直接提供相应的公共API。
解决方案与实施策略
鉴于Revel内部设计的限制，要实现批量获取特定模块和语言的国际化字符串，可以考虑以下几种策略：
1. 自定义函数或贡献Revel框架
最理想且推荐的解决方案是编写一个自定义函数，该函数能够根据模块名和语言环境读取并解析对应的消息文件。或者，更进一步，您可以向Revel项目提交一个拉取请求（Pull Request），以导出现有的一些内部函数（如loadMessageFile或parseMessagesFile），或添加一个全新的公共API来支持此功能。
自定义函数实现思路：
Revel的国际化文件通常采用INI文件格式，并由robfig/config库进行解析。您可以复用或借鉴其内部逻辑来读取文件。
假设您的消息文件结构如下：
/messages /home.en /home.fr /news.en /news.fr
一个自定义函数可能需要：
- 接收模块名（如"home"）和语言代码（如"en"）。
- 根据这些参数构建正确的文件路径（如./messages/home.en）。
- 使用robfig/config库读取该文件。
- 遍历配置文件中的所有键值对，并将其收集到一个map[string]string中返回。
示例代码（伪代码）：
以下是一个简化的Go语言函数示例，演示了如何通过直接读取配置文件来实现这一功能。请注意，这需要您了解Revel内部消息文件的存储路径和格式。
package main
import (
"fmt"
"io/ioutil"
"path/filepath"
"strings"
"github.com/robfig/config" // Revel内部使用此库解析INI文件
)
// GetModuleMessagesFromPath 假设Revel的消息文件存储在应用的messages目录下
// 此函数用于从指定路径加载特定模块和语言的消息
func GetModuleMessagesFromPath(messagesDir, module, locale string) (map[string]string, error) {
// 构建消息文件的完整路径，例如：./messages/home.en
filePath := filepath.Join(messagesDir, fmt.Sprintf("%s.%s", module, locale))
// 检查文件是否存在
if _, err := ioutil.ReadFile(filePath); err != nil {
if strings.Contains(err.Error(), "no such file or directory") {
return nil, fmt.Errorf("消息文件未找到: %s", filePath)
}
return nil, fmt.Errorf("无法读取消息文件 %s: %w", filePath, err)
}
// 使用robfig/config库读取INI文件
cfg, err := config.ReadDefault(filePath)
if err != nil {
return nil, fmt.Errorf("解析配置文件 %s 失败: %w", filePath, err)
}
translations := make(map[string]string)
// Revel的i18n文件通常没有显式Section，所有键都在默认Section下
// 但robfig/config允许获取所有Section，此处为兼容性考虑
sections := cfg.Sections()
if len(sections) == 0 { // 如果没有显式Section，尝试获取DEFAULT Section的选项
options, err := cfg.Options(config.DEFAULT_SECTION)
if err == nil {
for _, option := range options {
value, err := cfg.String(config.DEFAULT_SECTION, option)
if err == nil {
translations[option] = value
}
}
}
} else {
for _, section := range sections {
options, err := cfg.Options(section)
if err != nil {
// 忽略错误或记录日志
continue
}
for _, option := range options {
value, err := cfg.String(section, option)
if err != nil {
// 忽略错误或记录日志
continue
}
translations[option] = value
}
}
}
return translations, nil
}
// 假设在Revel应用中调用
// func main() {
// // Revel应用启动时，可以获取到messagesDir
// // 例如：messagesDir := revel.Conf.Paths["messages"] // 假设Revel提供了这样的配置
// messagesDir := "./messages" // 示例路径
// // 获取home模块的英文翻译
// homeEnMessages, err := GetModuleMessagesFromPath(messagesDir, "home", "en")
// if err != nil {
// fmt.Println("加载home.en消息失败:", err)
// } else {
// fmt.Println("Home英文消息:", homeEnMessages)
// }
// // 获取news模块的法文翻译
// newsFrMessages, err := GetModuleMessagesFromPath(messagesDir, "news", "fr")
// if err != nil {
// fmt.Println("加载news.fr消息失败:", err)
// } else {
// fmt.Println("News法文消息:", newsFrMessages)
// }
// }注意事项：
- 您需要确定Revel实际加载消息文件的根目录。通常，这会是应用程序的messages子目录。
- 确保您的自定义函数能够正确处理文件不存在或解析失败的情况。
- 这种方法绕过了Revel的内部缓存机制，每次调用都会重新读取和解析文件，因此在性能敏感的场景下可能需要自行实现缓存。
2. 本地代码复制或Fork Revel
如果无法等待Revel官方更新或不希望贡献代码，您可以选择：
- 复制相关代码： 从Revel的i18n.go文件中复制loadMessageFile或parseMessagesFile等函数的实现到您自己的项目中，并根据需要进行修改以导出所需功能。
- Fork Revel项目： 克隆Revel的GitHub仓库，在您的私有分支中修改i18n.go，将messages映射或相关加载函数导出为公共API，然后您的项目可以引用您修改后的Revel版本。
注意事项：
- 这两种方法都意味着您需要承担Revel框架更新时的维护成本。当Revel发布新版本时，您可能需要手动合并更改，以避免兼容性问题或错过重要功能/安全修复。
- 代码复制可能导致代码冗余，并使得您的项目与Revel的依赖关系变得复杂。
3. 手动解析（不推荐）
虽然Revel的本地化文件是INI格式，理论上您可以手动编写代码来解析这些文件，但这通常不推荐。robfig/config库已经为您处理了INI文件的复杂性，包括注释、特殊字符、多行值等。手动解析容易出错，且维护成本高。
总结
在Revel框架中批量获取特定模块的所有语言字符串，核心挑战在于其默认的国际化机制和未导出的内部数据结构。最推荐的解决方案是编写一个自定义函数，该函数直接读取并解析相应的消息文件，并返回所需的键值对映射。这种方法既能满足需求，又保持了与Revel框架的相对独立性。如果您的项目对性能有极高要求，并且愿意承担维护成本，也可以考虑对Revel框架进行贡献或本地化修改。无论选择哪种方法，都应充分理解其优缺点，并根据项目实际情况做出决策。
