多租户应用技术文档

1. 安装指南

在开始使用Multitenant之前，请确保您的开发环境已满足以下要求：

• Ruby版本：建议使用与项目兼容的版本
• Rails版本：与Rails 3兼容
• 数据库：支持Rails框架的数据库系统

安装Multitenant：

通过将以下代码添加到您的Rails应用的Gemfile文件中，您可以安装Multitenant：

gem 'multitenant'

然后运行以下命令来安装Gem：

bundle install

确保在环境配置文件中（如config/application.rb），您已经包含了Multitenant：

config.autoload_paths += %W(#{config.root}/app/models/multitenant)

2. 项目的使用说明

Multitenant允许您在构建多租户应用程序时，防止未指定租户作用域的Model.all意外泄露数据给未授权的租户。

使用示例：

在您的模型中，首先确保您的模型与tenant建立了关联，并且加入了belongs_to_multitenant方法：

class User < ActiveRecord::Base
  belongs_to :tenant
  belongs_to_multitenant
  
  validates :email, uniqueness: true                    # 全局唯一性验证
  validates :alias, uniqueness: { scope: :tenant_id }   # 租户内唯一性验证
end

在执行查询或创建新对象时，您可以通过以下方式限定当前租户的作用域：

Multitenant.with_tenant current_tenant do
  # 在此块中的查询自动限定为当前租户
  User.all

  # 在此块中创建的新对象自动分配给当前租户
  User.create :name => 'Bob'
end

3. 项目API使用文档

• Multitenant.with_tenant(tenant): 将当前线程的所有数据库查询限制为只查找指定租户的对象。

4. 项目安装方式

项目的安装方式已在“安装指南”部分进行了说明。简要概括，您需要在Rails应用的Gemfile中添加Multitenant依赖，并通过bundle install命令进行安装。

确保在应用的配置中正确设置了autoload_paths，以便正确加载Multitenant的模型。