使用自然键作为外键的Rails迁移实践

在数据库设计中，外键约束通常是通过主键来实现的。然而，在某些情况下，我们可能需要使用一个自然键（natural key）作为外键，而不是传统的自动递增的ID。在这篇博客中，我们将探讨如何在Rails中使用一个人类可读的唯一标识符（code）作为外键，来替代默认的ID列。

背景介绍

假设我们有一个tenants表，每个租户不仅有一个UUID作为主键，还有一个code字段，该字段是唯一索引的，且对人类来说更容易识别和记忆。我们希望在其他表中引用这个code而不是id，以便增强数据的可读性和可维护性。

问题描述

在尝试创建一个新的apps表时，初步的迁移代码如下：

classCreateApps<ActiveRecord::Migration[7.1]defchangecreate_table:apps,id::uuiddo|t|# 其他字段...t.references:tenant_code,type::string,index:true,foreign_key:{to_table::tenants}# 其他字段...endendend

然而，这段代码会导致以下错误：

PG::DatatypeMismatch: ERROR: foreign key constraint "fk_rails_899289dfd2" cannot be implemented DETAIL: Key columns "tenant_code_id" and "id" are of incompatible types: character varying and uuid.

错误的原因是Rails试图在apps表中创建一个名为tenant_code_id的列来引用tenants表的id字段，而不是直接使用code字段。

解决方案

要解决这个问题，我们需要避免使用Rails的references方法，因为它会根据Rails的约定来创建引用。相反，我们可以手动定义字段并添加外键约束：

classCreateApps<ActiveRecord::Migration[7.0]defchangecreate_table:appsdo|t|# 其他字段...t.string:tenant_code,null:false,index:true# 其他字段...endadd_foreign_key:apps,:tenants,column::tenant_code,primary_key::codeendend

这样做的效果是：

1. 创建一个名为tenant_code的字符串字段，确保其不为空并创建索引。
2. 添加一个外键约束，指向tenants表的code字段，而不是id字段。

注意事项

• 模型关联：在模型中，你需要相应地配置关联关系。例如，在App模型中，你可能需要这样定义：

classApp<ApplicationRecord belongs_to:tenant,foreign_key:'tenant_code',primary_key:'code'end

• 性能与约定：虽然使用自然键作为外键可以提高数据的可读性，但它打破了Rails的常规约定，这可能会在一些场景中带来性能问题或维护复杂性。因此，使用自然键前需要权衡利弊。

通过这种方式，我们成功地在Rails迁移中实现了使用code作为外键的目的，这对于某些特定需求来说是非常有价值的。