refactor: 规范文件命名

cadecode · cadecode · commit e0a443e80de2 · 2023-12-01T10:14:13.000+08:00
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/annotation/DynamicDs.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/annotation/DynamicDs.java
@@ -11,6 +11,6 @@
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
-public @interface DynamicDS {
+public @interface DynamicDs {
     String value();
 }
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/aspect/DynamicDsAspect.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/aspect/DynamicDsAspect.java
@@ -1,7 +1,7 @@
 package com.github.cadecode.uniboot.common.plugin.datasource.aspect;
 
-import com.github.cadecode.uniboot.common.plugin.datasource.annotation.DynamicDS;
-import com.github.cadecode.uniboot.common.plugin.datasource.dynamic.DynamicDSHolder;
+import com.github.cadecode.uniboot.common.plugin.datasource.annotation.DynamicDs;
+import com.github.cadecode.uniboot.common.plugin.datasource.dynamic.DynamicDsHolder;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.annotation.After;
@@ -22,10 +22,10 @@
 @Aspect
 @Component
 @Order(-1)
-public class DynamicDSAspect {
+public class DynamicDsAspect {
 
-    @Pointcut("@within(com.github.cadecode.uniboot.common.plugin.datasource.annotation.DynamicDS) " +
-            "|| @annotation(com.github.cadecode.uniboot.common.plugin.datasource.annotation.DynamicDS)")
+    @Pointcut("@within(com.github.cadecode.uniboot.common.plugin.datasource.annotation.DynamicDs) " +
+            "|| @annotation(com.github.cadecode.uniboot.common.plugin.datasource.annotation.DynamicDs)")
     public void pointCut() {
 
     }
@@ -38,11 +38,11 @@ public void switchDataSource(JoinPoint point) {
         // 获取方法上的注解
         String dataSourceKey = getDataSourceKey(point);
         // 设置数据源
-        if (!DynamicDSHolder.containDataSourceKey(dataSourceKey)) {
+        if (!DynamicDsHolder.containDataSourceKey(dataSourceKey)) {
             log.info("Switch datasource fail，{} not found", dataSourceKey);
             return;
         }
-        DynamicDSHolder.setDataSourceKey(dataSourceKey);
+        DynamicDsHolder.setDataSourceKey(dataSourceKey);
         String methodName = point.getSignature().getDeclaringTypeName() + '.' + point.getSignature().getName();
         log.info("Switch datasource to {}，execute method [{}]", dataSourceKey, methodName);
     }
@@ -53,16 +53,16 @@ public void switchDataSource(JoinPoint point) {
     @After("pointCut()")
     public void resetDataSource(JoinPoint point) {
         // 将数据源恢复为之前的数据源
-        DynamicDSHolder.clearDataSourceKey();
-        log.info("Reset datasource to {}", DynamicDSHolder.getDataSourceKey());
+        DynamicDsHolder.clearDataSourceKey();
+        log.info("Reset datasource to {}", DynamicDsHolder.getDataSourceKey());
     }
 
     /**
-     * 获取 DynamicDS 注解内容，以方法为主
+     * 获取 DynamicDs 注解内容，以方法为主
      */
     private String getDataSourceKey(JoinPoint point) {
         MethodSignature methodSignature = (MethodSignature) point.getSignature();
-        DynamicDS dsM = methodSignature.getMethod().getAnnotation(DynamicDS.class);
+        DynamicDs dsM = methodSignature.getMethod().getAnnotation(DynamicDs.class);
         // 获取数据源 key
         String dataSourceKey;
         if (dsM != null) {
@@ -71,7 +71,7 @@ private String getDataSourceKey(JoinPoint point) {
         // 获取取类上的注解内容
         dataSourceKey = methodSignature.getMethod()
                 .getDeclaringClass()
-                .getAnnotation(DynamicDS.class)
+                .getAnnotation(DynamicDs.class)
                 .value();
         return dataSourceKey;
     }
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/config/DynamicDsAutoConfig.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/config/DynamicDsAutoConfig.java
@@ -1,8 +1,8 @@
 package com.github.cadecode.uniboot.common.plugin.datasource.config;
 
-import com.github.cadecode.uniboot.common.plugin.datasource.dynamic.DynamicDS;
-import com.github.cadecode.uniboot.common.plugin.datasource.dynamic.DynamicDSHolder;
-import com.github.cadecode.uniboot.common.plugin.datasource.exception.DynamicDSException;
+import com.github.cadecode.uniboot.common.plugin.datasource.dynamic.DynamicDs;
+import com.github.cadecode.uniboot.common.plugin.datasource.dynamic.DynamicDsHolder;
+import com.github.cadecode.uniboot.common.plugin.datasource.exception.DynamicDsException;
 import com.zaxxer.hikari.HikariDataSource;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -25,46 +25,46 @@
 @Slf4j
 @RequiredArgsConstructor
 @Configuration
-@EnableConfigurationProperties(DynamicDSProperties.class)
+@EnableConfigurationProperties(DynamicDsProperties.class)
 @ConditionalOnProperty(name = "uni-boot.dynamic-ds.enable", havingValue = "true")
-public class DynamicDSAutoConfig {
+public class DynamicDsAutoConfig {
 
-    private final DynamicDSProperties properties;
+    private final DynamicDsProperties properties;
 
     @Bean
-    public DynamicDS dynamicDS() {
+    public DynamicDs dynamicDs() {
         log.info("Checking dynamic datasource config");
-        checkDynamicDSConfig();
+        checkDynamicDsConfig();
         log.info("Starting to create dynamic datasource");
         // 创建数据源
         Map<Object, Object> dataSourceMap;
         try {
             dataSourceMap = properties.getDatasource().entrySet().stream()
                     .collect(Collectors.toMap(Entry::getKey, e -> new HikariDataSource(e.getValue())));
         } catch (Exception e) {
-            throw new DynamicDSException("Create dynamic datasource fail", e);
+            throw new DynamicDsException("Create dynamic datasource fail", e);
         }
-        DynamicDS dynamicDS = new DynamicDS();
+        DynamicDs dynamicDs = new DynamicDs();
         // 添加数据源
-        dynamicDS.setTargetDataSources(dataSourceMap);
+        dynamicDs.setTargetDataSources(dataSourceMap);
         // 设置默认数据源
-        dynamicDS.setDefaultTargetDataSource(dataSourceMap.get(properties.getMaster()));
-        DynamicDSHolder.setDataSourceKey(properties.getMaster());
+        dynamicDs.setDefaultTargetDataSource(dataSourceMap.get(properties.getMaster()));
+        DynamicDsHolder.setDataSourceKey(properties.getMaster());
         log.info("Create dynamic datasource over，set default to {}", properties.getMaster());
-        return dynamicDS;
+        return dynamicDs;
     }
 
     /**
      * 检查是否配置了数据源和 master
      */
-    private void checkDynamicDSConfig() {
+    private void checkDynamicDsConfig() {
         // 检查是否配置了数据源
         if (Objects.isNull(properties.getDatasource()) || properties.getDatasource().isEmpty()) {
-            throw new DynamicDSException("Dynamic datasource config not found");
+            throw new DynamicDsException("Dynamic datasource config not found");
         }
         // 检查是否指定主数据源
         if (Objects.isNull(properties.getMaster()) || !properties.getDatasource().containsKey(properties.getMaster())) {
-            throw new DynamicDSException("Not found default datasource config");
+            throw new DynamicDsException("Not found default datasource config");
         }
     }
 }
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/config/DynamicDsProperties.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/config/DynamicDsProperties.java
@@ -14,7 +14,7 @@
  */
 @Data
 @ConfigurationProperties("uni-boot.dynamic-ds")
-public class DynamicDSProperties {
+public class DynamicDsProperties {
 
     private boolean enable;
 
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/dynamic/DynamicDs.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/dynamic/DynamicDs.java
@@ -11,14 +11,14 @@
  * @author Cade Li
  * @date 2021/12/3
  */
-public class DynamicDS extends AbstractRoutingDataSource {
+public class DynamicDs extends AbstractRoutingDataSource {
 
     /**
      * 设置数据源 key
      */
     @Override
     protected Object determineCurrentLookupKey() {
-        return DynamicDSHolder.getDataSourceKey();
+        return DynamicDsHolder.getDataSourceKey();
     }
 
     /**
@@ -28,7 +28,7 @@ protected Object determineCurrentLookupKey() {
     public void setTargetDataSources(Map<Object, Object> targetDataSources) {
         super.setTargetDataSources(targetDataSources);
         // 存储数据源 key
-        DynamicDSHolder.addDataSourceKeys(targetDataSources.keySet());
+        DynamicDsHolder.addDataSourceKeys(targetDataSources.keySet());
     }
 
     /**
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/dynamic/DynamicDsHolder.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/dynamic/DynamicDsHolder.java
@@ -10,7 +10,7 @@
  * @author Cade Li
  * @date 2021/12/3
  */
-public class DynamicDSHolder {
+public class DynamicDsHolder {
 
     // 定义容器，存储当前线程的数据源 key，使用 stack 实现嵌套切换
     private static final ThreadLocal<Stack<String>> HOLDER = ThreadLocal.withInitial(Stack::new);
diff --git a/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/exception/DynamicDsException.java b/common/plugin/datasource/src/main/java/com/github/cadecode/uniboot/common/plugin/datasource/exception/DynamicDsException.java
@@ -6,23 +6,23 @@
  * @author Cade Li
  * @date 2023/6/9
  */
-public class DynamicDSException extends RuntimeException{
-    public DynamicDSException() {
+public class DynamicDsException extends RuntimeException {
+    public DynamicDsException() {
     }
 
-    public DynamicDSException(String message) {
+    public DynamicDsException(String message) {
         super(message);
     }
 
-    public DynamicDSException(String message, Throwable cause) {
+    public DynamicDsException(String message, Throwable cause) {
         super(message, cause);
     }
 
-    public DynamicDSException(Throwable cause) {
+    public DynamicDsException(Throwable cause) {
         super(cause);
     }
 
-    public DynamicDSException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+    public DynamicDsException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
         super(message, cause, enableSuppression, writableStackTrace);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@`
`11`	`11`	`@Target({ElementType.TYPE, ElementType.METHOD})`
`12`	`12`	`@Retention(RetentionPolicy.RUNTIME)`
`13`	`13`	`@Documented`
`14`		`-public @interface DynamicDS {`
	`14`	`+public @interface DynamicDs {`
`15`	`15`	`String value();`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,23 +6,23 @@`
`6`	`6`	`* @author Cade Li`
`7`	`7`	`* @date 2023/6/9`
`8`	`8`	`*/`
`9`		`-public class DynamicDSException extends RuntimeException{`
`10`		`- public DynamicDSException() {`
	`9`	`+public class DynamicDsException extends RuntimeException {`
	`10`	`+ public DynamicDsException() {`
`11`	`11`	`}`
`12`	`12`
`13`		`- public DynamicDSException(String message) {`
	`13`	`+ public DynamicDsException(String message) {`
`14`	`14`	`super(message);`
`15`	`15`	`}`
`16`	`16`
`17`		`- public DynamicDSException(String message, Throwable cause) {`
	`17`	`+ public DynamicDsException(String message, Throwable cause) {`
`18`	`18`	`super(message, cause);`
`19`	`19`	`}`
`20`	`20`
`21`		`- public DynamicDSException(Throwable cause) {`
	`21`	`+ public DynamicDsException(Throwable cause) {`
`22`	`22`	`super(cause);`
`23`	`23`	`}`
`24`	`24`
`25`		`- public DynamicDSException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {`
	`25`	`+ public DynamicDsException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {`
`26`	`26`	`super(message, cause, enableSuppression, writableStackTrace);`
`27`	`27`	`}`
`28`	`28`	`}`