Rails Settings Cached 技术文档

本文档将详细介绍如何使用 Rails Settings Cached 插件，帮助您轻松管理 Rails 应用程序中的全局设置。

1. 安装指南

在开始使用之前，您需要将 Rails Settings Cached 添加到您的 Gemfile 中：

$ bundle add rails-settings-cached

接下来，生成您的设置：

$ rails g settings:install

# 或者使用自定义名称：
$ rails g settings:install AppConfig

执行迁移以将设置表添加到数据库：

$ rails db:migrate

2. 项目的使用说明

Rails Settings Cached 允许您使用简单的方法轻松管理全局键值对，就像在数据库中存储一个全局的 Hash 一样。

以下是使用示例：

# 获取设置
Setting.host
Setting.app_name

# 更新设置
Setting.app_name = "Rails Settings Cached"
Setting.user_limits = 30

获取已定义的字段

# 获取所有键
Setting.keys

# 获取可编辑的键
Setting.editable_keys

# 获取只读键
Setting.readonly_keys

# 获取特定字段
Setting.get_field("host")

自定义类型

从版本 2.9.0 开始，您可以编写自己的自定义字段类型。

module RailsSettings
  module Fields
    class YesNo < ::RailsSettings::Fields::Base
      def serialize(value)
        case value
        when true then "YES"
        when false then "NO"
        else raise StandardError, 'invalid value'
        end
      end

      def deserialize(value)
        case value
        when "YES" then true
        when "NO" then false
        else nil
        end
      end
    end
  end
end

现在您可以在设置中使用 yes_no 类型：

class Setting
  field :custom_item, type: :yes_no, default: 'YES'
end

3. 项目API使用文档

以下是项目的一些关键 API 方法：

• Setting.keys: 获取所有键。
• Setting.editable_keys: 获取所有可编辑的键。
• Setting.readonly_keys: 获取所有只读的键。
• Setting.get_field(key): 获取特定键的字段信息。
• Setting.defined_fields: 获取所有已定义的字段。

4. 项目安装方式

项目安装方式已在“安装指南”部分详细说明。以下是简要步骤：

1. 将 Rails Settings Cached 添加到 Gemfile。
2. 执行 bundle install。
3. 生成设置文件。
4. 执行数据库迁移。

通过以上步骤，您就可以开始使用 Rails Settings Cached 管理您的应用程序的全局设置了。