Mongoid::Token 技术文档

1. 安装指南

在开始使用 Mongoid::Token 前，您需要确保已经安装了 Mongoid。以下是安装 Mongoid::Token 的步骤：

根据您使用的 Mongoid 版本，在 Gemfile 中添加相应的代码：

# 对于 mongoid < 5 的版本
gem 'mongoid_token', '~> 3.0.0'

# 对于 mongoid >= 5 的版本
gem 'mongoid_token', '~> 4.0.0'

然后更新您的 bundle：

$ bundle install

2. 项目的使用说明

在您的 Mongoid 文档中，只需添加 include Mongoid::Token。token 方法将自动处理所有设置，如下所示：

class Person
  include Mongoid::Document
  include Mongoid::Token

  field :name

  token
end

就是这样！还有许多配置选项 - 都列在下面的“配置”部分中。默认情况下，token 方法将创建包含随机字母数字字符的 4 个字符长的 token。

注意： Mongoid::Token 利用 Mongoid 的“安全模式”，通过在文档上自动创建一个使用 token 字段的唯一索引。为了利用这个特性（并确保您的文档始终具有唯一的 token），请记得创建索引。

3. 项目API使用文档

以下是 Mongoid::Token 的主要 API 方法：

• token: 在文档中生成一个唯一的 token。
• find_by_[token_name]: 通过 token 查找文档。
• token: 可以接受多个配置选项，用于自定义 token 的生成。

配置选项

Tokens

• :length: 设置 token 的长度。
• :contains: 设置 token 中包含的字符类型。
• :pattern: 允许您细粒度控制 token 的外观。

Field Name (:field_name)

• 更改 Mongoid::Token 使用的字段名。

Skip Finders (:skip_finders)

• 阻止生成额外的 find_by_* 方法。

Override to_param (:override_to_param)

• 是否覆盖 to_param 方法。

Retry Count (:retry_count)

• 设置在发生 token 冲突时尝试的次数。

4. 项目安装方式

Mongoid::Token 的安装方式与上述“安装指南”中描述的步骤相同。您需要在 Gemfile 中添加相应的 gem 依赖，然后执行 bundle install 命令。