Spring BootでマルチテナントSaaSプラットフォームを構築するコア技術についてお話しします

[[326138]]

1. 概要

筆者は、2014年よりマルチテナント（またはマルチテナント）のソフトウェアアプリケーションプラットフォームであるSaaS（Software as a Service）に携わり、関連分野のアーキテクチャ設計や研究開発業務に従事してきました。偶然にも、学部の卒業プロジェクト中に、SaaS ベースの効率的な財務管理プラットフォームに関する研究プロジェクトを完了し、そこから多くのことを得ることができました。私が初めてSaaSに触れた頃、中国には関連リソースが不足しており、参考資料は「インターネット時代のソフトウェア革命：SaaSアーキテクチャ設計」（Ye Wei他著）という書籍のみでした。最終的なプロジェクトは、OSGI (Open Service Gateway Initiative) Java 動的モジュラー システム仕様に基づいて実装されます。

それから5年が経ち、ソフトウェア開発技術は大きな変化を遂げました。著者が実装した SaaS プラットフォームのテクノロジー スタックも数回更新されており、「出口がないように見えるときでも、振り返れば出口が見つかる」という格言をまさに証明しています。これまでに遭遇した多くの回り道や落とし穴、そして最近多くのネットユーザーから Spring Boot を使用してマルチテナント システムを実装する方法を尋ねられたという事実に基づいて、SaaS のハードコア技術について語る記事を書くことにしました。

SaaS といえば、それは単なるソフトウェア アーキテクチャです。それほど謎めいたところはなく、非常に難しいシステムでもありません。私個人としては、SaaS プラットフォームの難しさは技術的な実装ではなく、商業的な運用にあると感じています。技術的に言えば、SaaS は、複数の異なる環境のユーザーが同じアプリケーション セットを使用できるようにしながら、ユーザー間のデータが互いに分離されていることを保証するアーキテクチャ モデルです。考えてみれば、これもシェアリングエコノミーの雰囲気が少しありますね。

ここでは、SaaS ソフトウェア成熟モデルとデータ分離ソリューションの比較については詳しく説明しません。本日は、Spring Boot を使用して、独立データベース/共有データベース独立スキーマを備えたマルチテナント システムを迅速に構築する方法について説明します。私は SaaS システムのコア技術実装を提供し、興味のある友人はこれを基に拡張することができます。

2. マルチテナントのアプリケーションシナリオを理解する

アプリケーションを開発する必要があり、同じアプリケーションを N 人の顧客に販売したいとします。通常の状況では、N 台の Web サーバー (Tomcat)、N 台のデータベース (DB) を作成し、N 人の顧客に対して同じアプリケーションを N 回展開する必要があります。ここで、アプリケーションがアップグレードされたり、その他の変更が行われたりすると、N 個のアプリケーションを更新し、N 個のサーバーを保守する必要があります。次に、ビジネスが成長し、顧客数が当初の N から現在の N+M に増加すると、N 個のアプリケーションと M 個のアプリケーション バージョンの維持、機器のメンテナンス、コスト管理という問題に直面することになります。運用保守スタッフはコンピューター室で泣きそうになりました...

上記の問題を解決するには、マルチテナント アプリケーションを開発し、現在のユーザーに基づいて対応するデータベースを選択します。たとえば、A 社のユーザーからリクエストが来ると、アプリケーションは A 社のデータベースに接続します。 B 社のユーザーからリクエストが来ると、アプリケーションは自動的にデータベースを B 社のデータベースに切り替えます。理論的には問題はありませんが、既存のアプリケーションを SaaS モードに変換することを検討すると、最初の問題に遭遇します。それは、リクエストがどのテナントから送信されたかをどのように識別するかということです。データソースを自動的に切り替えるにはどうすればいいですか?

3. テナントデータソースの維持、識別、ルーティング

データベース名、リンクアドレス、ユーザー名、パスワードなどのテナント情報を保存するための独立したライブラリを提供できるため、テナント情報のメンテナンスの問題を統一的に解決できます。テナントの識別とルーティングを解決する方法は多数あります。一般的な方法をいくつか紹介します。

