Spring Boot 優雅實現多租戶架構

一、概述

1. 什麼是多租戶架構？

多租戶架構是指在一個應用中支持多個租戶（Tenant）同時訪問，每個租戶擁有獨立的資源和數據，並且彼此之間完全隔離。

通俗來說，多租戶就是把一個應用按照客戶的需求 “分割” 成多個獨立的實例，每個實例互不干擾。

2. 多租戶架構的優勢

• 更好地滿足不同租戶的個性化需求。

• 可以降低運維成本，減少硬件、網絡等基礎設施的投入。

• 節約開發成本，通過複用代碼，快速上線新的租戶實例。

• 增強了系統的可擴展性和可伸縮性，支持水平擴展，每個租戶的數據和資源均可管理和控制。

3. 實現多租戶架構的技術選擇

對於實現多租戶架構技術不是最重要的最重要的是正確的架構思路。但是選擇正確的技術可以更快地實現多租戶架構。

二、設計思路

1. 架構選型

基於 Java 開發多租戶應用推薦使用 Spring Boot 和 Spring Cloud。Spring Boot 能快速搭建應用並提供許多成熟的插件。Spring Cloud 則提供了許多實現微服務架構的工具和組件。

1.1 Spring Boot

使用 Spring Boot 可以簡化項目的搭建過程自動配置許多常見的第三方庫和組件，減少了開發人員的工作量。

@RestController
public class TenantController {

    @GetMapping("/hello")
    public String hello(@RequestHeader("tenant-id") String tenantId) {
        return "Hello, " + tenantId;
    }
}

1.2 Spring Cloud

在架構多租戶的系統時 Spring Cloud 會更加有用。Spring Cloud 提供了一些成熟的解決方案，如 Eureka、Zookeeper、Consul 等，以實現服務發現、負載均衡等微服務功能。

2. 數據庫設計

在多租戶環境中數據庫必須爲每個租戶分別存儲數據並確保數據隔離。我們通常使用以下兩種方式實現：

• 多個租戶共享相同的數據庫，每個表中都包含 tenant_id 這一列，用於區分不同租戶的數據。

• 爲每個租戶創建單獨的數據庫，每個數據庫內的表結構相同，但數據相互隔離。

3. 應用多租戶部署

爲了實現多租戶在應用部署時我們需要考慮以下兩個問題。

3.1 應用隔離

在多租戶環境中不同租戶需要訪問不同的資源，因此需要進行應用隔離。可以通過構建獨立的容器或虛擬機、使用命名空間等方式實現。Docker 就是一種非常流行的隔離容器技術。

3.2 應用配置

由於每個租戶都有自己的配置需求因此需要爲每個租戶分別設置應用配置信息，例如端口號、SSL 證書等等。這些配置可以存儲在數據庫中，也可以存儲在雲配置中心中。

4. 租戶管理

在多租戶系統中需要能夠管理不同租戶的數據和資源，同時需要爲每個租戶分配相應的權限。解決方案通常包括以下兩部分。

4.1 租戶信息維護

租戶信息的維護包括添加、修改、刪除、查詢等操作，要求能夠根據租戶名稱或租戶 ID 快速查找對應的租戶信息。

