浏览代码

优化注释

zhouhao 8 年之前
父节点
当前提交
3a43cbbf75

+ 6 - 1
hsweb-datasource/hsweb-datasource-api/src/main/java/org/hswebframework/web/datasource/DatabaseType.java

@@ -20,6 +20,12 @@ import java.util.Arrays;
 import java.util.Objects;
 import java.util.function.Predicate;
 
+/**
+ * 数据库类型枚举
+ *
+ * @author zhouhao
+ * @since 3.0
+ */
 public enum DatabaseType {
     unknown(null, null, null, String::isEmpty),
     mysql("com.mysql.jdbc.Driver", "com.mysql.jdbc.jdbc2.optional.MysqlXADataSource", "select 1", createUrlPredicate("mysql")),
@@ -43,7 +49,6 @@ public enum DatabaseType {
         this.urlPredicate = urlPredicate;
     }
 
-
     private final String testQuery;
 
     private final String driverClassName;

+ 2 - 1
hsweb-datasource/hsweb-datasource-api/src/main/java/org/hswebframework/web/datasource/DynamicDataSourceProxy.java

@@ -8,9 +8,10 @@ import java.sql.SQLFeatureNotSupportedException;
 import java.util.logging.Logger;
 
 /**
- * TODO 完成注释
+ * 动态数据源代理,将数据源代理为动态数据源
  *
  * @author zhouhao
+ * @since 3.0
  */
 public class DynamicDataSourceProxy implements DynamicDataSource {
 

+ 14 - 1
hsweb-datasource/hsweb-datasource-api/src/main/java/org/hswebframework/web/datasource/DynamicDataSourceService.java

@@ -1,12 +1,25 @@
 package org.hswebframework.web.datasource;
 
+import org.hswebframework.web.datasource.exception.DataSourceNotFoundException;
+
 /**
- * TODO 完成注释
+ * 动态数据源服务类
  *
  * @author zhouhao
+ * @since 3.0
  */
 public interface DynamicDataSourceService {
+
+    /**
+     * 根据数据源ID获取动态数据源,数据源不存在将抛出{@link DataSourceNotFoundException}
+     *
+     * @param dataSourceId 数据源ID
+     * @return 动态数据源
+     */
     DynamicDataSource getDataSource(String dataSourceId);
 
+    /**
+     * @return 默认数据源
+     */
     DynamicDataSource getDefaultDataSource();
 }

+ 0 - 2
hsweb-datasource/hsweb-datasource-api/src/main/java/org/hswebframework/web/datasource/exception/DataSourceNotFoundException.java

@@ -1,8 +1,6 @@
 package org.hswebframework.web.datasource.exception;
 
 /**
- * TODO 完成注释
- *
  * @author zhouhao
  */
 public class DataSourceNotFoundException extends RuntimeException {