多租户指南

今天我们将深入探讨一个复杂但至关重要的主题：在多租户应用程序中利用 Meilisearch。通过本指南，高级和中级开发者将清楚地了解如何有效配置 Meilisearch 以管理多租户。

多租户：它是什么？

在多租户架构中，一个软件应用程序的单个实例为多个客户或“租户”提供服务。每个租户的数据都是隔离的，并且对其他租户不可见。

多租户用例

多租户的一个典型用例是软件即服务 (SaaS) 应用程序，其中多家公司共享同一个数据库。每家公司都成为一个租户，其数据不应被其他公司访问。在这种情况下，您很可能已经在您的主数据存储中实现了这种特性。

使用 Meilisearch 实现多租户：终极方法

虽然使用 Meilisearch 为每家公司创建一个索引是可能的，但出于性能原因不推荐这样做。Meilisearch 会逐个索引处理任务，无法最大限度地提高索引吞吐量，因为它不能并行处理不同索引上的任务。

相反，最好的方法是将所有租户放在同一个索引中，并使用Meilisearch 强大的租户令牌来限制对特定用户范围的访问。为此，存储的文档不仅应包含ID，还应包含公司标识符，以便按公司区分用户。

为多租户准备 Meilisearch

让我们用一个类似于 Slack 应用程序的例子来说明这一点。在这个应用程序中，用户属于一家公司，每个用户可以在不同的线程中创建文本消息。我们的目标是创建一个包含所有消息的索引，但只允许特定公司的用户访问其公司的消息。随后，我们可能希望对用户和线程应用过滤器进行搜索。

首先，我们需要转换数据，使其最适合 Meilisearch 索引。以下是一个示例文档的格式：

{
	"id": 48735873,
	"user":{
		"id": 5749,
		"name": "bob"
	},
	"company": {
		"id": 838,
		"name": "Acme Inc"
	},
	"thread": "meilisearch-is-awesome",
	"data": "Meilisearch is so easy to use! 🔥",
	"created_at": 1543230000
}

接下来，您需要创建一个消息索引并添加以下设置：

{
  "displayedAttributes": [
    "id",
		"user.name",
		"thread",
		"data",
		"created_at"
  ],
  "searchableAttributes": [
    "data"
  ],
  "filterableAttributes": [
		"user.name",
		"company.id",
		"thread"
	],
  "sortableAttributes": [
		"created_at"
	]
}

以下是每个设置的功能：

• displayedAttributes：这些是将在您应用程序的搜索结果中显示的属性。出于安全原因，我们省略了 user.id 和 company.id，并且 company.name 没有必要，因为用户已经知道他们所属的公司。
• searchableAttributes：这些是搜索功能将使用的属性。在我们的例子中，只有 data（或消息文本）是可搜索的。
• filterableAttributes：这些是您可以用于过滤的属性。我们包含了 company.id 用于租户令牌，user.name 和 thread 用于即时过滤。
• sortableAttributes：这些是您可以用于排序的属性。我们只包含了 created_at，因为您可能希望按时间顺序排序消息。

创建租户令牌

配置好 Meilisearch 后，下一步是为每家公司创建一个新的租户令牌。如果您没有特殊的安全顾虑，可以省略过期日期以简化您的入门流程。

租户令牌的关键部分是 searchRules。在我们的示例中，您将添加以下规则：

{
  "messages": {
    "filter": "company.id = 838"
  }
}

使用生成的令牌，您的搜索将根据 company.id 限制访问，因此用户将只能看到其公司内部的消息。

将此令牌存储在您的主数据存储（如 Postgres、MySQL 等）中。这种机制类似于 Stripe 等工具中使用的机制。

每次用户登录您的应用程序时，将此密钥加载到本地存储中并用于搜索，确保每个用户只能访问与其公司相关的数据。

结论

只要您了解如何正确构建数据并配置搜索属性，使用 Meilisearch 创建多租户应用程序就相当简单。通过遵循本指南，您可以确保您的应用程序提供安全、高效且用户友好的搜索体验。如果您有任何疑问，可以在 Discord 上加入我们。

使用 Meilisearch Cloud 提高生产力并简化开发。无需再进行服务器部署或手动更新。免费试用 14 天，无需信用卡。

了解更多 Meilisearch 相关内容，请订阅我们的新闻通讯。您可以通过查看我们的路线图和参与我们的产品讨论来了解更多关于我们产品的信息。

编程愉快！