{"id":26431,"date":"2017-02-28T11:47:35","date_gmt":"2017-02-28T11:47:35","guid":{"rendered":"https:\/\/dev.railscarma.com\/multi-tenancy-using-apartment-gem\/"},"modified":"2024-01-10T12:57:15","modified_gmt":"2024-01-10T12:57:15","slug":"multi-tenancy-using-apartment-gem","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/ja\/%e3%83%96%e3%83%ad%e3%82%b0\/%e6%8a%80%e8%a1%93%e8%ab%96%e6%96%87\/multi-tenancy-using-apartment-gem\/","title":{"rendered":"\u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8\u30b8\u30a7\u30e0\u3092\u4f7f\u7528\u3057\u305f\u30de\u30eb\u30c1\u30c6\u30ca\u30f3\u30b7\u30fc"},"content":{"rendered":"
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

\u307e\u305a\u30b7\u30f3\u30b0\u30eb\u30c6\u30ca\u30f3\u30c8\u3068\u30de\u30eb\u30c1\u30c6\u30ca\u30f3\u30c8\u306e\u9055\u3044\u3092\u7406\u89e3\u3057\u307e\u3057\u3087\u3046
\n
\n\u30b7\u30f3\u30b0\u30eb\u30c6\u30ca\u30f3\u30b7\u30fc<\/strong>:<\/p>\n

\u3059\u3079\u3066\u306e\u9867\u5ba2\u306f\u72ec\u81ea\u306e\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2 \u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u3001\u72ec\u81ea\u306e DB \u3092\u6301\u3061\u3001\u305d\u308c\u306f 1 \u4eba\u306e\u9867\u5ba2\u306b\u306e\u307f\u30b5\u30fc\u30d3\u30b9\u3092\u63d0\u4f9b\u3057\u307e\u3059\u3002\u3053\u3053\u3067\u3001\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u306f\u72ec\u7acb\u3057\u3066\u3044\u308b\u305f\u3081\u3001\u7279\u5b9a\u306e\u9867\u5ba2\u8981\u4ef6\u3092\u6e80\u305f\u3059\u3088\u3046\u306b\u30ab\u30b9\u30bf\u30de\u30a4\u30ba\u3067\u304d\u307e\u3059\u3002<\/p>\n


\n\u30de\u30eb\u30c1\u30c6\u30ca\u30f3\u30c8:<\/strong><\/p>\n

\u3053\u306e\u5834\u5408\u3001\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2 \u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u306e\u5358\u4e00\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u304c\u8907\u6570\u306e\u9867\u5ba2\u306b\u30b5\u30fc\u30d3\u30b9\u3092\u63d0\u4f9b\u3057\u307e\u3059\u3002\u3053\u3053\u3067\u306f\u3001\u5404\u9867\u5ba2\u3092\u30c6\u30ca\u30f3\u30c8\u3068\u547c\u3073\u307e\u3059\u3002\u3053\u3053\u3067\u306f\u3001UI \u30eb\u30fc\u30eb\u3068\u30d3\u30b8\u30cd\u30b9 \u30eb\u30fc\u30eb\u3092\u5909\u66f4\u3067\u304d\u307e\u3059\u304c\u3001\u540c\u3058\u30a2\u30fc\u30ad\u30c6\u30af\u30c1\u30e3\u304c\u8907\u6570\u306e\u9867\u5ba2\u306b\u3088\u3063\u3066\u5171\u6709\u3055\u308c\u3066\u3044\u308b\u305f\u3081\u3001\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3 \u30b3\u30fc\u30c9\u3092\u5909\u66f4\u3059\u308b\u3053\u3068\u306f\u3067\u304d\u307e\u305b\u3093\u3002\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u306e\u958b\u767a\u8cbb\u3084\u4fdd\u5b88\u8cbb\u3092\u304a\u5ba2\u69d8\u3067\u5206\u62c5\u3059\u308b\u305f\u3081\u7d4c\u6e08\u7684\u3067\u3059\u3002\u305f\u3060\u3057\u3001\u66f4\u65b0\u306f\u30d7\u30ed\u30d0\u30a4\u30c0\u30fc\u306e\u307f\u304c\u884c\u3046\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002<\/p>\n

\"singletenant-multitenant\"<\/a>
\n\u5229\u70b9: <\/strong>
\n1. Single hardware that manages multiple customers.
\n2. Cost savings. Cost can be shared between all the customers.
\n3. Easy maintenance
\n4. Configuration can be changed without touching codebase.
\n5. New tenants can be added easily since it is a shared architecture.<\/p>\n

\u77ed\u6240:<\/strong>
\nDB customization will be difficult to handle since it is a single DB shared between multiple customers with different tenants.<\/p>\n

There are milia, acts_as_tenant and apartment gem to handle multi-tenancy in the Rails application.<\/p>\n

\u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8\u30b8\u30a7\u30e0:<\/strong><\/p>\n

\u3053\u306e gem \u306f\u3001\u30de\u30eb\u30c1\u30c6\u30ca\u30f3\u30b7\u30fc\u306b\u5bfe\u51e6\u3059\u308b\u305f\u3081\u306b\u5225\u306e\u65b9\u6cd5\u3092\u63a1\u7528\u3057\u3066\u3044\u307e\u3059\u3002\u30c6\u30ca\u30f3\u30c8\u3054\u3068\u306b\u5225\u306eDB\u3092\u4f5c\u6210\u3059\u308b\u3053\u3068\u3067\u6a5f\u80fd\u3057\u307e\u3059\u3002 PostgreSql \u306e\u5834\u5408\u3001\u30c6\u30ca\u30f3\u30c8\u3054\u3068\u306b\u5225\u306e\u30b9\u30ad\u30fc\u30de\u304c\u4f5c\u6210\u3055\u308c\u307e\u3059\u3002\u3053\u306e\u72b6\u6cc1\u3067\u306f\u60c5\u5831\u304c\u5b9f\u969b\u306b\u906e\u65ad\u3055\u308c\u3066\u3044\u308b\u3068\u3044\u3046\u4e8b\u5b9f\u3092\u8003\u616e\u3059\u308b\u3068\u3001\u79c1\u306f\u3053\u306e\u30a2\u30d7\u30ed\u30fc\u30c1\u304c\u6c17\u306b\u5165\u3063\u3066\u3044\u307e\u3059\u3002\u30c7\u30fc\u30bf\u30d9\u30fc\u30b9\u306f\u5171\u6709\u3055\u308c\u306a\u3044\u305f\u3081\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8\u306e\u60c5\u5831\u3092\u6d88\u53bb\u3059\u308b\u5fc5\u8981\u304c\u3042\u308b\u5834\u5408\u306f\u3001\u30c7\u30fc\u30bf\u30d9\u30fc\u30b9 (\u307e\u305f\u306f\u30d1\u30bf\u30fc\u30f3) \u3092\u524a\u9664\u3059\u308b\u3060\u3051\u3067\u6e08\u307f\u307e\u3059\u3002\u307e\u305f\u3001\u30a8\u30ec\u30d9\u30fc\u30bf\u30fc\u3082\u30b5\u30dd\u30fc\u30c8\u3057\u3066\u304a\u308a\u3001\u9867\u5ba2\u306e\u30c6\u30ca\u30f3\u30c8\u9593\u306e\u81ea\u52d5\u5207\u308a\u66ff\u3048\u304c\u53ef\u80fd\u306b\u306a\u308a\u3001\u305d\u308c\u306b\u3088\u3063\u3066\u5207\u308a\u66ff\u3048\u30ed\u30b8\u30c3\u30af\u304c\u81ea\u52d5\u5316\u3055\u308c\u307e\u3059\u3002<\/p>\n

This gem helps us to deal with multi tenancy in Rails application.<\/p>\n

Add the line below, to your Gemfile and perform bundle install.<\/p>\n

\u5b9d\u77f3\u306e\u300c\u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8\u300d<\/code><\/pre>\n
\u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8\u521d\u671f\u5316\u30d5\u30a1\u30a4\u30eb\u3092\u751f\u6210\u3059\u308b\u306b\u306f\u3001\u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3092\u5b9f\u884c\u3057\u307e\u3059\u3002<\/p>\n
Bundle exec Rails \u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8\u306e\u751f\u6210:\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb<\/code><\/pre>\n
config.excluded_models = %w{ \u30c6\u30ca\u30f3\u30c8 } <\/code><\/pre>\n
Here, we can specify the tenants which are of global scope, such as the Authentication model which is a common one for all the tenants.<\/p>\n
Here, I will be creating a Customer with subdomains, so, whenever customer logs in to the application, apartment fetches the subdomains and will query the database, based on tenant subdomain.<\/p>\n
Rails g scaffold \u9867\u5ba2\u540d:string tenant_domain:string<\/code><\/pre>\n
\u3059\u308b<\/p>\n
Rails \u30c7\u30fc\u30bf\u30d9\u30fc\u30b9:\u79fb\u884c<\/code><\/pre>\n
\u9867\u5ba2\u3092\u4f5c\u6210\u3057\u305f\u3089\u3001\u30a2\u30d1\u30fc\u30c8\u306e\u30c6\u30ca\u30f3\u30c8\u3092\u4f5c\u6210\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002<\/p>\n
Apartment::Tenant.create('tenant_name') - \u30c6\u30ca\u30f3\u30c8\u3092\u4f5c\u6210\u3059\u308b\u306b\u306f<\/code><\/pre>\n
\u30e2\u30c7\u30eb\u3067 after_create \u30b3\u30fc\u30eb\u30d0\u30c3\u30af\u3092\u4f7f\u7528\u3057\u3066\u30c6\u30ca\u30f3\u30c8\u3092\u4f5c\u6210\u3057\u307e\u3059\u3002<\/p>\n
def create_tenant Apartment::Tenant.create(tenant_domain) end<\/code><\/pre>\n
Once the above callback gets executed, all the migrations will run under that respective tenant.<\/p>\n
Switching of subdomains will be handled automatically when we request the application with subdomains. Below is the configuration line to switch the tenants based on subdomain.<\/p>\n
Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'<\/code><\/pre>\n
\u30c6\u30ca\u30f3\u30c8\u3092\u5207\u308a\u66ff\u3048\u308b\u306b\u306f<\/p>\n
\u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8::\u30c6\u30ca\u30f3\u30c8.\u30b9\u30a4\u30c3\u30c1!('\u30c6\u30ca\u30f3\u30c8\u540d')<\/code><\/pre>\n
All your ActiveRecord queries will be routed to the specific tenant when switch is called for.
\nSwitch will be in the root scope when you call with no arguments.<\/p>\n
Even tenant switch can be done based on the first subdomain but we need to set config in the initializer file. We can even exclude some subdomains here, such as the normal subdomain.<\/p>\n
config.middleware.use 'Apartment::Elevators::FirstSubdomain'<\/code><\/pre>\n
Apartment::Elevators::FirstSubdomain.excluded_subdomains = ['www']<\/code><\/pre>\n
We can also restrict the users not to create some domains such as www, admin. These domains will not be available for the users while they were being registered.<\/p>\n
Need to uncomment below config line in the apartment initializer file.<\/p>\n
Apartment::Elevators::Subdomain.excluded_subdomains = ["public"\u3001"www"\u3001\u304a\u3088\u3073 "admin" ]<\/code><\/pre>\n
\u5b8c\u5168\u306a\u30db\u30b9\u30c8\u306b\u57fa\u3065\u3044\u3066\u5207\u308a\u66ff\u3048\u308b\u3053\u3068\u3082\u3067\u304d\u307e\u3059\u3002\u3053\u3053\u3067\u306f\u3001\u6b21\u306e\u69cb\u6210\u884c\u3092\u4f7f\u7528\u3057\u3066\u3001\u30cf\u30c3\u30b7\u30e5\u5185\u306e\u5bfe\u5fdc\u3059\u308b\u30c6\u30ca\u30f3\u30c8\u540d\u3092\u898b\u3064\u3051\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002\u4ee5\u4e0b\u306e\u884c\u3092 application.rb \u306b\u8ffd\u52a0\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002<\/p>\n
config.middleware.use 'Apartment::Elevators::HostHash', {'example.com' => 'example_tenant'}<\/code><\/pre>\n
\u30c6\u30ca\u30f3\u30c8\u3092\u524a\u9664\u3057\u307e\u3059\u3002<\/strong><\/p>\n
\u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3092\u4f7f\u7528\u3057\u3066\u30c6\u30ca\u30f3\u30c8\u3092\u524a\u9664\u3067\u304d\u307e\u3059\u3002<\/p>\n
\u30a2\u30d1\u30fc\u30c8\u30e1\u30f3\u30c8::\u30c6\u30ca\u30f3\u30c8.drop('\u30c6\u30ca\u30f3\u30c8\u540d')<\/code><\/pre>\n
\u3055\u3089\u306b\u591a\u304f\u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u898b\u3064\u3051\u308b\u306b\u306f\u3001gem \u516c\u5f0f\u30ea\u30bd\u30fc\u30b9\u3092\u78ba\u8a8d\u3057\u3066\u304f\u3060\u3055\u3044\u3002 <\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\u6700\u65b0\u306e\u30a2\u30c3\u30d7\u30c7\u30fc\u30c8\u3092\u8cfc\u8aad\u3059\u308b<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t
\t\t\t\t\t