• 1. テナントはドメイン名で識別できます。各テナントに一意の第 2 レベル ドメイン名を提供し、それを通じてテナントを識別できます (例: tenantone.example.com、tenant.example.com)。 tenantone と tenant は、テナントを識別するための重要な情報です。
• 2. テナント情報は、saas.example.com?tenantId=tenant1、saas.example.com?tenantId=tenant2 のように、サーバーがテナントを識別できるようにサポートするために、リクエスト パラメーターとしてサーバーに渡すことができます。パラメーター tenantId は、アプリケーションがテナントを識別するための重要な情報です。
• 3. テナント情報は、JWT などのテクノロジーを使用してリクエスト ヘッダーに設定できます。サーバーは、ヘッダー内の関連パラメータを解析してテナント情報を取得します。
• 4. ユーザーがシステムに正常にログインすると、テナント情報はセッションに保存され、必要に応じてセッションから取得されます。

上記の問題を解決した後、クライアントから渡されたテナント情報を取得する方法と、ビジネス コードでテナント情報を使用する方法を見てみましょう (最も重要な問題は DataSources の問題です)。

Spring Boot アプリケーションを起動する前に、データ ソース (データベースが使用されている場合) に関する構成情報を提供する必要があることは誰もが知っています。初期要件によると、アプリケーションを使用する必要がある顧客は N 人いるので、事前に N 個のデータ ソース (複数のデータ ソース) を構成する必要があります。 N<50であれば、まだ許容できると思います。それ以上であれば、明らかに受け入れられません。この問題を解決するには、Hibernate 5 が提供する動的データ ソース機能を使用して、アプリケーションがクライアント データ ソースを動的に構成できるようにする必要があります。簡単に言うと、ユーザーがシステム リソースを要求すると、ユーザーが提供するテナント情報 (tenantId) を ThreadLoacal に保存し、TheadLocal でテナント情報を取得し、この情報に基づいて別のテナント ライブラリを照会して、現在のテナントのデータ構成情報を取得します。次に、データ ソースを動的に構成する Hibernate の機能を利用して、現在のリクエストのデータ ソースを設定し、最後に前のユーザーのリクエストのデータ ソースを設定します。この方法では、アプリケーション内でデータ ソース構成情報 (テナント データベース構成ライブラリ) のコピーを 1 つだけ保持すればよく、残りのデータ ソースは動的にクエリおよび構成されます。次に、この機能を簡単に説明します。

4. プロジェクトの構築

このデモ プロジェクトを実装するには、Spring Boot 2.1.5 を使用します。まず、Maven 構成ファイルに次の構成を追加する必要があります。

 <依存関係>
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>スプリングブートスターター</artifactId>
        </依存関係> 
 
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>ランタイム</scope>
        </依存関係>
        <依存関係>
            <groupId>org.projectlombok</groupId>
            <artifactId>ロンボク</artifactId>
            <オプション> true </オプション>
        </依存関係>
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>テスト</scope>
        </依存関係>
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </依存関係>
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </依存関係>
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </依存関係>
        <依存関係>
            <グループID>mysql</グループID>
            <artifactId>mysql-コネクタ-java</artifactId>
            <バージョン>5.1.47</バージョン>
        </依存関係>
        <依存関係>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </依存関係>
        <依存関係>
            <グループ ID>org.apache.commons</グループ ID>
            <artifactId>コモンズ-lang3</artifactId>
        </依存関係>
    </依存関係>

次に、利用可能な構成ファイルを提供し、次のコンテンツを追加します。

春：
  フリーマーカー:
    キャッシュ: false  
    テンプレートローダーパス:
    - クラスパス:/テンプレート/
    プレフィックス:
    サフィックス: .html
  リソース：
静的場所:
    - クラスパス:/ static /
  開発ツール:
    再起動：
      有効: true  
  jp: 日本語:
データベース: MySQL
    表示SQL: true  
    生成DDL: false  
    休止状態:
      ddl-auto: なし
ウナ:
  マスター：
    データソース:
      URL: jdbc:mysql://localhost:3306/master_tenant?useSSL= false  
      ユーザー名: root
パスワード: root
      ドライバークラス名: com.mysql.jdbc.Driver
      最大プールサイズ: 10
      アイドルタイムアウト: 300000
      最小アイドル: 10
      プール名: マスター -データベース-接続- プール
ログ記録:
レベル：
    ルート:警告
    組織:
      スプリングフレームワーク:
        ウェブ:デバッグ
      休止状態:デバッグ

Freemarkerはビューレンダリングエンジンとして使用されるため、Freemarker関連の技術を提供する必要がある。

una:master:datasource 設定項目は、テナント情報を一元的に格納する前述のデータ ソース設定情報です。これをマスター データベースと考えることができます。

次に、Spring Boot の自動データ ソース構成機能をオフにし、プロジェクトのメイン クラスに次の設定を追加する必要があります。

 @SpringBootApplication({DataSourceAutoConfiguration.class} を除外)
