diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index d0edcfa7..64d560dc 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -67,7 +67,7 @@ export default defineConfig({ {text: 'Db + Row', link: '/zh/base/db-row'}, {text: 'IService', link: '/zh/base/service'}, {text: 'SpringBoot 配置文件', link: '/zh/base/configuration'}, - {text: 'MyBatisFlexInitializer', link: '/zh/base/mybatis-flex-initializer'}, + {text: 'MyBatisFlexCustomizer', link: '/zh/base/mybatis-flex-customizer'}, ] }, { diff --git a/docs/zh/base/mybatis-flex-customizer.md b/docs/zh/base/mybatis-flex-customizer.md new file mode 100644 index 00000000..b1b8d658 --- /dev/null +++ b/docs/zh/base/mybatis-flex-customizer.md @@ -0,0 +1,32 @@ +# MyBatisFlexCustomizer + +`MyBatisFlexCustomizer` 是 MyBatis-Flex 为了方便 `SpringBoot` 用户对 MyBatis-Flex 进行初始化而产生的接口。 + +通过在 `@Configuration` 去实现 `MyBatisFlexCustomizer` 接口，我们可以对 MyBatis-Flex 进行一些列的初始化配置。这些配置可能包含如下的内容： + +- 1、FlexGlobalConfig 的全局配置 +- 2、自定义主键生成器 +- 3、多租户配置 +- 4、动态表名配置 +- 5、逻辑删除处理器配置 +- 6、自定义脱敏规则 +- 7、SQL 审计配置 +- 8、SQL 打印配置 +- 9、数据源解密器配置 +- 10、自定义数据方言配置 +- 11、... + +## 代码示例 + +```java + +@Configuration +public class MyBatisFlexConfiguration implements MyBatisFlexCustomizer { + + @Override + public void customize(FlexGlobalConfig globalConfig) { + //我们可以在这里进行一些列的初始化配置 + } + +} +``` \ No newline at end of file diff --git a/docs/zh/base/mybatis-flex-initializer.md b/docs/zh/base/mybatis-flex-initializer.md deleted file mode 100644 index 5c3f04d5..00000000 --- a/docs/zh/base/mybatis-flex-initializer.md +++ /dev/null @@ -1,30 +0,0 @@ -# MyBatisFlexInitializer - -`MyBatisFlexInitializer` 是 MyBatis-Flex 为了方便 `SpringBoot` 用户对 MyBatis-Flex 进行初始化而产生的接口。 - -通过在 `@Configuration` 去实现 `MyBatisFlexInitializer` 接口，我们可以对 MyBatis-Flex 进行一些列的初始化配置。这些配置可能包含如下的内容： - -- 1、FlexGlobalConfig 的全局配置 -- 2、自定义主键生成器 -- 3、多租户配置 -- 4、动态表名配置 -- 5、逻辑删除处理器配置 -- 6、自定义脱敏规则 -- 7、SQL 审计配置 -- 8、SQL 打印配置 -- 9、数据源解密器配置 -- 10、自定义数据方言配置 -- 11、... - -## 代码示例 - -```java -@Configuration -public class MyConfiguration implements MyBatisFlexInitializer { - - @Override - public void onInitBefore() { - //我们可以在这里进行一些列的初始化配置 - } -} -``` \ No newline at end of file diff --git a/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MyBatisFlexInitializer.java b/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MyBatisFlexCustomizer.java similarity index 50% rename from mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MyBatisFlexInitializer.java rename to mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MyBatisFlexCustomizer.java index f458eaca..5d2b73b8 100644 --- a/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MyBatisFlexInitializer.java +++ b/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MyBatisFlexCustomizer.java @@ -15,22 +15,34 @@ */ package com.mybatisflex.spring.boot; +import com.mybatisflex.core.FlexGlobalConfig; + /** - * MyBatisFlex 初始化监听器 - * 一般可以用于去初始化： + *

MyBatis-Flex 配置。 * - * 1、自定义主键生成器 - * 2、FlexGlobalConfig 的全局配置 - * 3、多租户配置 - * 4、动态表名配置 - * 5、逻辑删除处理器配置 - * 6、自定义脱敏规则 - * 7、SQL 审计配置 - * 8、SQL 打印配置 - * 9、数据源解密器配置 - * 10、自定义数据方言配置 - * ... + *

一般可以用于去初始化： + * + *

*/ -public interface MyBatisFlexInitializer { - void onInitBefore(); +public interface MyBatisFlexCustomizer { + + /** + * 自定义 MyBatis-Flex 配置。 + * + * @param globalConfig 全局配置 + */ + void customize(FlexGlobalConfig globalConfig); + } diff --git a/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MybatisFlexAutoConfiguration.java b/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MybatisFlexAutoConfiguration.java index 6e48af6b..a4c94521 100644 --- a/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MybatisFlexAutoConfiguration.java +++ b/mybatis-flex-spring-boot-starter/src/main/java/com/mybatisflex/spring/boot/MybatisFlexAutoConfiguration.java @@ -129,7 +129,7 @@ public class MybatisFlexAutoConfiguration implements InitializingBean { protected final LogicDeleteProcessor logicDeleteProcessor; //初始化监听 - protected final MyBatisFlexInitializer myBatisFlexInitializer; + protected final MyBatisFlexCustomizer mybatisFlexCustomizer; public MybatisFlexAutoConfiguration(MybatisFlexProperties properties, ObjectProvider interceptorsProvider, @@ -142,7 +142,7 @@ public class MybatisFlexAutoConfiguration implements InitializingBean { ObjectProvider dynamicSchemaProcessorProvider, ObjectProvider tenantFactoryProvider, ObjectProvider logicDeleteProcessorProvider, - ObjectProvider myBatisFlexInitializerProvider + ObjectProvider mybatisFlexCustomizerProvider ) { this.properties = properties; this.interceptors = interceptorsProvider.getIfAvailable(); @@ -167,7 +167,7 @@ public class MybatisFlexAutoConfiguration implements InitializingBean { this.logicDeleteProcessor = logicDeleteProcessorProvider.getIfAvailable(); //初始化监听器 - this.myBatisFlexInitializer = myBatisFlexInitializerProvider.getIfAvailable(); + this.mybatisFlexCustomizer = mybatisFlexCustomizerProvider.getIfAvailable(); } @Override @@ -204,8 +204,8 @@ public class MybatisFlexAutoConfiguration implements InitializingBean { } //初始化监听器 - if (myBatisFlexInitializer != null) { - myBatisFlexInitializer.onInitBefore(); + if (mybatisFlexCustomizer != null) { + mybatisFlexCustomizer.customize(FlexGlobalConfig.getDefaultConfig()); } }