Migration 文件的命名规则

在 Rails 中，Migration 文件的命名规则非常重要，因为 Rails 会根据文件名自动推断出你要执行的操作。合理的命名不仅能让代码更易读，还能利用 Rails 的约定简化开发。

---

1. Migration 文件的基本命名规则

Migration 文件的命名格式为：

YYYYMMDDHHMMSS_migration_name.rb

• YYYYMMDDHHMMSS：时间戳，用于确保 Migration 文件的执行顺序。
• migration_name：描述 Migration 操作的名称，使用蛇形命名法（snake_case）。

示例：

20231010120000_add_title_to_posts.rb

---

2. Migration 名称的约定

Rails 会根据 Migration 名称自动推断出你要执行的操作。以下是常见的命名模式：

(1) 添加列

• 命名模式：AddColumnNameToTableName
• 示例：
  • 向 posts 表添加 title 列：

    rails generate migration AddTitleToPosts title:string
    

  • 生成的 Migration 文件：

    class AddTitleToPosts < ActiveRecord::Migration[7.0]
      def change
        add_column :posts, :title, :string
      end
    end
    

(2) 删除列

• 命名模式：RemoveColumnNameFromTableName
• 示例：
  • 从 posts 表删除 title 列：

    rails generate migration RemoveTitleFromPosts title:string
    

  • 生成的 Migration 文件：

    class RemoveTitleFromPosts < ActiveRecord::Migration[7.0]
      def change
        remove_column :posts, :title, :string
      end
    end
    

(3) 重命名列

• 命名模式：RenameColumnNameToNewColumnNameInTableName
• 示例：
  • 将 posts 表的 title 列重命名为 name：

    rails generate migration RenameTitleToNameInPosts
    

  • 生成的 Migration 文件：

    class RenameTitleToNameInPosts < ActiveRecord::Migration[7.0]
      def change
        rename_column :posts, :title, :name
      end
    end
    

(4) 创建表

• 命名模式：CreateTableName
• 示例：
  • 创建 posts 表：

    rails generate migration CreatePosts title:string body:text
    

  • 生成的 Migration 文件：

    class CreatePosts < ActiveRecord::Migration[7.0]
      def change
        create_table :posts do |t|
          t.string :title
          t.text :body
    
          t.timestamps
        end
      end
    end
    

(5) 删除表

• 命名模式：DropTableName
• 示例：
  • 删除 posts 表：

    rails generate migration DropPosts
    

  • 生成的 Migration 文件：

    class DropPosts < ActiveRecord::Migration[7.0]
      def change
        drop_table :posts
      end
    end
    

(6) 添加索引

• 命名模式：AddIndexToColumnNameInTableName
• 示例：
  • 为 posts 表的 title 列添加索引：

    rails generate migration AddIndexToTitleInPosts
    

  • 生成的 Migration 文件：

    class AddIndexToTitleInPosts < ActiveRecord::Migration[7.0]
      def change
        add_index :posts, :title
      end
    end
    

(7) 删除索引

• 命名模式：RemoveIndexFromColumnNameInTableName
• 示例：
  • 删除 posts 表的 title 列索引：

    rails generate migration RemoveIndexFromTitleInPosts
    

  • 生成的 Migration 文件：

    class RemoveIndexFromTitleInPosts < ActiveRecord::Migration[7.0]
      def change
        remove_index :posts, :title
      end
    end
    

(8) 添加外键

• 命名模式：AddForeignKeyToTableName
• 示例：
  • 向 posts 表添加 user_id 外键：

    rails generate migration AddForeignKeyToPosts user_id:integer
    

  • 生成的 Migration 文件：

    class AddForeignKeyToPosts < ActiveRecord::Migration[7.0]
      def change
        add_reference :posts, :user, foreign_key: true
      end
    end
    

---

3. 自定义 Migration 名称

如果你不想使用 Rails 的自动推断功能，可以自定义 Migration 名称，然后在生成的 Migration 文件中手动编写逻辑。

示例：

rails generate migration UpdatePostsPublishedAt

生成的 Migration 文件：

class UpdatePostsPublishedAt < ActiveRecord::Migration[7.0]
  def change
    # 手动编写逻辑
    add_column :posts, :published_at, :datetime
  end
end

---

4. 注意事项

• 时间戳：Rails 会自动为 Migration 文件名添加时间戳，确保 Migration 按顺序执行。
• 可逆性：尽量使用 change 方法而不是 up 和 down，因为 change 方法支持自动回滚。
• 命名一致性：遵循命名规则，确保代码的可读性和可维护性。

---

5. 总结

操作类型	命名模式	示例
添加列	AddColumnNameToTableName	AddTitleToPosts
删除列	RemoveColumnNameFromTableName	RemoveTitleFromPosts
重命名列	RenameColumnNameToNewColumnNameInTableName	RenameTitleToNameInPosts
创建表	CreateTableName	CreatePosts
删除表	DropTableName	DropPosts
添加索引	AddIndexToColumnNameInTableName	AddIndexToTitleInPosts
删除索引	RemoveIndexFromColumnNameInTableName	RemoveIndexFromTitleInPosts
添加外键	AddForeignKeyToTableName	AddForeignKeyToPosts

遵循这些命名规则，可以让你更高效地编写和管理 Rails Migration！