パブリッククラス UnaSaasApplication { 
 
公共 静的void main(String[] args) {
        SpringApplication.run(UnaSaasApplication.class、引数);
    } 
 
 }

最後に、プロジェクト全体の構造を見てみましょう。

5. テナントデータソースクエリモジュールを実装する

テナント名、データベース接続アドレス、ユーザー名、パスワードなどを含むテナント データ ソース情報を格納するエンティティ クラスを定義します。コードは次のとおりです。

 @データ
@実在物
@テーブル(名前= "MASTER_TENANT" )
 @NoArgsコンストラクタ
@AllArgsコンストラクタ
@ビルダー
パブリッククラスMasterTenantはSerializableを実装します{ 
 
    @ID
    @列(名前= "ID" )
    プライベート文字列ID; 
 
    @列(名前= "TENANT" )
    @NotEmpty(message = "テナント識別子を指定する必要があります" )
    プライベート文字列テナント; 
 
    @列(名前= "URL" )
    @サイズ(最大= 256)
    @NotEmpty(message = "テナントのJDBC URLを指定する必要があります" )
    プライベート文字列 URL; 
 
    @列(名前= "ユーザー名" )
    @サイズ(最小= 4、最大= 30、メッセージ = "db ユーザー名の長さは 4 から 30 の間でなければなりません" )
    @NotEmpty(message = "テナント DB ユーザー名を指定する必要があります" )
    プライベート文字列ユーザー名; 
 
    @列(名前= "パスワード" )
    @サイズ(最小= 4、最大= 30 )
    @NotEmpty(message = "テナント DB パスワードを入力する必要があります" )
    プライベート文字列パスワード; 
 
    @バージョン
    プライベートintバージョン = 0;
 }

永続化レイヤーでは、JpaRepository インターフェースを継承して、データ ソースに対して CURD 操作を迅速に実装します。同時に、テナント名でテナント データ ソースを検索するためのインターフェイスも提供します。コードは次のとおりです。

パッケージ com.ramostear.una.saas.master.repository; 
 
 com.ramostear.una.saas.master.model.MasterTenant をインポートします。
 org.springframework.data.jpa.repository.JpaRepository をインポートします。
 org.springframework.data.jpa.repository.Query をインポートします。
 org.springframework.data.repository.query.Param をインポートします。
 org.springframework.stereotype.Repository をインポートします。 
 
 /**
 * @author : Tan Chaohong (別名:ramostear)によって作成されました
 * @作成日時2019/5/25 0025-8:22
 * @修正する による：
 * @以来：
 */
 @リポジトリ
パブリックインターフェースMasterTenantRepositoryはJpaRepository<MasterTenant,String>を拡張します{ 
 
    @Query( "MasterTenant p から p を選択し、p.tenant = :tenant の場合" )
    マスターテナント findByTenant(@Param( "tenant" ) String テナント);
 }

ビジネス レイヤーは、テナント名でテナント データ ソース情報を取得するためのサービスを提供します (他のサービスはユーザーが追加できます)。

パッケージ com.ramostear.una.saas.master.service; 
 
 com.ramostear.una.saas.master.model.MasterTenant をインポートします。 
 
 /**
 * @author : Tan Chaohong (別名:ramostear)によって作成されました
 * @作成日時2019/5/25 0025-8:26
 * @修正する による：
 * @以来：
 */ 
 
パブリックインターフェースMasterTenantService {
    /**
     * カスタムテナント名クエリの使用
     * @param テナント テナント名 
     * @マスターテナントを返す
     */
    マスターテナント findByTenant(String テナント);
 }

最後に、重点を置く必要がある主なポイントは、プライマリ データ ソースを構成することです (Spring Boot は、そのためのデフォルトのデータ ソースを提供する必要があります)。設定する前に、設定項目を取得する必要があります。 @ConfigurationProperties("una.master.datasource") を通じて、構成ファイル内の関連する構成情報を取得できます。

 @ゲッター