CREATE TABLE tenant (
    id BIGINT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(50) NOT NULL UNIQUE,
    description VARCHAR(255),
    created_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

4.2 租戶權限控制

在多租戶應用中必須爲每個租戶分別設置對系統資源的訪問權限。例如，A 租戶和 B 租戶不能訪問彼此的數據。

@EnableGlobalMethodSecurity(prePostEnabled = true)
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/api/tenant/**").hasRole("ADMIN")
                .anyRequest().authenticated()
                .and()
                .formLogin();
    }
    @Autowired
    public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(userDetailsService())
                .passwordEncoder(new BCryptPasswordEncoder())
                .and()
                .inMemoryAuthentication()
                .withUser("admin")
                .password(new BCryptPasswordEncoder().encode("123456"))
                .roles("ADMIN");
    }
}

三、技術實現

1. Spring Boot 中的多租戶實現

在 Spring Boot 中可以通過多數據源和動態路由來實現多租戶機制。

1.1 多數據源實現

多數據源是指爲不同的租戶配置不同的數據源，使得每個租戶都可以訪問自己的獨立數據。

具體實現方法如下：

@Configuration
public class DataSourceConfig {
    @Bean(name = "dataSourceA")
    @ConfigurationProperties(prefix = "spring.datasource.a")
    public DataSource dataSourceA() {
        return DataSourceBuilder.create().build();
    }
    @Bean(name = "dataSourceB")
    @ConfigurationProperties(prefix = "spring.datasource.b")
    public DataSource dataSourceB() {
        return DataSourceBuilder.create().build();
    }
    @Bean(name = "dataSourceC")
    @ConfigurationProperties(prefix = "spring.datasource.c")
    public DataSource dataSourceC() {
        return DataSourceBuilder.create().build();
    }
}

以上代碼是配置了三個數據源分別對應三個租戶。然後在使用時，可以使用註解標記需要連接的數據源。

@Service
public class ProductService {
    @Autowired
    @Qualifier("dataSourceA")
    private DataSource dataSource;
    // ...
}

1.2 動態路由實現

動態路由是指根據請求的 URL 或參數動態地切換到對應租戶的數據源。具體實現如下：

public class DynamicDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return TenantContextHolder.getTenantId();
    }
}
@Configuration
public class DataSourceConfig {
    @Bean(name = "dataSource")
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource dataSource() {
        return DataSourceBuilder.create().type(DynamicDataSource.class).build();
    }
}

以上是動態路由的核心代碼DynamicDataSource繼承自AbstractRoutingDataSource，通過determineCurrentLookupKey()方法動態獲得租戶 ID，然後切換到對應的數據源。

2. Spring Cloud 中的多租戶實現

在 Spring Cloud 中可以通過服務註冊與發現、配置中心、負載均衡等方式實現多租戶機制。

2.1 服務註冊與發現

使用 Spring Cloud 中的 Eureka 實現服務註冊與發現。每個租戶的服務都在註冊中心以不同的應用名稱進行註冊，客戶端可以通過服務名稱來訪問對應租戶的服務。

2.2 配置中心

使用 Spring Cloud Config 作爲配置中心。配置文件以租戶 ID 進行區分，客戶端通過讀取對應租戶的配置文件來獲取配置信息。

2.3 負載均衡

使用 Spring Cloud Ribbon 作爲負載均衡器。根據請求的 URL 或參數選擇對應租戶的服務實例進行請求轉發。

2.4 API

在 API 網關層面實現多租戶機制根據請求的 URL 或參數判斷所屬租戶，並轉發到對應租戶的服務實例。

四、 應用場景

1. 私有云環境

私有云環境指的是由企業自行搭建的雲環境，不對外提供服務，主要應用於企業內部的數據存儲、管理、共享和安全控制。相較於公有云，私有云的優點在於可以更好地保護企業核心數據，同時也能夠滿足企業對於數據安全性和可控性的要求。

2. 公有云環境

公有云環境指的是由雲服務商搭建並對外提供服務的雲環境，用戶可以根據需要購買相應的雲服務，如雲存儲、雲計算、雲數據庫等。相較於私有云，公有云的優點在於具有成本低廉、彈性伸縮、全球化部署等特點，能夠更好地滿足企業快速發展的需求。

3. 企業級應用

企業級應用是指面向企業客戶的應用程序，主要包括 ERP、CRM、OA 等一系列應用系統。這類應用的特點在於功能強大、流程複雜、數據量大，需要滿足企業的高效率、高可靠性、高安全性和易維護性等要求。在雲計算環境下，企業可以將這些應用部署在私有云或公有云上，減少了硬件設備的投入和維護成本，提高了管理效率。

五、實現步驟

1. 搭建 Spring Boot 和 Spring Cloud 環境

首先需要在 Maven 項目中引入以下依賴：

<!-- Spring Boot -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- Spring Cloud -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-dependencies</artifactId>
    <version>2020.0.3</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

然後需要在 application.yml 中配置相應的參數，如下所示：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/appdb?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: 123456

mybatis:
  type-aliases-package: com.example.demo.model
  mapper-locations: classpath:mapper/*.xml

server:
  port: 8080

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

management:
  endpoints:
    web:
      exposure:
        include: "*"

其中datasource.url爲數據庫連接的 URL，username 和 password 爲數據庫連接的賬號和密碼；server.port爲 Spring Boot 應用啓動的端口；eureka.client.serviceUrl.defaultZone爲 Eureka 服務註冊中心的 URL。

2. 修改數據庫設計

接下來需要對數據庫進行相應的修改，以支持多租戶部署。具體來說，我們需要在數據庫中添加一個與租戶相關的字段，以便在應用中區分不同的租戶。

3. 實現應用多租戶部署

接着需要在代碼中實現應用的多租戶部署功能。具體來說，我們需要爲每個租戶實例化對應的 Spring Bean，並根據租戶 ID 將請求路由到相應的 Bean 中去處理。

以下是一個簡單的實現示例：

@Configuration
public class MultiTenantConfig {
 
    // 提供對應租戶的數據源
    @Bean
    public DataSource dataSource(TenantRegistry tenantRegistry) {
        return new TenantAwareDataSource(tenantRegistry);
    }
 
    // 多租戶Session工廠
    @Bean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource)
            throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        return sessionFactory.getObject();
    }
 
    // 動態切換租戶
    @Bean
    public MultiTenantInterceptor multiTenantInterceptor(TenantResolver tenantResolver) {
        MultiTenantInterceptor interceptor = new MultiTenantInterceptor();
        interceptor.setTenantResolver(tenantResolver);
        return interceptor;
    }
 
    // 註冊攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(multiTenantInterceptor());
    }
 
    // 註冊租戶信息
    @Bean
    public TenantRegistry tenantRegistry() {
        return new TenantRegistryImpl();
    }
     
    // 解析租戶ID
    @Bean
    public TenantResolver tenantResolver() {
        return new HeaderTenantResolver();
    }
 
}

其中MultiTenantConfig是多租戶部署的核心配置類，它提供了對應租戶數據源、多租戶 Session 工廠、動態切換租戶等功能。

4. 實現租戶管理

最後需要實現一個租戶管理的功能，以便在系統中管理不同的租戶。具體來說，我們可以使用 Spring Cloud 的服務註冊與發現組件 Eureka 來註冊每個租戶的實例，並在管理界面中進行相應的操作。另外，我們還需要爲每個租戶提供一個獨立的數據庫，以保證數據隔離性。

六、小結回顧

本文詳細介紹瞭如何使用 Spring Boot 和 Spring Cloud 實現一個支持多租戶部署的應用。主要包括搭建 Spring Boot 和 Spring Cloud 環境、修改數據庫設計、實現應用多租戶部署、實現租戶管理等方面。

應用場景主要包括 SaaS 應用、多租戶雲服務等。優劣勢主要體現在提升了應用的可擴展性和可維護性，但也增加了部署和管理的複雜度。未來的改進方向可以考慮進一步提升多租戶管理的自動化程度，減少人工干預和錯誤率。

作者：格林希爾

來源：blog.csdn.net/u010349629/article/details/130737253

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/Vv3TSVuWO0-jQRXa8PLsnA