FriendlyId 技术文档

1. 安装指南

1.1 添加 Gem 到 Gemfile

首先，在你的 Rails 应用的 Gemfile 中添加以下代码：

gem 'friendly_id', '~> 5.5.0'

注意：对于 Rails 4.0 及以上版本，你必须使用 5.0.0 或更高版本的 FriendlyId。

1.2 安装 Gem

在终端中运行以下命令来安装 Gem：

bundle install

1.3 添加 slug 列

接下来，你需要为相应的表添加一个 slug 列。例如，如果你希望在 Users 表中使用 FriendlyId，可以运行以下命令：

rails g migration AddSlugToUsers slug:uniq

1.4 生成配置文件和迁移

运行以下命令生成 FriendlyId 的配置文件和一个新的迁移：

rails generate friendly_id

注意：如果你不打算使用 slug 历史功能，可以删除生成的 CreateFriendlyIdSlugs 迁移文件。

1.5 运行迁移

最后，运行数据库迁移：

rails db:migrate

2. 项目的使用说明

2.1 配置模型

在 app/models/user.rb 文件中，添加以下代码以启用 FriendlyId：

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

2.2 修改控制器

在 app/controllers/users_controller.rb 文件中，将 User.find 替换为 User.friendly.find：

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

2.3 创建用户并访问

现在，你可以创建一个新用户，并使用友好的 URL 访问用户页面。例如：

User.create! name: "Joe Schmoe"

然后，你可以通过以下 URL 访问用户页面：

http://localhost:3000/users/joe-schmoe

2.4 为现有用户生成 slug

如果你是在现有应用中添加 FriendlyId，并且需要为现有用户生成 slug，可以在控制台、runner 或 Rake 任务中运行以下代码：

User.find_each(&:save)

3. 项目 API 使用文档

3.1 friendly.find 方法

FriendlyId 提供了 friendly.find 方法，用于通过 slug 查找记录。你可以使用以下方式调用：

User.friendly.find("joe-schmoe")

3.2 :allow_nil 选项

如果你希望在找不到记录时不抛出 ActiveRecord::RecordNotFound 异常，而是返回 nil，可以使用 :allow_nil 选项：

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

4. 项目安装方式

4.1 通过 Gemfile 安装

最常见的安装方式是通过 Gemfile 安装 FriendlyId。只需在 Gemfile 中添加以下代码并运行 bundle install：

gem 'friendly_id', '~> 5.5.0'

4.2 手动安装

你也可以手动安装 FriendlyId，只需在终端中运行以下命令：

gem install friendly_id -v 5.5.0

4.3 使用 Bundler 安装

如果你使用 Bundler 管理依赖，可以通过以下命令安装：

bundle add friendly_id

通过以上步骤，你可以成功安装并使用 FriendlyId 来为你的 Rails 应用生成友好的 URL。