@セッター
@構成
@ConfigurationProperties( "una.master.datasource" )
パブリッククラスMasterDatabaseProperties { 
 
    プライベート文字列 URL; 
 
    プライベート文字列パスワード; 
 
    プライベート文字列ユーザー名; 
 
    プライベート文字列driverClassName; 
 
    プライベート長い接続タイムアウト; 
 
    プライベートint maxPoolSize; 
 
    プライベート長いidleTimeout; 
 
    プライベートint minIdle; 
 
    プライベート文字列 poolName; 
 
    @オーバーライド
パブリック文字列toString(){
        StringBuilder ビルダー = new StringBuilder();
        ビルダー.append( "マスターデータベースプロパティ [ url=" )
                .append(URL) を追加します。
                .append( ", ユーザー名=" )
                .append(ユーザー名)
                .append( ", パスワード=" )
                .append(パスワード)
                .append( ", ドライバークラス名=" )
                .append(ドライバークラス名)
                .append( ", 接続タイムアウト=" )
                .append(接続タイムアウト)
                .append( ", maxPoolSize=" )
                .append(最大プールサイズ)
                .append( ", アイドルタイムアウト=" )
                .append(アイドルタイムアウト)
                .append( ", minIdle=" )
                .append(最小アイドル)
                .append( ", プール名=" )
                .append(プール名)
                .append( "]" );
 builder.toString()を返します。
    }
 }

次のステップは、カスタム データ ソースを構成することです。ソースコードは次のとおりです。

パッケージ com.ramostear.una.saas.master.config; 
 
 com.ramostear.una.saas.master.config.properties.MasterDatabaseProperties をインポートします。
 com.ramostear.una.saas.master.model.MasterTenant をインポートします。
 com.ramostear.una.saas.master.repository.MasterTenantRepository をインポートします。
 com.zaxxer.hikari.HikariDataSource をインポートします。
 lombok.extern.slf4j.Slf4j をインポートします。
 org.hibernate.cfg.Environment をインポートします。
 org.springframework.beans.factory.annotation.Autowired をインポートします。
 org.springframework.beans.factory.annotation.Qualifier をインポートします。
 org.springframework.context.annotation.Bean をインポートします。
 org.springframework.context.annotation.Configuration をインポートします。
 org.springframework.context.annotation.Primaryをインポートします。
 org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor をインポートします。
 org.springframework.data.jpa.repository.config.EnableJpaRepositories をインポートします。
 org.springframework.orm.jpa.JpaTransactionManager をインポートします。
 org.springframework.orm.jpa.JpaVendorAdapter をインポートします。
 org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean をインポートします。
 org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter をインポートします。
 org.springframework.transaction.annotation.EnableTransactionManagementをインポートします。 
 
 javax.persistence.EntityManagerFactory をインポートします。
 javax.sql.DataSource をインポートします。
 java.util.Properties をインポートします。 
 
 /**
 * @author : Tan Chaohong (別名:ramostear)によって作成されました
 * @作成日時2019/5/25 0025-8:31
 * @修正する による：
 * @以来：
 */
 @構成
@トランザクション管理を有効にする
@EnableJpaRepositories(basePackages = { "com.ramostear.una.saas.master.model" , "com.ramostear.una.saas.master.repository" },
                       entityManagerFactoryRef = "マスターEntityManagerFactory" 、
                       トランザクションマネージャ参照 = "マスタートランザクションマネージャ" )
