Spring Boot 構建多租戶SaaS平台核心技術指南
本次教程所涉及到的源碼已上傳至 Github,如果你不需要繼續閱讀下面的內容,你可以直接點擊此鏈接獲取源碼內容。 https://github.com/ramostear/una-saas-toturial
1. 概述
筆者從2014年開始接觸SaaS(Software as a Service),即多租戶(或多承租)軟件應用平台;並一直從事相關領域的架構設計及研發工作。機緣巧合,在筆者本科畢業設計時完成了一個基於SaaS的高效財務管理平台的課題研究,從中收獲頗多。最早接觸SaaS時,國內相關資源匱乏,唯一有的參照資料是《互聯網時代的軟件革命:SaaS架構設計》(葉偉等著)一書。最后課題的實現是基於OSGI(Open Service Gateway Initiative)Java動態模塊化系統規范來實現的。
時至今日,五年的時間過去了,軟件開發的技術發生了巨大的改變,筆者所實現SaaS平台的技術棧也更新了好幾波,真是印證了那就話:“山重水盡疑無路,柳暗花明又一村”。基於之前走過的許多彎路和踩過的坑,以及近段時間有許多網友問我如何使用Spring Boot實現多租戶系統,決定寫一篇文章聊一聊關於SaaS的硬核技術。
說起SaaS,它只是一種軟件架構,並沒有多少神秘的東西,也不是什么很難的系統,我個人的感覺,SaaS平台的難度在於商業上的運營,而非技術上的實現。就技術上來說,SaaS是這樣一種架構模式:它讓多個不同環境的用戶使用同一套應用程序,且保證用戶之間的數據相互隔離。現在想想看,這也有點共享經濟的味道在里面。
筆者在這里就不再深入聊SaaS軟件成熟度模型和數據隔離方案對比的事情了。今天要聊的是使用Spring Boot快速構建獨立數據庫/共享數據庫獨立Schema的多租戶系統。我將提供一個SaaS系統最核心的技術實現,而其他的部分有興趣的朋友可以在此基礎上自行擴展。
2. 嘗試了解多租戶的應用場景
假設我們需要開發一個應用程序,並且希望將同一個應用程序銷售給N家客戶使用。在常規情況下,我們需要為此創建N個Web服務器(Tomcat),N個數據庫(DB),並為N個客戶部署相同的應用程序N次。現在,如果我們的應用程序進行了升級或者做了其他任何的改動,那么我們就需要更新N個應用程序同時還需要維護N台服務器。接下來,如果業務開始增長,客戶由原來的N個變成了現在的N+M個,我們將面臨N個應用程序和M個應用程序版本維護,設備維護以及成本控制的問題。運維幾乎要哭死在機房了...
為了解決上述的問題,我們可以開發多租戶應用程序,我們可以根據當前用戶是誰,從而選擇對應的數據庫。例如,當請求來自A公司的用戶時,應用程序就連接A公司的數據庫,當請求來自B公司的用戶時,自動將數據庫切換到B公司數據庫,以此類推。從理論上將沒有什么問題,但我們如果考慮將現有的應用程序改造成SaaS模式,我們將遇到第一個問題:如果識別請求來自哪一個租戶?如何自動切換數據源?
3. 維護、識別和路由租戶數據源
我們可以提供一個獨立的庫來存放租戶信息,如數據庫名稱、鏈接地址、用戶名、密碼等,這可以統一的解決租戶信息維護的問題。租戶的識別和路由有很多種方法可以解決,下面列舉幾個常用的方式:
- 1.可以通過域名的方式來識別租戶:我們可以為每一個租戶提供一個唯一的二級域名,通過二級域名就可以達到識別租戶的能力,如tenantone.example.com,http://tenant.example.com;tenantone和tenant就是我們識別租戶的關鍵信息。
- 2.可以將租戶信息作為請求參數傳遞給服務端,為服務端識別租戶提供支持,如saas.example.com?tenantId=tenant1,saas.example.com?tenantId=tenant2。其中的參數tenantId就是應用程序識別租戶的關鍵信息。
- 3.可以在請求頭(Header)中設置租戶信息,例如JWT等技術,服務端通過解析Header中相關參數以獲得租戶信息。
- 4.在用戶成功登錄系統后,將租戶信息保存在Session中,在需要的時候從Session取出租戶信息。
解決了上述問題后,我們再來看看如何獲取客戶端傳入的租戶信息,以及在我們的業務代碼中如何使用租戶信息(最關鍵的是DataSources的問題)。
我們都知道,在啟動Spring Boot應用程序之前,就需要為其提供有關數據源的配置信息(有使用到數據庫的情況下),按照一開始的需求,有N個客戶需要使用我們的應用程序,我們就需要提前配置好N個數據源(多數據源),如果N<50,我認為我還能忍受,如果更多,這樣顯然是無法接受的。為了解決這一問題,我們需要借助Hibernate 5提供的動態數據源特性,讓我們的應用程序具備動態配置客戶端數據源的能力。簡單來說,當用戶請求系統資源時,我們將用戶提供的租戶信息(tenantId)存放在ThreadLoacal中,緊接着獲取TheadLocal中的租戶信息,並根據此信息查詢單獨的租戶庫,獲取當前租戶的數據配置信息,然后借助Hibernate動態配置數據源的能力,為當前請求設置數據源,最后之前用戶的請求。這樣我們就只需要在應用程序中維護一份數據源配置信息(租戶數據庫配置庫),其余的數據源動態查詢配置。接下來,我們將快速的演示這一功能。
4. 項目構建
我們將使用Spring Boot 2.1.5版本來實現這一演示項目,首先你需要在Maven配置文件中加入如下的一些配置:
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.47</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> </dependency> </dependencies>
然后提供一個可用的配置文件,並加入如下的內容:
spring: freemarker: cache: false template-loader-path: - classpath:/templates/ prefix: suffix: .html resources: static-locations: - classpath:/static/ devtools: restart: enabled: true jpa: database: mysql show-sql: true generate-ddl: false hibernate: ddl-auto: none una: master: datasource: url: jdbc:mysql://localhost:3306/master_tenant?useSSL=false username: root password: root driverClassName: com.mysql.jdbc.Driver maxPoolSize: 10 idleTimeout: 300000 minIdle: 10 poolName: master-database-connection-pool logging: level: root: warn org: springframework: web: debug hibernate: debug
由於采用Freemarker作為視圖渲染引擎,所以需要提供Freemarker的相關技術
una:master:datasource配置項就是上面說的統一存放租戶信息的數據源配置信息,你可以理解為主庫。
接下來,我們需要關閉Spring Boot自動配置數據源的功能,在項目主類上添加如下的設置:
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class}) public class UnaSaasApplication { public static void main(String[] args) { SpringApplication.run(UnaSaasApplication.class, args); } }
最后,讓我們看看整個項目的結構:

5. 實現租戶數據源查詢模塊
我們將定義一個實體類存放租戶數據源信息,它包含了租戶名,數據庫連接地址,用戶名和密碼等信息,其代碼如下:
@Data @Entity @Table(name = "MASTER_TENANT") @NoArgsConstructor @AllArgsConstructor @Builder public class MasterTenant implements Serializable{ @Id @Column(name="ID") private String id; @Column(name = "TENANT") @NotEmpty(message = "Tenant identifier must be provided") private String tenant; @Column(name = "URL") @Size(max = 256) @NotEmpty(message = "Tenant jdbc url must be provided") private String url; @Column(name = "USERNAME") @Size(min = 4,max = 30,message = "db username length must between 4 and 30") @NotEmpty(message = "Tenant db username must be provided") private String username; @Column(name = "PASSWORD") @Size(min = 4,max = 30) @NotEmpty(message = "Tenant db password must be provided") private String password; @Version private int version = 0; }
持久層我們將繼承JpaRepository接口,快速實現對數據源的CURD操作,同時提供了一個通過租戶名查找租戶數據源的接口,其代碼如下:
package com.ramostear.una.saas.master.repository; import com.ramostear.una.saas.master.model.MasterTenant; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.Query; import org.springframework.data.repository.query.Param; import org.springframework.stereotype.Repository; /** * @author : Created by Tan Chaohong (alias:ramostear) * @create-time 2019/5/25 0025-8:22 * @modify by : * @since: */ @Repository public interface MasterTenantRepository extends JpaRepository<MasterTenant,String>{ @Query("select p from MasterTenant p where p.tenant = :tenant") MasterTenant findByTenant(@Param("tenant") String tenant); }
業務層提供通過租戶名獲取租戶數據源信息的服務(其余的服務各位可自行添加):
package com.ramostear.una.saas.master.service; import com.ramostear.una.saas.master.model.MasterTenant; /** * @author : Created by Tan Chaohong (alias:ramostear) * @create-time 2019/5/25 0025-8:26 * @modify by : * @since: */ public interface MasterTenantService { /** * Using custom tenant name query * @param tenant tenant name * @return masterTenant */ MasterTenant findByTenant(String tenant); }
最后,我們需要關注的重點是配置主數據源(Spring Boot需要為其提供一個默認的數據源)。在配置之前,我們需要獲取配置項,可以通過@ConfigurationProperties("una.master.datasource")獲取配置文件中的相關配置信息:
@Getter @Setter @Configuration @ConfigurationProperties("una.master.datasource") public class MasterDatabaseProperties { private String url; private String password; private String username; private String driverClassName; private long connectionTimeout; private int maxPoolSize; private long idleTimeout; private int minIdle; private String poolName; @Override public String toString(){ StringBuilder builder = new StringBuilder(); builder.append("MasterDatabaseProperties [ url=") .append(url) .append(", username=") .append(username) .append(", password=") .append(password) .append(", driverClassName=") .append(driverClassName) .append(", connectionTimeout=") .append(connectionTimeout) .append(", maxPoolSize=") .append(maxPoolSize) .append(", idleTimeout=") .append(idleTimeout) .append(", minIdle=") .append(minIdle) .append(", poolName=") .append(poolName) .append("]"); return builder.toString(); } }
接下來是配置自定義的數據源,其源碼如下:
package com.ramostear.una.saas.master.config; import com.ramostear.una.saas.master.config.properties.MasterDatabaseProperties; import com.ramostear.una.saas.master.model.MasterTenant; import com.ramostear.una.saas.master.repository.MasterTenantRepository; import com.zaxxer.hikari.HikariDataSource; import lombok.extern.slf4j.Slf4j; import org.hibernate.cfg.Environment; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary; import org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; import org.springframework.orm.jpa.JpaTransactionManager; import org.springframework.orm.jpa.JpaVendorAdapter; import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; import org.springframework.transaction.annotation.EnableTransactionManagement; import javax.persistence.EntityManagerFactory; import javax.sql.DataSource; import java.util.Properties; /** * @author : Created by Tan Chaohong (alias:ramostear) * @create-time 2019/5/25 0025-8:31 * @modify by : * @since: */ @Configuration @EnableTransactionManagement @EnableJpaRepositories(basePackages = {"com.ramostear.una.saas.master.model","com.ramostear.una.saas.master.repository"}, entityManagerFactoryRef = "masterEntityManagerFactory", transactionManagerRef = "masterTransactionManager") @Slf4j public class MasterDatabaseConfig { @Autowired private MasterDatabaseProperties masterDatabaseProperties; @Bean(name = "masterDatasource") public DataSource masterDatasource(){ log.info("Setting up masterDatasource with :{}",masterDatabaseProperties.toString()); HikariDataSource datasource = new HikariDataSource(); datasource.setUsername(masterDatabaseProperties.getUsername()); datasource.setPassword(masterDatabaseProperties.getPassword()); datasource.setJdbcUrl(masterDatabaseProperties.getUrl()); datasource.setDriverClassName(masterDatabaseProperties.getDriverClassName()); datasource.setPoolName(masterDatabaseProperties.getPoolName()); datasource.setMaximumPoolSize(masterDatabaseProperties.getMaxPoolSize()); datasource.setMinimumIdle(masterDatabaseProperties.getMinIdle()); datasource.setConnectionTimeout(masterDatabaseProperties.getConnectionTimeout()); datasource.setIdleTimeout(masterDatabaseProperties.getIdleTimeout()); log.info("Setup of masterDatasource successfully."); return datasource; } @Primary @Bean(name = "masterEntityManagerFactory") public LocalContainerEntityManagerFactoryBean masterEntityManagerFactory(){ LocalContainerEntityManagerFactoryBean lb = new LocalContainerEntityManagerFactoryBean(); lb.setDataSource(masterDatasource()); lb.setPackagesToScan( new String[]{MasterTenant.class.getPackage