friendly_id下载friendly_id源代码下载

friendly_id

其他源码

1.0.0

下载

友好ID

有关最完整、用户友好的文档，请参阅FriendlyId 指南。

FriendlyId 是 Active Record 的重击和永久链接插件的“瑞士陆军推土机”。它可以让您创建漂亮的 URL 并使用人类友好的字符串，就好像它们是数字 ID 一样。

借助FriendlyId，您可以轻松地让您的应用程序使用如下URL：

 https://example.com/states/washington

而不是：

 https://example.com/states/4323454

寻求帮助

使用“Friendly-id”标签在 Stack Overflow 上提问，有关错误，请查看错误部分

友好ID功能

FriendlyId 提供许多高级功能，包括：

slug 历史记录和版本控制
国际化
范围内的蛞蝓
保留字
定制段塞生成器

用法

将此行添加到应用程序的 Gemfile 中：

 gem 'friendly_id' , '~> 5.5.0'

注意：Rails 4.0+ 必须使用 5.0.0 或更高版本。

然后执行：

bundle install

将slug列添加到所需的表（例如Users ）

rails g migration AddSlugToUsers slug:uniq

生成友好的配置文件和新的迁移

rails generate friendly_id

注意：如果您不使用 slug 历史记录功能，则可以删除CreateFriendlyIdSlugs迁移。（阅读更多）

运行迁移脚本

rails db:migrate

编辑app/models/user.rb文件如下：

 class User < ApplicationRecord
  extend FriendlyId
  friendly_id :name , use : :slugged
end

编辑app/controllers/users_controller.rb文件并将User.find替换为User.friendly.find

 class UserController < ApplicationController
  def show
    @user = User . friendly . find ( params [ :id ] )
  end
end

现在，当您创建一个新用户时，如下所示：

 User . create! name : "Joe Schmoe"

然后，您可以使用 URL http://localhost:3000/users/joe-schmoe 访问用户显示页面。

如果您要将FriendlyId添加到现有应用程序并需要为现有用户生成slugs，请从控制台、运行器执行此操作，或添加Rake任务：

 User . find_each ( & :save )

选项

`:allow_nil`

如果您想避免引发ActiveRecord::RecordNotFound并接受nil ，您可以将allow_nil: true传递给friendly.find()方法。

例子

 MyModel . friendly . find ( "bad-slug" ) # where bad-slug is not a valid slug
MyModel . friendly . find ( 123 )        # where 123 is not a valid primary key ID
MyModel . friendly . find ( nil )        # maybe you have a variable/param that's potentially nil
#=> raise ActiveRecord::RecordNotFound

MyModel . friendly . find ( "bad-slug" , allow_nil : true )
MyModel . friendly . find ( 123 , allow_nil : true )
MyModel . friendly . find ( nil , allow_nil : true )
#=> nil