翻訳者
パブリッククラスMasterDatabaseConfig { 
 
    オートワイヤード
    プライベート MasterDatabaseProperties masterDatabaseProperties; 
 
    @Bean(名前= "マスターデータソース" )
パブリックデータソースマスターデータソース(){
        log.info( "masterDatasource を次の値で設定しています:{}" ,masterDatabaseProperties.toString());
        HikariDataSource データソース = new HikariDataSource();
        データソース.setUsername(masterDatabaseProperties.getUsername());
        データソース.setPassword(masterDatabaseProperties.getPassword());
        データソース.setJdbcUrl(masterDatabaseProperties.getUrl());
        データソース.setDriverClassName(masterDatabaseProperties.getDriverClassName());
        データソース。setPoolName(masterDatabaseProperties.getPoolName());
        データソースの最大プールサイズを設定します(masterDatabaseProperties.getMaxPoolSize());
        データソースの最小アイドル値を設定します。
        データソース.setConnectionTimeout(masterDatabaseProperties.getConnectionTimeout());
        データソース.setIdleTimeout(masterDatabaseProperties.getIdleTimeout());
        log.info( "masterDatasource のセットアップに成功しました。" );
データソースを返します。
    }
    @主要な 
    @Bean(名前= "masterEntityManagerFactory" )
パブリックLocalContainerEntityManagerFactoryBean マスターEntityManagerFactory(){
        LocalContainerEntityManagerFactoryBean lb = 新しい LocalContainerEntityManagerFactoryBean();
        lb.setDataSource(マスターデータソース());
        lb.setPackagesToScan(
           新しい文字列[]{MasterTenant.class.getPackage().getName()、MasterTenantRepository.class.getPackage().getName()}
        ); 
 
        //名前の設定  Springが設定する永続ユニットの場合 定義されていない場合は「default」になります。
        lb.setPersistenceUnitName( "マスターデータベースの永続性ユニット" ); 
 
        //Hibernate をJPA プロバイダーとして設定します。
        JpaVendorAdapter ベンダーアダプタ = 新しい HibernateJpaVendorAdapter();
        lb.setJpaVendorAdapter(ベンダーアダプタ)。 
 
        //休止状態のプロパティを設定する
        lb.setJpaProperties(hibernateProperties()); 
 
        log.info( "masterEntityManagerFactory のセットアップに成功しました。" );
 lbを返します。
    }
    @Bean(名前= "masterTransactionManager" )
パブリックJpaTransactionManager マスタートランザクションマネージャー(@Qualifier( "masterEntityManagerFactory" )EntityManagerFactory emf){
        JpaTransactionManager トランザクションマネージャー = 新しい JpaTransactionManager();
        トランザクションマネージャ。EntityManagerFactory を設定します (emf)。
        log.info( "masterTransactionManager のセットアップに成功しました。" );
 transactionManagerを返します。
    } 
 
    @ビーン
パブリックPersistenceExceptionTranslationPostProcessor exceptionTranslationPostProcessor(){
新しい PersistenceExceptionTranslationPostProcessor()を返します。
    }
    プライベートプロパティ hibernateProperties(){
        プロパティ properties = new Properties();
        プロパティを設定します(Environment.DIALECT、 "org.hibernate.dialect.MySQL5Dialect" );
        プロパティを設定します(Environment.SHOW_SQL, true );
        プロパティを設定します(Environment.FORMAT_SQL, true );
        properties.put(Environment.HBM2DDL_AUTO, "更新" );
プロパティを返します。
    }
 }

この構成クラスでは、主にパッケージ スキャン パス、エンティティ管理プロジェクト、トランザクション マネージャー、およびデータ ソース構成パラメーターの構成を提供します。

6. テナントビジネスモジュールを実装する

このセクションでは、SaaS 機能のデモンストレーションとして、テナント ビジネス モジュールのユーザー ログイン シナリオのみを提供します。実際、メイン レイヤー、ビジネス レイヤー、永続レイヤーは、通常の Spring Boot Web プロジェクトと変わりません。 SaaS アプリケーションのコードであることすら感じられません。

まず、ユーザー エンティティ User を作成します。ソース コードは次のようになります。

 @実在物
@テーブル(名前= "USER" )
 @データ
@NoArgsコンストラクタ
@AllArgsコンストラクタ
@ビルダー
パブリッククラスUserはSerializableを実装します{
    プライベート静的最終ロングシリアルバージョンUID = -156890917814957041L; 
 
    @ID
    @列(名前= "ID" )
    プライベート文字列ID; 
 
    @列(名前= "ユーザー名" )
    プライベート文字列ユーザー名; 
 
    @列(名前= "パスワード" )
    @サイズ(最小= 6、最大= 22、メッセージ = "ユーザー パスワードを入力する必要があります。長さは 6 から 22 の間です。" )
    プライベート文字列パスワード; 
 
    @列(名前= "TENANT" )
    プライベート文字列テナント;
 }

ビジネス レイヤーは、ユーザー名に基づいてユーザー情報を取得するサービスを提供します。永続化レイヤー メソッドを呼び出して、ユーザー名に基づいてテナントのユーザー テーブルを取得します。条件を満たすユーザーレコードが見つかった場合、ユーザー情報が返されます。見つからない場合は null が返されます。永続層とビジネス層のソースコードは次のとおりです。

 @リポジトリ
パブリックインターフェース UserRepository は JpaRepository< User ,String>、JpaSpecificationExecutor< User > を拡張します{ 
 
ユーザーfindByUsername(String username);
 }
 @Service( "ユーザーサービス" )
