I18n::Backend::ActiveRecord 技术文档

1. 安装指南

1.1 使用 Bundler 安装

在项目的 Gemfile 中添加以下内容：

gem 'i18n-active_record', require: 'i18n/active_record'

然后运行以下命令更新 Gem 包：

bundle install

1.2 运行安装器

更新 Gem 包后，运行以下命令以安装 i18n-active_record：

rails g i18n:active_record:install

该命令将生成一个迁移文件，用于创建 translations 表。

1.3 自定义表名

如果需要自定义表名，可以使用以下命令：

rails g i18n:active_record:install MyTranslation

1.4 简单安装

如果需要进行简单安装，可以使用以下命令：

rails g i18n:active_record:install --simple

该命令将生成一个简单的初始化文件。

1.5 配置清理方式

可以通过以下配置指定 ActiveRecord 后端在清理时使用 destroy 或 delete：

I18n::Backend::ActiveRecord.configure do |config|
  config.cleanup_with_destroy = true # 默认值为 false
end

1.6 配置缓存

如果需要在生产环境中缓存翻译，可以使用以下配置：

I18n::Backend::ActiveRecord.configure do |config|
  config.cache_translations = true # 默认值为 false
end

2. 项目的使用说明

2.1 基本使用

安装完成后，可以使用 I18n.t('Your String') 来从数据库中查找翻译。

2.2 自定义翻译模型

默认情况下，该 gem 使用内置的翻译模型。如果需要扩展功能，可以自定义翻译模型：

class MyTranslation < I18n::Backend::ActiveRecord::Translation
  def value=(val)
    super("custom #{val}")
  end
end

I18n::Backend::ActiveRecord.configure do |config|
  config.translation_model = MyTranslation
end

2.3 处理缺失翻译

为了使 I18n::Backend::ActiveRecord::Missing 模块正常工作，需要正确配置复数规则。i18n.plural.keys 翻译键应存在于任何后端中。

en:
  i18n:
    plural:
      keys:
        - :zero
        - :one
        - :other

2.4 插值字段

translations 表中的 interpolations 字段用于存储首次请求翻译时的插值。这有助于翻译人员理解需要包含哪些插值。

3. 项目API使用文档

3.1 基本API

• I18n.t('Your String'): 从数据库中查找翻译。

3.2 配置API

• I18n::Backend::ActiveRecord.configure: 配置 ActiveRecord 后端的选项，如清理方式和缓存。

3.3 自定义模型API

• I18n::Backend::ActiveRecord::Translation: 默认的翻译模型，可以继承并扩展。

4. 项目安装方式

4.1 通过 Bundler 安装

在 Gemfile 中添加 gem 'i18n-active_record'，然后运行 bundle install。

4.2 运行安装器

使用 rails g i18n:active_record:install 命令生成迁移文件并配置初始化文件。

4.3 自定义安装

可以通过 --simple 选项进行简单安装，或通过指定表名进行自定义安装。

4.4 配置选项

通过 I18n::Backend::ActiveRecord.configure 配置清理方式和缓存选项。

---

以上是 I18n::Backend::ActiveRecord 项目的技术文档，涵盖了安装指南、使用说明、API 文档以及安装方式。希望这份文档能帮助用户更好地理解和使用该项目。