FriendlyId项目升级指南：从4.0迁移到5.1版本的最佳实践-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00052/article/details/148487317

FriendlyId项目升级指南：从4.0迁移到5.1版本的最佳实践

friendly_id FriendlyId is the “Swiss Army bulldozer” of slugging and permalink plugins for ActiveRecord. It allows you to create pretty URL’s and work with human-friendly strings as if they were numeric ids for ActiveRecord models. 项目地址: https://gitcode.com/gh_mirrors/fr/friendly_id

前言

FriendlyId作为Ruby on Rails项目中处理友好URL的经典解决方案，在5.x版本中进行了多项重要改进。本文将从技术角度深入解析版本升级的关键变化，帮助开发者顺利完成迁移工作。

版本5.1的核心改进

5.1版本虽然定位为错误修复版本，但由于可能影响现有应用行为，仍然采用了次版本号升级策略：

空白字符串处理：系统现在会明确拒绝将空白字符串作为slug使用，这有助于保持数据一致性
保留字处理优化：当首个候选slug被标记为保留字时，系统会继续尝试其他候选方案，而不是直接标记记录为无效
Rails 4.2兼容性：:finders模块现在完全兼容Rails 4.2版本

版本5.0的重大变更

1. 查找方式的变化

5.0版本最显著的改变是默认不再覆盖ActiveRecord的标准查找方法：

# 5.0版本必须显式调用
Restaurant.friendly.find('some-slug')

# 如需保持4.0的行为，需添加:finders模块
friendly_id :name, use: [:slugged, :finders]

这一改变使得ORM行为更加明确，避免了可能出现的意外行为。

2. 候选slug机制

引入革命性的候选slug列表功能，开发者可以定义多级备选方案：

def slug_candidates
  [
    :title,
    [:title, :author],
    [:title, :subtitle, :author]
  ]
end

系统会按顺序尝试这些组合，直到找到唯一可用的slug。这种方式比简单的序列后缀更加灵活可控。

3. 冲突处理机制

当slug冲突时，5.0版本不再使用数字序列(如some-title--2)，而是改用UUID后缀（如some-title-2bc08962）。虽然结果不够美观，但显著提高了并发环境下的可靠性。

4. 其他重要变更

序列分隔符：从双横线(--)改为单横线(-)
slug生成策略：保存记录时不再自动重新生成slug，需要显式设置slug=nil
全局配置：新增初始化文件生成器，便于集中管理配置
保留字列表：默认不再包含任何保留字，改为在初始化文件中配置
模块组合：:history和:scoped现在可以同时使用

迁移实践指南

初始化配置

运行生成命令创建初始化文件：

rails generate friendly_id --skip-migration

生成的config/initializers/friendly_id.rb文件包含详细的配置说明，可根据需要调整。

数据库迁移

如需同时使用:history和:scoped模块，需要执行以下迁移：

class AddScopeToSlugs < ActiveRecord::Migration
  def change
    add_column :friendly_id_slugs, :scope, :string
    remove_index :friendly_id_slugs, [:slug, :sluggable_type]
    add_index :friendly_id_slugs, [:slug, :sluggable_type]
    add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], unique: true
  end
end