パブリッククラス UserServiceImpl は UserService を実装します{ 
 
    オートワイヤード
    プライベート UserRepository userRepository; 
 
    プライベート静的TwitterIdentifier 識別子 = 新しい TwitterIdentifier(); 
 
 
 
    @オーバーライド
パブリックvoid保存(ユーザー ユーザー) {
ユーザー.setId(識別子.generalIdentifier());
ユーザー.setTenant(TenantContextHolder.getTenant());
        userRepository.save(ユーザー);
    } 
 
    @オーバーライド
公共 ユーザーfindById(文字列 userId) {
        オプション<ユーザー> オプション = userRepository.findById(userId);
        if(オプション.isPresent()){
オプションの.get()を返します。
        }それ以外{
戻る ヌル;
        }
    } 
 
    @オーバーライド
公共 ユーザーfindByUsername(文字列 ユーザー名) {
        システム。出力.println(TenantContextHolder.getTenant());
 userRepository.findByUsername(ユーザー名)を返します。
    }

ここでは、Twitter のスノーフレーク アルゴリズムを使用して ID ジェネレーターを実装します。

7. インターセプターを構成する

テナント識別子を取得するには、テナント情報インターセプターを提供する必要があります。ソース コードと構成インターセプターのソース コードは次のとおりです。

 /**
 * @author : Tan Chaohong (別名:ramostear)によって作成されました
 * @作成日時2019/5/26 0026-23:17
 * @修正する による：
 * @以来：
 */
翻訳者
パブリッククラス TenantInterceptor は HandlerInterceptor を実装します{ 
 
    @オーバーライド
public boolean preHandle(HttpServletRequest リクエスト、HttpServletResponse レスポンス、オブジェクト ハンドラ) 例外をスローします {
        文字列テナント = request.getParameter( "テナント" );
        if(StringUtils.isBlank(テナント)){
            response.sendRedirect( "/login.html" );
戻る 間違い;
        }それ以外{
            テナントコンテキストホルダー。テナントを設定します。
戻る 真実;
        }
    }
 }
 @構成
パブリッククラスInterceptorConfigはWebMvcConfigurationSupportを拡張します。 
 
    @オーバーライド
    保護された void addInterceptors(InterceptorRegistry レジストリ) {
        registry.addInterceptor(新しい TenantInterceptor()).addPathPatterns( "/**" ).excludePathPatterns( "/login.html" );
        super.addInterceptors(レジストリ);
    }
 }

/login.html はシステムのログイン パスです。傍受者による傍受の範囲から除外する必要があります。そうしないと、ログインできなくなります。

8. 入居者の識別情報を維持する

ここでは、データ ソースを動的に設定するためのデータ サポートを提供するために、ThreadLocal を使用してテナント識別情報を保存しています。このクラスは、テナント ID の設定、テナント ID の取得、テナント ID のクリアを行う 3 つの静的メソッドを提供します。ソースコードは次のとおりです。

パブリッククラスTenantContextHolder { 
 
    プライベート静的最終 ThreadLocal<String> CONTEXT = new ThreadLocal<>(); 
 
公共 静的void setTenant(String テナント){
        コンテクスト。セット（テナント）;
    } 
 
公共 静的文字列 getTenant(){
 CONTEXT.get()を返します。
    } 
 
公共 静的voidクリア(){
        CONTEXT.remove();
    }
 }

これは、動的なデータ ソース設定を実装するための鍵となります。

9. 動的なデータソースの切り替え

動的なデータ ソースの切り替えを実装するには、CurrentTenantIdentifierResolver と AbstractDataSourceBasedMultiTenantConnectionProviderImpl の 2 つのクラスを使用する必要があります。名前からわかるように、1 つはテナント識別子を解析する役割を担い、もう 1 つはテナント識別子に対応するテナント データ ソース情報を提供する役割を担います。まず、テナント識別解決機能を完了するために、CurrentTenantIdentifierResolver インターフェースに resolveCurrentTenantIdentifier() メソッドと validateExistingCurrentSessions() メソッドを実装する必要があります。実装クラスのソースコードは次のとおりです。

パッケージ com.ramostear.una.saas.tenant.config; 
 
 com.ramostear.una.saas.context.TenantContextHolder をインポートします。
 org.apache.commons.lang3.StringUtils をインポートします。
 org.hibernate.context.spi.CurrentTenantIdentifierResolver をインポートします。 
 
 /**
 * @author : Tan Chaohong (別名:ramostear)によって作成されました
 * @作成日時2019/5/26 0026-22:38
 * @修正する による：
 * @以来：
 */
パブリッククラスCurrentTenantIdentifierResolverImplはCurrentTenantIdentifierResolverを実装します。 
 
    /**
     * デフォルトのテナントID
     */
    プライベート静的最終文字列 DEFAULT_TENANT = "tenant_1" ; 
 
    /**
     * 現在のテナントのIDを解析する
     * @戻る 
     */
    @オーバーライド
