Prefixed IDs 开源项目教程

Prefixed IDs 开源项目教程

prefixed_idsFriendly Prefixed IDs for your Ruby on Rails models项目地址:https://gitcode.com/gh_mirrors/pr/prefixed_ids

1、项目介绍

Prefixed IDs 是一个用于 Ruby on Rails 模型的开源项目，旨在生成带有友好前缀的 ID。例如，生成的 ID 可能类似于 user_12345abcd 或 acct_23lksjdg3。这个 gem 通过使用哈希算法对记录的原始 :id 属性进行处理，从而生成带有前缀的 ID。

项目地址：GitHub - excid3/prefixed_ids

2、项目快速启动

安装

在您的 Rails 应用的 Gemfile 中添加以下行：

gem 'prefixed_ids'

然后运行：

bundle install

配置

在您的模型中添加 has_prefix_id：

class User < ApplicationRecord
  has_prefix_id :user
end

这将自动生成带有前缀的 ID，例如 user_1234abcd。

使用

生成带有前缀的 ID：

@user = User.create
@user.to_param # => "user_1234abcd"

查询带有前缀的 ID：

User.find("user_1234abcd")

3、应用案例和最佳实践

应用案例

假设您有一个多租户应用，其中每个租户有自己的用户。使用 Prefixed IDs 可以轻松区分不同租户的用户：

class User < ApplicationRecord
  has_prefix_id :user
end

class Tenant < ApplicationRecord
  has_prefix_id :tenant
end

这样生成的用户 ID 可能类似于 user_1234abcd，而租户 ID 可能类似于 tenant_5678efgh。

最佳实践

1. 添加盐值：为了增强安全性，建议添加盐值以防止 ID 被猜测：

   class User < ApplicationRecord
     has_prefix_id :user, salt: "usersalt"
   end
   

2. 禁用覆盖：如果您不想覆盖 find 和 to_param 方法，可以禁用它们：

   class User < ApplicationRecord
     has_prefix_id :user, override_find: false, override_param: false
   end
   

4、典型生态项目

Prefixed IDs 可以与其他 Ruby on Rails 生态项目结合使用，例如：

• Devise：用于用户认证，结合 Prefixed IDs 可以生成安全的用户 ID。
• ActiveAdmin：用于管理后台，使用 Prefixed IDs 可以增强管理界面的安全性。
• Rails API：在构建 API 时，使用 Prefixed IDs 可以提供更友好的 URL 和参数。

通过结合这些生态项目，可以进一步提升应用的安全性和用户体验。

prefixed_idsFriendly Prefixed IDs for your Ruby on Rails models项目地址:https://gitcode.com/gh_mirrors/pr/prefixed_ids