時間：2023-03-14 10:00:02 | 來源：電子商務
時間：2023-03-14 10:00:02 來源：電子商務
在線咨詢
<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:noneuna: 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-poollogging: level: root:warn org: springframework: web:debug hibernate:debug由于采用Freemarker作為視圖渲染引擎，所以需要提供Freemarker的相關技術接下來，我們需要關閉Spring Boot自動配置數據源的功能，在項目主類上添加如下的設置：
una:master:datasource配置項就是上面說的統一存放租戶信息的數據源配置信息，你可以理解為主庫。
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})publicclass UnaSaasApplication { public static void main(String[] args) { SpringApplication.run(UnaSaasApplication.class, args); }}最后，讓我們看看整個項目的結構：@Data@Entity@Table(name = "MASTER_TENANT")@NoArgsConstructor@AllArgsConstructor@Builderpublicclass 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 privateint 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: */@Repositorypublicinterface MasterTenantRepository extends JpaRepository<MasterTenant,String>{ @Query("select p from MasterTenant p where p.tenant = :tenant") MasterTenant findByTenant(@Param("tenant") String tenant);}業(yè)務層提供通過租戶名獲取租戶數據源信息的服務（其余的服務各位可自行添加）：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: */publicinterface 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")publicclass MasterDatabaseProperties { private String url; private String password; private String username; private String driverClassName; privatelong connectionTimeout; privateint maxPoolSize; privatelong idleTimeout; privateint 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")@Slf4jpublicclass 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().getName(), MasterTenantRepository.class.getPackage().getName()} ); //Setting a name for the persistence unit as Spring sets it as 'default' if not defined. lb.setPersistenceUnitName("master-database-persistence-unit"); //Setting Hibernate as the JPA provider. JpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter(); lb.setJpaVendorAdapter(vendorAdapter); //Setting the hibernate properties lb.setJpaProperties(hibernateProperties()); log.info("Setup of masterEntityManagerFactory successfully."); return lb; } @Bean(name = "masterTransactionManager") public JpaTransactionManager masterTransactionManager(@Qualifier("masterEntityManagerFactory")EntityManagerFactory emf){ JpaTransactionManager transactionManager = new JpaTransactionManager(); transactionManager.setEntityManagerFactory(emf); log.info("Setup of masterTransactionManager successfully."); return transactionManager; } @Bean public PersistenceExceptionTranslationPostProcessor exceptionTranslationPostProcessor(){ returnnew PersistenceExceptionTranslationPostProcessor(); } private Properties hibernateProperties(){ Properties properties = new Properties(); properties.put(Environment.DIALECT,"org.hibernate.dialect.MySQL5Dialect"); properties.put(Environment.SHOW_SQL,true); properties.put(Environment.FORMAT_SQL,true); properties.put(Environment.HBM2DDL_AUTO,"update"); return properties; }}在改配置類中，我們主要提供包掃描路徑，實體管理工程，事務管理器和數據源配置參數的配置。@Entity@Table(name = "USER")@Data@NoArgsConstructor@AllArgsConstructor@Builderpublicclass User implements Serializable { privatestaticfinallong serialVersionUID = -156890917814957041L; @Id @Column(name = "ID") private String id; @Column(name = "USERNAME") private String username; @Column(name = "PASSWORD") @Size(min = 6,max = 22,message = "User password must be provided and length between 6 and 22.") private String password; @Column(name = "TENANT") private String tenant;}業(yè)務層提供了一個根據用戶名檢索用戶信息的服務，它將調用持久層的方法根據用戶名對租戶的用戶表進行檢索，如果找到滿足條件的用戶記錄，則返回用戶信息，如果沒有找到，則返回null;持久層和業(yè)務層的源碼分別如下：@Repositorypublicinterface UserRepository extends JpaRepository<User,String>,JpaSpecificationExecutor<User>{ User findByUsername(String username);}@Service("userService")publicclass UserServiceImpl implements UserService{ @Autowired private UserRepository userRepository; privatestatic TwitterIdentifier identifier = new TwitterIdentifier(); @Override public void save(User user) { user.setId(identifier.generalIdentifier()); user.setTenant(TenantContextHolder.getTenant()); userRepository.save(user); } @Override public User findById(String userId) { Optional<User> optional = userRepository.findById(userId); if(optional.isPresent()){ return optional.get(); }else{ returnnull; } } @Override public User findByUsername(String username) { System.out.println(TenantContextHolder.getTenant()); return userRepository.findByUsername(username); }在這里，我們采用了Twitter的雪花算法來實現了一個ID生成器。
/** * @author : Created by Tan Chaohong (alias:ramostear) * @create-time 2019/5/26 0026-23:17 * @modify by : * @since: */@Slf4jpublicclass TenantInterceptor implements HandlerInterceptor{ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String tenant = request.getParameter("tenant"); if(StringUtils.isBlank(tenant)){ response.sendRedirect("/login.html"); returnfalse; }else{ TenantContextHolder.setTenant(tenant); returntrue; } }}@Configurationpublicclass InterceptorConfig extends WebMvcConfigurationSupport { @Override protected void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new TenantInterceptor()).addPathPatterns("/**").excludePathPatterns("/login.html"); super.addInterceptors(registry); }}/login.html是系統的登錄路徑，我們需要將其排除在攔截器攔截的范圍之外，否則我們永遠無法進行登錄
publicclass TenantContextHolder { privatestaticfinal ThreadLocal<String> CONTEXT = new ThreadLocal<>(); public static void setTenant(String tenant){ CONTEXT.set(tenant); } public static String getTenant(){ return CONTEXT.get(); } public static void clear(){ CONTEXT.remove(); }}此類時實現動態(tài)數據源設置的關鍵
package com.ramostear.una.saas.tenant.config;import com.ramostear.una.saas.context.TenantContextHolder;import org.apache.commons.lang3.StringUtils;import org.hibernate.context.spi.CurrentTenantIdentifierResolver;/** * @author : Created by Tan Chaohong (alias:ramostear) * @create-time 2019/5/26 0026-22:38 * @modify by : * @since: */ publicclass CurrentTenantIdentifierResolverImpl implements CurrentTenantIdentifierResolver { /** * 默認的租戶ID */ privatestaticfinal String DEFAULT_TENANT = "tenant_1"; /** * 解析當前租戶的ID * @return */ @Override public String resolveCurrentTenantIdentifier() { //通過租戶上下文獲取租戶ID，此ID是用戶登錄時在header中進行設置的 String tenant = TenantContextHolder.getTenant(); //如果上下文中沒有找到該租戶ID，則使用默認的租戶ID，或者直接報異常信息 return StringUtils.isNotBlank(tenant)?tenant:DEFAULT_TENANT; } @Override public boolean validateExistingCurrentSessions() { returntrue; }}此類的邏輯非常簡單，就是從ThreadLocal中獲取當前設置的租戶標識符有了租戶標識符解析類之后，我們需要擴展租戶數據源提供類，實現從數據庫動態(tài)查詢租戶數據源信息，其源碼如下：
@Slf4j@Configurationpublicclass DataSourceBasedMultiTenantConnectionProviderImpl extends AbstractDataSourceBasedMultiTenantConnectionProviderImpl{ privatestaticfinallong serialVersionUID = -7522287771874314380L; @Autowired private MasterTenantRepository masterTenantRepository; private Map<String,DataSource> dataSources = new TreeMap<>(); @Override protected DataSource selectAnyDataSource() { if(dataSources.isEmpty()){ List<MasterTenant> tenants = masterTenantRepository.findAll(); tenants.forEach(masterTenant->{ dataSources.put(masterTenant.getTenant(), DataSourceUtils.wrapperDataSource(masterTenant)); }); } return dataSources.values().iterator().next(); }@Override protected DataSource selectDataSource(String tenant) { if(!dataSources.containsKey(tenant)){ List<MasterTenant> tenants = masterTenantRepository.findAll(); tenants.forEach(masterTenant->{ dataSources.put(masterTenant.getTenant(),DataSourceUtils.wrapperDataSource(masterTenant)); }); } return dataSources.get(tenant); }}在該類中，通過查詢租戶數據源庫，動態(tài)獲得租戶數據源信息，為租戶業(yè)務模塊的數據源配置提供數據數據支持。最后，我們還需要提供租戶業(yè)務模塊數據源配置，這是整個項目核心的地方，其代碼如下：
@Slf4j@Configuration@EnableTransactionManagement@ComponentScan(basePackages = { "com.ramostear.una.saas.tenant.model", "com.ramostear.una.saas.tenant.repository"})@EnableJpaRepositories(basePackages = { "com.ramostear.una.saas.tenant.repository", "com.ramostear.una.saas.tenant.service"},entityManagerFactoryRef = "tenantEntityManagerFactory",transactionManagerRef = "tenantTransactionManager")publicclass TenantDataSourceConfig { @Bean("jpaVendorAdapter") public JpaVendorAdapter jpaVendorAdapter(){ returnnew HibernateJpaVendorAdapter(); } @Bean(name = "tenantTransactionManager") public JpaTransactionManager transactionManager(EntityManagerFactory entityManagerFactory){ JpaTransactionManager transactionManager = new JpaTransactionManager(); transactionManager.setEntityManagerFactory(entityManagerFactory); return transactionManager; } @Bean(name = "datasourceBasedMultiTenantConnectionProvider") @ConditionalOnBean(name = "masterEntityManagerFactory") public MultiTenantConnectionProvider multiTenantConnectionProvider(){ returnnew DataSourceBasedMultiTenantConnectionProviderImpl(); } @Bean(name = "currentTenantIdentifierResolver") public CurrentTenantIdentifierResolver currentTenantIdentifierResolver(){ returnnew CurrentTenantIdentifierResolverImpl(); } @Bean(name = "tenantEntityManagerFactory") @ConditionalOnBean(name = "datasourceBasedMultiTenantConnectionProvider") public LocalContainerEntityManagerFactoryBean entityManagerFactory( @Qualifier("datasourceBasedMultiTenantConnectionProvider")MultiTenantConnectionProvider connectionProvider, @Qualifier("currentTenantIdentifierResolver")CurrentTenantIdentifierResolver tenantIdentifierResolver ){ LocalContainerEntityManagerFactoryBean localBean = new LocalContainerEntityManagerFactoryBean(); localBean.setPackagesToScan( new String[]{ User.class.getPackage().getName(), UserRepository.class.getPackage().getName(), UserService.class.getPackage().getName() } ); localBean.setJpaVendorAdapter(jpaVendorAdapter()); localBean.setPersistenceUnitName("tenant-database-persistence-unit"); Map<String,Object> properties = new HashMap<>(); properties.put(Environment.MULTI_TENANT, MultiTenancyStrategy.SCHEMA); properties.put(Environment.MULTI_TENANT_CONNECTION_PROVIDER,connectionProvider); properties.put(Environment.MULTI_TENANT_IDENTIFIER_RESOLVER,tenantIdentifierResolver); properties.put(Environment.DIALECT,"org.hibernate.dialect.MySQL5Dialect"); properties.put(Environment.SHOW_SQL,true); properties.put(Environment.FORMAT_SQL,true); properties.put(Environment.HBM2DDL_AUTO,"update"); localBean.setJpaPropertyMap(properties); return localBean; }}在改配置文件中，大部分內容與主數據源的配置相同，唯一的區(qū)別是租戶標識解析器與租戶數據源補給源的設置，它將告訴Hibernate在執(zhí)行數據庫操作命令前，應該設置什么樣的數據庫連接信息，以及用戶名和密碼等信息。
/** * @author : Created by Tan Chaohong (alias:ramostear) * @create-time 2019/5/27 0027-0:18 * @modify by : * @since: */@Controllerpublicclass LoginController { @Autowired private UserService userService; @GetMapping("/login.html") public String login(){ return"/login"; } @PostMapping("/login") public String login(@RequestParam(name = "username") String username, @RequestParam(name = "password")String password, ModelMap model){ System.out.println("tenant:"+TenantContextHolder.getTenant()); User user = userService.findByUsername(username); if(user != null){ if(user.getPassword().equals(password)){ model.put("user",user); return"/index"; }else{ return"/login"; } }else{ return"/login"; } }}在啟動項目之前，我們需要為主數據源創(chuàng)建對應的數據庫和數據表，用于存放租戶數據源信息，同時還需要提供一個租戶業(yè)務模塊數據庫和數據表，用來存放租戶業(yè)務數據。一切準備就緒后，啟動項目，在瀏覽器中輸入：http://localhost:8080/login.html關鍵詞：平臺,核心,技術,指南,租戶