パブリック文字列resolveCurrentTenantIdentifier() {
        //テナント コンテキストを通じてテナント ID を取得します。この ID は、ユーザーがログインするときにヘッダーに設定されます。
        文字列テナント = TenantContextHolder.getTenant();
        //コンテキスト内にテナントIDが見つからない場合は、デフォルトのテナントIDを使用するか、例外を直接報告します
StringUtils.isNotBlank(tenant)?tenant:DEFAULT_TENANTを返します。
    } 
 
    @オーバーライド
パブリックブール値validateExistingCurrentSessions() {
戻る 真実;
    }
 }

このクラスのロジックは非常に単純で、ThreadLocalから現在設定されているテナント識別子を取得することです。

テナント識別子解決クラスを作成したら、テナント データ ソース プロバイダー クラスを拡張して、データベースからテナント データ ソース情報を動的に照会する必要があります。ソースコードは次のとおりです。

翻訳者
@構成
パブリッククラス DataSourceBasedMultiTenantConnectionProviderImpl は AbstractDataSourceBasedMultiTenantConnectionProviderImpl を拡張します{ 
 
    プライベート静的最終ロングシリアルバージョンUID = -7522287771874314380L;
    オートワイヤード
    プライベートマスターテナントリポジトリマスターテナントリポジトリ; 
 
    プライベート Map<String,DataSource> dataSources = new TreeMap<>(); 
 
    @オーバーライド
    保護されたデータソース selectAnyDataSource() {
        データソースが空の場合（）{
            リスト<MasterTenant> テナント = masterTenantRepository.findAll();
            テナント.forEach(masterTenant->{
                データソースを put (masterTenant.getTenant()、DataSourceUtils.wrapperDataSource(masterTenant));
            });
        }
データソースを返します。値（）。イテレータ（）。次（）;
    }
 @オーバーライド
    保護されたデータソース selectDataSource(String テナント) {
        if(!dataSources.containsKey(テナント)){
            リスト<MasterTenant> テナント = masterTenantRepository.findAll();
            テナント.forEach(masterTenant->{
                データソースを put (masterTenant.getTenant()、DataSourceUtils.wrapperDataSource(masterTenant));
            });
        }
 dataSources.get(テナント)を返します。
    }
 }

このクラスでは、テナント データ ソース ライブラリを照会してテナント データ ソース情報を動的に取得し、テナント ビジネス モジュールのデータ ソース構成にデータ サポートを提供します。

最後に、プロジェクト全体の中核となるテナント ビジネス モジュール データ ソース構成も提供する必要があります。コードは次のとおりです。

翻訳者
@構成
@トランザクション管理を有効にする
@ComponentScan(ベースパッケージ = {
 "com.ramostear.una.saas.tenant.model" ,
 「com.ramostear.una.saas.tenant.repository」  
 })
 @EnableJpaRepositories(ベースパッケージ = {
 「com.ramostear.una.saas.tenant.repository」 、
 「com.ramostear.una.saas.tenant.service」  
 },entityManagerFactoryRef = "テナントエンティティマネージャーファクトリ"  
 、transactionManagerRef = "tenantTransactionManager" )
