1.1.0 Release

airoland · airoland · commit ba1e2b7eade2 · 2022-03-25T18:06:21.000+08:00
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@
 
 |  saas-datasource-spring-boot-starter   |  dynamic-datasource-spring-boot-starter  |  mybatis-plus-boot-starter  |  mybatis-spring-boot-starter  |
 |  :----:  |  :----:  |  :----:  |  :----:  |
-| 1.0.0  | version <= 2.4.2 | <div align="left">根据`@SaaS`注解的位置分为两种情况：<br/>1. 如果注解在Mapper上，则 version <= 3.0.7.1，若高于此版本dynamic-datasource会报错；<br/>2. 如果注解不在Mapper上，则可使用目前最新版本 version <= 3.5.1 (latest)。<br/>按[最佳实践](#最佳实践)，推荐上述第二种情况，注解不要放在Mapper上。</div>  | version <= 2.2.2 (latest) |
+| 1.1.0 & 1.0.0  | version <= 2.4.2 | <div align="left">根据`@SaaS`注解的位置分为两种情况：<br/>1. 如果注解在Mapper上，则 version <= 3.0.7.1，若高于此版本dynamic-datasource会报错；<br/>2. 如果注解不在Mapper上，则可使用目前最新版本 version <= 3.5.1 (latest)。<br/>按[最佳实践](#最佳实践)，推荐上述第二种情况，注解不要放在Mapper上。</div>  | version <= 2.2.2 (latest) |
 
 ## 快速使用
 
@@ -49,7 +49,7 @@
 <dependency>
     <groupId>com.air-software</groupId>
     <artifactId>saas-datasource-spring-boot-starter</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
 </dependency>
 ```
 
@@ -124,6 +124,23 @@ public class MySaaSDataSourceProvider implements SaaSDataSourceProvider {
 }
 ```
 
+**注意**，为保证数据源提供者查询数据源时能够正确访问到公共库，而不受其他已切换数据源的影响，建议为查询数据源的Mapper添加`dynamic-datasource-spring-boot-starter`自带的`@DS`注解，强制使用公共库：
+
+```
+@DS("common")
+public interface DataSourceConfigMapper
+```
+
+另外如果你使用的是`1.1.0`及以上版本，可以直接使用`SaaSDataSource.switchTo`来强制切换至公共库，记得切换后立即调用`clearCurrent`清理一下：
+
+```
+SaaSDataSource.switchTo("common");
+DataSourceConfig dataSourceConfig = dataSourceConfigMapper.selectById(dsKey);
+SaaSDataSource.clearCurrent();
+```
+
+不建议在`1.0.0`采用此方法，因为`1.0.0`版本的`SaaSDataSource.switchTo`方法并未被优化。
+
 ### 启用注解
 
 在SpringBoot主启动类上添加`@EnableSaaSDataSource`注解，表示启用SaaS数据源功能。
@@ -139,12 +156,10 @@ public class SaaSApplication {
 }
 ```
 
-在需要切换数据源的类或方法上标记`@SaaS`注解，此注解中可设置**租户标识字段名称**，默认值为`dsKey`。
+如果你想使用Request Session或Header的方式切换数据源，则在需要切换数据源的类或方法上标记`@SaaS`注解，此注解中可设置**租户标识字段名称**，默认值为`dsKey`。
 
 比如我在使用注解时设置为`@SaaS("tenantId")`，那么我在Request Session或Header中就需要用`tenantId`字段来设置租户标识，而这个租户标识在首次切换至此租户时，会传递至你自己实现的`SaaSDataSourceProvider`中，以此来获取租户对应数据源。
 
-注意：如果使用了`SaaSDataSource`上下文来手动切换数据库，则`@SaaS`中的值会被忽略。
-
 ### 切换数据源
 
 本工具共提供三种方式来切换数据源，按优先级从高到底排列如下：
@@ -155,13 +170,21 @@ public class SaaSApplication {
 
 你可以在任意地方多次调用`SaaSDataSource.switchTo`来手动切换数据源，他会影响到你下一次即将执行的数据库操作，常用于拦截器、定时任务、异步操作、循环刷库，跨库统计、消息消费等场景。
 
+`SaaSDataSource`内部模拟了一个栈来存储多次切换的数据源，`switchTo`方法入栈，`current`方法获取当前栈顶数据，`clearCurrent`方法会让当前栈顶数据出栈，`clearAll`方法会清理整个栈。
+
+建议在每次手动切换完成，且对应数据源的业务处理完成后，调用`clearCurrent`来清理刚刚手动切换的数据源，以避免对后续流程产生影响。或者也可以在整个业务流程的最后调用`clearAll`。
+
+**注意**：在`1.1.0`及以上版本，如果你只使用`SaaSDataSource`来手动切换数据库，则不需要再标记`@SaaS`注解，即使标记了注解，注解中的值也会被忽略。
+
+而在`1.0.0`版本，则仍需要标记`@SaaS`注解，切必须在注解生效前执行`SaaSDataSource.switchTo`。
+
 ## 注意事项
 
 以下注意事项**非常重要**，请开发者务必仔细阅读：
 
 1. 公共库中的表最好不要跟租户库中的业务表有重合，因为当切换数据源失败时，会自动切换回应用启动时配置的默认数据源（通常为公共库），此时如果公共库中存在同名业务表的话，那在明面上是不会报错的，只不过数据都到公共库里了，这样不利于排查问题。
 2. 为安全起见，尽量不要使用Header模式，因为前端传递的数据永远是不可信的。如果要使用前端直接传递的值，一定要配合权限控制，比如整个系统的超级管理员想要自由切换至不同租户，此时就需要使用前端传值。这也是我保留了Header模式，但优先级降为最低的原因。
-3. **事务中无法切换数据源**，首先一定要注意`@SaaS`的标记位置，至少应在最外层事务或更上一层的调用方标记此注解，即保证注解在事务开启前发挥作用，以切换到正确的数据源。其次不要在事务内调用`SaaSDataSource.switchTo`，而应在事务开启前调用。**如果没有在事务开启前通过注解或手动切换至正确的数据源，则事务会在默认数据源上执行。**
+3. **事务中无法切换数据源，强行切换可能会导致报错。**首先一定要注意`@SaaS`的标记位置，至少应在最外层事务或更上一层的调用方标记此注解，即保证注解在事务开启前发挥作用，以切换到正确的数据源。其次不要在事务内调用`SaaSDataSource.switchTo`，而应在事务开启前调用。**如果没有在事务开启前通过注解或手动切换至正确的数据源，则事务会在默认数据源上执行。**
 4. 本工具**不提供分布式事务的实现**，也未做过相关测试，如果需要分布式事务请开发者自行实现和测试，理论上本工具兼容分布式事务。
 5. 在定时任务、异步操作、消息消费等无法获取Request上下文的场景下，**一定要记得处理业务前调用`SaaSDataSource.switchTo`来手动切换数据源**。
 
@@ -170,4 +193,16 @@ public class SaaSApplication {
 基于上述注意事项，结合现代Web开发的技术倾向，可以得出以下几条最佳实践：
 
 1. 为保障注解在事务开启前发挥作用，**在Web项目中推荐将`@SaaS`标记在`Controller`层**，一般这就是事务的顶层了。大部分项目中都会有一个`BaseController`作为所有Controller的父类，将`@SaaS`注解标记在父类上，对所有Controller都会起作用。
-2. 现代Web项目中使用Token的情况已逐步超过Session，在Token场景下，我们可以将`dsKey`放入Token中，或为安全起见将`dsKey`放入Redis，而Redis Key放入Token中。随后我们在拦截器中解析Token之后，使用获得的`dsKey`调用`SaaSDataSource.switchTo`来切换数据源，这样在编写业务代码时就无需关心租户切换问题了。（不要忘了最后在拦截器的`afterCompletion`中调用`SaaSDataSource.clear`方法）
+2. 现代Web项目中使用Token的情况已逐步超过Session，在Token场景下，我们可以将`dsKey`放入Token中，或为安全起见将`dsKey`放入Redis，而Redis Key放入Token中。随后我们在拦截器中解析Token之后，使用获得的`dsKey`调用`SaaSDataSource.switchTo`来切换数据源，这样在编写业务代码时就无需关心租户切换问题了，最后不要忘了在拦截器的`afterCompletion`中调用`SaaSDataSource.clearAll`方法（`1.0.0`版本是`SaaSDataSource.clear`）。
+
+## 更新日志
+
+### 1.1.0
+
+- 优化了`SaaSDataSource`，现在可以随时强制切换数据源，不再依赖`@SaaS`注解；
+- 增加了数据源管理器，优化内部拦截器代码。
+
+### 1.0.0
+
+- 支持Request Session和Header切换数据源；
+- 支持`SaaSDataSource`手动切换数据源，但需要在切换后的调用流程中存在`@SaaS`注解标记来触发。
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>com.air-software</groupId>
     <artifactId>saas-datasource-spring-boot-starter</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <packaging>jar</packaging>
     
     <name>saas-datasource-spring-boot-starter</name>
diff --git a/src/main/java/com/airsoftware/saas/datasource/annotation/EnableSaaSDataSource.java b/src/main/java/com/airsoftware/saas/datasource/annotation/EnableSaaSDataSource.java
@@ -21,7 +21,7 @@
 import java.lang.annotation.*;
 
 /**
- * 开启动态数据源
+ * 开启动态数据源<br/>
  * 添加到SpringBootApplication启动类上
  *
  * @author bit
diff --git a/src/main/java/com/airsoftware/saas/datasource/annotation/SaaS.java b/src/main/java/com/airsoftware/saas/datasource/annotation/SaaS.java
@@ -18,11 +18,11 @@
 import java.lang.annotation.*;
 
 /**
- * 标记需要开启SaaS模式的类或方法，也可以标记在父类上。
- *
- * 注意事项：
- * 1、由于事务内部无法切换数据源，因此如果需要使用事务，则应至少在最外层事务或更上一层的调用方标记此注解，即保证注解在事务开启前发挥作用，以切换到正确的数据源；
- * 2、本工具不提供分布式事务的实现，也未做过相关测试，如果需要分布式事务请开发者自行实现和测试，理论上本工具兼容分布式事务。
+ * 标记需要开启SaaS模式的类或方法，也可以标记在父类上。<br/>
+ * <br/>
+ * 注意事项：<br/>
+ * 1、由于事务内部无法切换数据源，因此如果需要使用事务，则应至少在最外层事务或更上一层的调用方标记此注解，即保证注解在事务开启前发挥作用，以切换到正确的数据源；<br/>
+ * 2、本工具不提供分布式事务的实现，也未做过相关测试，如果需要分布式事务请开发者自行实现和测试，理论上本工具兼容分布式事务。<br/>
  *
  * @author bit
  */
@@ -32,7 +32,7 @@
 public @interface SaaS {
     
     /**
-     * 租户标识字段名称，即Request Session或Header中对应的字段名称。
+     * 租户标识字段名称，即Request Session或Header中对应的字段名称。<br/>
      * 如果使用 {@link com.airsoftware.saas.datasource.context.SaaSDataSource} 来手动切换数据源，则此值会被忽略。
      */
     String value() default "dsKey";
diff --git a/src/main/java/com/airsoftware/saas/datasource/context/SaaSDataSource.java b/src/main/java/com/airsoftware/saas/datasource/context/SaaSDataSource.java
@@ -15,44 +15,103 @@
  */
 package com.airsoftware.saas.datasource.context;
 
+import com.airsoftware.saas.datasource.core.SaaSDataSourceManager;
+import com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder;
+import lombok.Setter;
+
+import java.util.concurrent.LinkedBlockingDeque;
+
 /**
- * SaaS数据源切换上下文
+ * SaaS数据源手动切换工具<br/>
  * 用于手动切换数据源，可在同一调用流程内多次切换数据源，注意在开启了事务的方法内切换无效。
  *
  * @author bit
  */
 public class SaaSDataSource {
     
-    private static ThreadLocal<String> HOLDER = ThreadLocal.withInitial(() -> "");
+    @Setter
+    private static SaaSDataSourceManager manager;
+    
+    /**
+     * 模拟栈存储手动切换的数据源<br/>
+     * 在一次调用流程中，如果启用了手动切换，则后续只会以手动切换为准，除非显式调用clearCurrent或clearAll。<br/>
+     * 如果一次调用流程中多次设置手动切换，则clearCurrent会移除栈顶数据，clearAll会清空整个栈。
+     */
+    private static ThreadLocal<LinkedBlockingDeque<String>> DS_KEY_HOLDER = ThreadLocal.withInitial(LinkedBlockingDeque::new);
     
     /**
-     * 获取当前数据源标识
+     * 获取当前栈顶的数据源标识
      */
     public static String current() {
-        return HOLDER.get();
+        LinkedBlockingDeque<String> deque = DS_KEY_HOLDER.get();
+        return deque.isEmpty() ? null : deque.getFirst();
     }
     
     /**
      * 切换至对应数据源
      * @param dsKey 数据源标识
      */
     public static void switchTo(String dsKey) {
-        HOLDER.set(dsKey);
+        set(dsKey);
     }
     
     /**
      * 切换至对应数据源
      * @param dsKey 数据源标识，兼容Long型ID
      */
     public static void switchTo(Long dsKey) {
-        HOLDER.set(String.valueOf(dsKey));
+        set(String.valueOf(dsKey));
+    }
+    
+    /**
+     * 切换至对应数据源
+     * @param dsKey 数据源标识，兼容Integer型ID
+     */
+    public static void switchTo(Integer dsKey) {
+        set(String.valueOf(dsKey));
+    }
+    
+    /**
+     * 添加数据源，并手动设置上下文
+     * @param dsKey
+     */
+    private static void set(String dsKey) {
+        // 设置时即添加数据源
+        manager.addDataSource(dsKey);
+        // 入栈
+        DS_KEY_HOLDER.get().addFirst(dsKey);
+        // 设置DynamicDataSource上下文，实际数据库操作时以此为准，其内部也是一个栈
+        DynamicDataSourceContextHolder.setDataSourceLookupKey(dsKey);
+    }
+    
+    /**
+     * 移除当前数据源<br/>
+     * 如果当前线程是连续手动切换数据源，只会移除掉当前栈顶生效的数据源。
+     */
+    public static void clearCurrent() {
+        LinkedBlockingDeque<String> deque = DS_KEY_HOLDER.get();
+        if (deque.isEmpty()) {
+            DS_KEY_HOLDER.remove();
+        } else {
+            deque.pollFirst();
+        }
+        DynamicDataSourceContextHolder.clearDataSourceLookupKey();
     }
     
     /**
-     * 清空线程
+     * 清空所有手动设置的数据源<br/>
+     * 如果当前线程是连续手动切换数据源，则会清空整个栈。
      */
-    public static void clear() {
-        HOLDER.remove();
+    public static void clearAll() {
+        LinkedBlockingDeque<String> deque = DS_KEY_HOLDER.get();
+        // 根据本工具当前栈的深度，将DynamicDataSource上下文中手动设置进去的数据源依次出栈
+        int size = deque.size();
+        for (int i = 0; i < size; i++) {
+            DynamicDataSourceContextHolder.clearDataSourceLookupKey();
+        }
+        // 清空本工具的栈，并移除线程
+        deque.clear();
+        DS_KEY_HOLDER.remove();
     }
     
 }
diff --git a/src/main/java/com/airsoftware/saas/datasource/core/SaaSDataSourceAnnotationInterceptor.java b/src/main/java/com/airsoftware/saas/datasource/core/SaaSDataSourceAnnotationInterceptor.java
@@ -17,10 +17,8 @@
 
 import com.airsoftware.saas.datasource.annotation.SaaS;
 import com.airsoftware.saas.datasource.context.SaaSDataSource;
-import com.airsoftware.saas.datasource.provider.SaaSDataSourceProvider;
 import com.airsoftware.saas.datasource.util.StringUtil;
 import com.baomidou.dynamic.datasource.DynamicDataSourceClassResolver;
-import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
 import com.baomidou.dynamic.datasource.spel.DynamicDataSourceSpelParser;
 import com.baomidou.dynamic.datasource.spel.DynamicDataSourceSpelResolver;
 import com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder;
@@ -34,9 +32,7 @@
 import org.springframework.web.context.request.ServletRequestAttributes;
 
 import javax.servlet.http.HttpServletRequest;
-import javax.sql.DataSource;
 import java.lang.reflect.Method;
-import java.util.Map;
 
 /**
  * SaaS数据源AOP核心拦截器
@@ -47,10 +43,7 @@
 public class SaaSDataSourceAnnotationInterceptor implements MethodInterceptor {
     
     @Setter
-    private SaaSDataSourceProvider dynamicDataSourceProvider;
-    
-    @Setter
-    private DynamicRoutingDataSource dynamicRoutingDataSource;
+    private SaaSDataSourceManager manager;
     
     @Setter
     private DynamicDataSourceSpelResolver dynamicDataSourceSpelResolver;
@@ -62,9 +55,10 @@ public class SaaSDataSourceAnnotationInterceptor implements MethodInterceptor {
     
     @Override
     public Object invoke(MethodInvocation invocation) throws Throwable {
+        String dsKey = "";
+        boolean requestAddDataSource = false;
         try {
             String dsKeyField = getDsKeyField(invocation);
-            String dsKey = "";
             
             // Request优先级：Session > Header
             if (RequestContextHolder.getRequestAttributes() != null) {
@@ -73,24 +67,26 @@ public Object invoke(MethodInvocation invocation) throws Throwable {
                 dsKey = StringUtil.isNotBlank(sessionValue) ? sessionValue : request.getHeader(dsKeyField);
             }
             
-            // 手动设置数据源优先级最高
+            // SaaSDataSource手动设置数据源优先级最高，因此如果SaaSDataSource当前栈顶有值，则忽略Request设置值，否则按Request设置值切换上下文
             String currentContext = SaaSDataSource.current();
-            if (StringUtil.isNotBlank(currentContext)) {
-                dsKey = currentContext;
-            }
-            
-            if (StringUtil.isNotBlank(dsKey)) {
-                // 初始化该key对应的数据源
-                initDataSource(dsKey);
+            if (StringUtil.isBlank(currentContext) && StringUtil.isNotBlank(dsKey)) {
+                // 添加该key对应的数据源
+                manager.addDataSource(dsKey);
+                // 添加成功则设置此标识为true，用于在finally中判断是否需要清理
+                requestAddDataSource = true;
                 // 切换上下文
                 DynamicDataSourceContextHolder.setDataSourceLookupKey(dsKey);
             }
+            
             return invocation.proceed();
         } catch (Exception e) {
             log.error("An exception occurred during the invocation of @SaaS, data source will switch to default.", e);
             return invocation.proceed();
         } finally {
-            DynamicDataSourceContextHolder.clearDataSourceLookupKey();
+            // 如果Request模式切添加数据源成功，则需要做最后的清理
+            if (requestAddDataSource) {
+                DynamicDataSourceContextHolder.clearDataSourceLookupKey();
+            }
         }
     }
     
@@ -110,20 +106,4 @@ private String getDsKeyField(MethodInvocation invocation) throws Throwable {
         return saas.value();
     }
     
-    /**
-     * 根据key初始化数据源
-     *
-     * @param dsKey
-     */
-    private void initDataSource(String dsKey) {
-        Map<String, DataSource> dsMap = dynamicRoutingDataSource.getCurrentDataSources();
-        // 如果已被缓存则直接返回
-        if (dsMap != null && dsMap.containsKey(dsKey)) {
-            return;
-        }
-        
-        // 由开发者自行实现此接口来提供数据源
-        DataSource ds = dynamicDataSourceProvider.createDataSource(dsKey);
-        dynamicRoutingDataSource.addDataSource(dsKey, ds);
-    }
 }
diff --git a/src/main/java/com/airsoftware/saas/datasource/core/SaaSDataSourceAutoConfiguration.java b/src/main/java/com/airsoftware/saas/datasource/core/SaaSDataSourceAutoConfiguration.java
diff --git a/src/main/java/com/airsoftware/saas/datasource/core/SaaSDataSourceManager.java b/src/main/java/com/airsoftware/saas/datasource/core/SaaSDataSourceManager.java

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`import java.lang.annotation.*;`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * 开启动态数据源`
	`24`	`+ * 开启动态数据源<br/>`
`25`	`25`	`* 添加到SpringBootApplication启动类上`
`26`	`26`	`*`
`27`	`27`	`* @author bit`