パブリッククラス TenantDataSourceConfig { 
 
    @Bean( "jpaベンダーアダプタ" )
パブリックJpaVendorAdapter jpaVendorAdapter(){
新しい HibernateJpaVendorAdapter()を返します。
    }
     @Bean(名前= "tenantTransactionManager" )
パブリックJpaTransactionManager トランザクションマネージャー (EntityManagerFactory エンティティマネージャーファクトリー){
        JpaTransactionManager トランザクションマネージャー = 新しい JpaTransactionManager();
        トランザクションマネージャ。EntityManagerFactory を設定します。
 transactionManagerを返します。
    } 
 
    @Bean(名前= "データソースベースのマルチテナント接続プロバイダー" )
    @ConditionalOnBean(名前= "masterEntityManagerFactory" )
パブリックMultiTenantConnectionProvider multiTenantConnectionProvider(){
新しい DataSourceBasedMultiTenantConnectionProviderImpl()を返します。
    }
     @Bean(名前= "currentTenantIdentifierResolver" )
パブリックCurrentTenantIdentifierResolver currentTenantIdentifierResolver(){
新しい CurrentTenantIdentifierResolverImpl()を返します。
    } 
 
    @Bean(名前= "tenantEntityManagerFactory" )
    @ConditionalOnBean(名前= "データソースベースのマルチテナント接続プロバイダー" )
パブリックLocalContainerEntityManagerFactoryBean エンティティマネージャファクトリ(
            @Qualifier( "datasourceBasedMultiTenantConnectionProvider" )MultiTenantConnectionProvider 接続プロバイダー、
            @Qualifier( "currentTenantIdentifierResolver" )現在のテナント識別子リゾルバー テナント識別子リゾルバー
    ){
        LocalContainerEntityManagerFactoryBean を新規作成します。
        ローカルBean.setPackagesToScan()
                新しい文字列[]{
ユーザー.class.getPackage().getName()、
                        UserRepository.class.getPackage().getName()、
                        UserService.class.getPackage().getName() 
 
                }
        );
        ローカルBeanにJpaVendorAdapterを設定します(jpaVendorAdapter());
        localBean.setPersistenceUnitName( "テナントデータベース永続ユニット" );
        Map<String,Object> プロパティ = new HashMap<>();
        プロパティを設定します( Environment.MULTI_TENANT、 MultiTenancyStrategy.SCHEMA )。
        properties.put(Environment.MULTI_TENANT_CONNECTION_PROVIDER、接続プロバイダー);
        プロパティを設定します。
        プロパティを設定します(Environment.DIALECT、 "org.hibernate.dialect.MySQL5Dialect" );
        プロパティを設定します(Environment.SHOW_SQL, true );
        プロパティを設定します(Environment.FORMAT_SQL, true );
        properties.put(Environment.HBM2DDL_AUTO, "更新" );
        localBean.setJpaPropertyMap(プロパティ);
 localBeanを返します。
    }
 }

この構成ファイルの内容のほとんどは、メイン データ ソースの構成と同じです。唯一の違いは、テナント識別子リゾルバとテナント データ ソース補充ソースの設定です。これにより、データベース操作コマンドを実行する前にどのようなデータベース接続情報を設定する必要があるか、およびユーザー名やパスワードなどの情報が Hibernate に通知されます。

10. アプリケーションテスト

最後に、このコースでは、簡単なログインケースを通じて SaaS アプリケーションをテストします。これを行うには、ユーザー ログイン ロジックを処理するコントローラーを提供する必要があります。この場合、ユーザー パスワードは厳密に暗号化されず、プレーン テキストで比較されます。権限認証フレームワークは提供されていません。 SaaS の基本機能が利用可能かどうかを確認します。ログイン コントローラ コードは次のとおりです。

 /**
 * @author : Tan Chaohong (別名:ramostear)によって作成されました
 * @作成日時2019/5/27 0027-0:18
 * @修正する による：
 * @以来：
 */
 @コントローラ
パブリッククラスLoginController { 
 
    オートワイヤード
    プライベート UserService userService; 
 
    @GetMapping( "/login.html" )
パブリック文字列ログイン(){
戻る  "/ログイン" ;
    } 
 
    @PostMapping( "/ログイン" )
パブリック文字列ログイン(@RequestParam( name = "username" )文字列ユーザー名、@RequestParam( name = "password" )文字列パスワード、ModelMapモデル){
        システム。出力.println( "テナント:" +TenantContextHolder.getTenant());
ユーザー ユーザー= userService.findByUsername(ユーザー名);
        if(ユーザー!= null ){
            if(ユーザー.getPassword().equals(パスワード)){
                model.put( "ユーザー" 、ユーザー);
戻る  "/索引" ;
            }それ以外{
戻る  "/ログイン" ;
            }
        }それ以外{
戻る  "/ログイン" ;
        }
    }
 }

プロジェクトを開始する前に、テナント データ ソース情報を保存するためのメイン データ ソースに対応するデータベースとデータ テーブルを作成する必要があります。また、テナント ビジネス データを格納するためのテナント ビジネス モジュール データベースとデータ テーブルも提供する必要があります。すべての準備ができたら、プロジェクトを起動し、ブラウザにhttp://localhost:8080/login.htmlと入力します。

ログイン ウィンドウに対応するテナント名、ユーザー名、パスワードを入力して、ホームページに正常にアクセスできるかどうかをテストします。さらにいくつかのテナントとユーザーを追加して、ユーザーが対応するテナントに正常に切り替えられるかどうかをテストできます。

要約する

ここでは、Spring Boot + JPA を使用してマルチテナント アプリケーションを迅速に実装する方法を紹介します。この方法では、SaaS アプリケーション プラットフォームを実装するための最もコアとなる技術的手段のみが使用されます。完全で使用可能なプロジェクト コードではありません。たとえば、ユーザー認証と承認はこの記事では取り上げません。