You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2024/02/15 06:23:15 UTC

(shardingsphere) branch master updated: Rename ClassPathURLProvider to ShardingSphereURLLoader (#30134)

This is an automated email from the ASF dual-hosted git repository.

zhaojinchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git


The following commit(s) were added to refs/heads/master by this push:
     new 91d8ff8793f Rename ClassPathURLProvider to ShardingSphereURLLoader (#30134)
91d8ff8793f is described below

commit 91d8ff8793f5f122b5b8364ffd5f0c1e9235577a
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Thu Feb 15 14:23:10 2024 +0800

    Rename ClassPathURLProvider to ShardingSphereURLLoader (#30134)
    
    * Rename ClassPathURLProvider to ShardingSphereURLLoader
    
    * Rename ClassPathURLProvider to ShardingSphereURLLoader
---
 .../yaml-config/jdbc-driver/known-implementation/_index.cn.md     | 8 ++++----
 .../yaml-config/jdbc-driver/known-implementation/_index.en.md     | 8 ++++----
 .../driver/jdbc/core/driver/DriverDataSourceCache.java            | 6 +++---
 ...hardingSphereURLProvider.java => ShardingSphereURLLoader.java} | 4 ++--
 .../{AbsolutePathURLProvider.java => AbsolutePathURLLoader.java}  | 6 +++---
 .../type/{ClassPathURLProvider.java => ClassPathURLLoader.java}   | 6 +++---
 ...ingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader} | 4 ++--
 .../jdbc/core/driver/url/type/AbsolutePathURLProviderTest.java    | 2 +-
 .../jdbc/core/driver/url/type/ClassPathURLProviderTest.java       | 2 +-
 9 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.cn.md
index c08ae9a288f..83cdf6a2d0c 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.cn.md
@@ -7,10 +7,10 @@ chapter = true
 ## 背景信息
 
 对于 `org.apache.shardingsphere.driver.ShardingSphereDriver` 的驱动类,
-通过实现 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider` 的 SPI,
+通过实现 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader` 的 SPI,
 可允许从多种来源和 File System 获取并解析为 ShardingSphere 的 YAML 配置文件。
 如无特定声明,以下实现均采用 YAML 1.1 作为 YAML 的编写规范,
-这并不阻止 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider` 的自定义实现从 XML 或 JSON 等文件手动转化为 YAML。
+这并不阻止 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader` 的自定义实现从 XML 或 JSON 等文件手动转化为 YAML。
 
 在解析并加载 YAML 文件为 ShardingSphere 的元数据后,
 会再次通过[模式配置](../../../java-api/mode)的相关配置决定下一步行为。讨论两种情况,
@@ -48,8 +48,8 @@ chapter = true
 
 ## JDBC URL 参数
 
-对于 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider` 的实现,并非所有的 JDBC URL 参数都必须被解析,
-这涉及到如何实现 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider.getContent()`。
+对于 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader` 的实现,并非所有的 JDBC URL 参数都必须被解析,
+这涉及到如何实现 `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader.getContent()`。
 
 ### placeholder-type
 
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.en.md
index 00d7787fed3..caee037ffd7 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/jdbc-driver/known-implementation/_index.en.md
@@ -7,10 +7,10 @@ chapter = true
 ## Background Information
 
 For the driver class of `org.apache.shardingsphere.driver.ShardingSphereDriver`,
-by implementing the SPI of `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider`,
+by implementing the SPI of `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader`,
 allows YAML configuration files to be fetched from multiple sources and File Systems and parsed into ShardingSphere.
 If there is no specific statement, the following implementations all use YAML 1.1 as the YAML writing specification.
-This does not prevent custom implementations of `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider` from being manually converted to YAML from files such as XML or JSON.
+This does not prevent custom implementations of `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader` from being manually converted to YAML from files such as XML or JSON.
 
 After parsing and loading the YAML file into ShardingSphere's metadata, 
 the next behavior will be determined again through the relevant configuration of [Mode Configuration](../../../java-api/mode). 
@@ -56,9 +56,9 @@ Example:
 
 ## JDBC URL parameters
 
-For implementations of `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider`, 
+For implementations of `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader`, 
 not all JDBC URL parameters must be parsed,
-this involves how to implement `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider.getContent()`.
+this involves how to implement `org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader.getContent()`.
 
 ### placeholder-type
 
diff --git a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/DriverDataSourceCache.java b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/DriverDataSourceCache.java
index 0bfae4bb0ba..a6be030c7b9 100644
--- a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/DriverDataSourceCache.java
+++ b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/DriverDataSourceCache.java
@@ -19,7 +19,7 @@ package org.apache.shardingsphere.driver.jdbc.core.driver;
 
 import org.apache.shardingsphere.driver.api.yaml.YamlShardingSphereDataSourceFactory;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURL;
-import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider;
+import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader;
 import org.apache.shardingsphere.infra.spi.type.typed.TypedSPILoader;
 
 import javax.sql.DataSource;
@@ -53,8 +53,8 @@ public final class DriverDataSourceCache {
     private <T extends Throwable> DataSource createDataSource(final String url) throws T {
         try {
             ShardingSphereURL shardingSphereURL = ShardingSphereURL.parse(url);
-            ShardingSphereURLProvider urlProvider = TypedSPILoader.getService(ShardingSphereURLProvider.class, shardingSphereURL.getSourceType());
-            return YamlShardingSphereDataSourceFactory.createDataSource(urlProvider.getContent(shardingSphereURL));
+            ShardingSphereURLLoader urlLoader = TypedSPILoader.getService(ShardingSphereURLLoader.class, shardingSphereURL.getSourceType());
+            return YamlShardingSphereDataSourceFactory.createDataSource(urlLoader.getContent(shardingSphereURL));
         } catch (final IOException ex) {
             throw (T) new SQLException(ex);
         } catch (final SQLException ex) {
diff --git a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/ShardingSphereURLProvider.java b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/ShardingSphereURLLoader.java
similarity index 92%
rename from jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/ShardingSphereURLProvider.java
rename to jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/ShardingSphereURLLoader.java
index e5411bc4162..a703bcfc69d 100644
--- a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/ShardingSphereURLProvider.java
+++ b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/ShardingSphereURLLoader.java
@@ -21,10 +21,10 @@ import org.apache.shardingsphere.infra.spi.annotation.SingletonSPI;
 import org.apache.shardingsphere.infra.spi.type.typed.TypedSPI;
 
 /**
- * ShardingSphere URL provider.
+ * ShardingSphere URL loader.
  */
 @SingletonSPI
-public interface ShardingSphereURLProvider extends TypedSPI {
+public interface ShardingSphereURLLoader extends TypedSPI {
     
     /**
      * Get configuration content from URL.
diff --git a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProvider.java b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLLoader.java
similarity index 92%
rename from jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProvider.java
rename to jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLLoader.java
index 29152c88d3a..cee6e1a965e 100644
--- a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProvider.java
+++ b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLLoader.java
@@ -19,7 +19,7 @@ package org.apache.shardingsphere.driver.jdbc.core.driver.url.type;
 
 import lombok.SneakyThrows;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURL;
-import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider;
+import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.arg.URLArgumentPlaceholderTypeFactory;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.reader.ConfigurationContentReader;
 
@@ -29,9 +29,9 @@ import java.io.InputStream;
 import java.nio.file.Files;
 
 /**
- * Absolute path URL provider.
+ * Absolute path URL loader.
  */
-public final class AbsolutePathURLProvider implements ShardingSphereURLProvider {
+public final class AbsolutePathURLLoader implements ShardingSphereURLLoader {
     
     @Override
     @SneakyThrows(IOException.class)
diff --git a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProvider.java b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLLoader.java
similarity index 94%
rename from jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProvider.java
rename to jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLLoader.java
index a5faf11fd8f..26674b9ea32 100644
--- a/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProvider.java
+++ b/jdbc/core/src/main/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLLoader.java
@@ -20,7 +20,7 @@ package org.apache.shardingsphere.driver.jdbc.core.driver.url.type;
 import com.google.common.base.Preconditions;
 import lombok.SneakyThrows;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURL;
-import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider;
+import org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.arg.URLArgumentPlaceholderTypeFactory;
 import org.apache.shardingsphere.driver.jdbc.core.driver.url.reader.ConfigurationContentReader;
 
@@ -28,9 +28,9 @@ import java.io.IOException;
 import java.io.InputStream;
 
 /**
- * Class path URL provider.
+ * Class path URL loader.
  */
-public final class ClassPathURLProvider implements ShardingSphereURLProvider {
+public final class ClassPathURLLoader implements ShardingSphereURLLoader {
     
     @Override
     @SneakyThrows(IOException.class)
diff --git a/jdbc/core/src/main/resources/META-INF/services/org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider b/jdbc/core/src/main/resources/META-INF/services/org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader
similarity index 96%
rename from jdbc/core/src/main/resources/META-INF/services/org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider
rename to jdbc/core/src/main/resources/META-INF/services/org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader
index 429b0bbb055..5012c9984bc 100644
--- a/jdbc/core/src/main/resources/META-INF/services/org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLProvider
+++ b/jdbc/core/src/main/resources/META-INF/services/org.apache.shardingsphere.driver.jdbc.core.driver.url.ShardingSphereURLLoader
@@ -15,5 +15,5 @@
 # limitations under the License.
 #
 
-org.apache.shardingsphere.driver.jdbc.core.driver.url.type.ClassPathURLProvider
-org.apache.shardingsphere.driver.jdbc.core.driver.url.type.AbsolutePathURLProvider
+org.apache.shardingsphere.driver.jdbc.core.driver.url.type.ClassPathURLLoader
+org.apache.shardingsphere.driver.jdbc.core.driver.url.type.AbsolutePathURLLoader
diff --git a/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProviderTest.java b/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProviderTest.java
index d4082fd931f..5988e6dff0f 100644
--- a/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProviderTest.java
+++ b/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/AbsolutePathURLProviderTest.java
@@ -45,7 +45,7 @@ class AbsolutePathURLProviderTest {
     }
     
     private void assertGetContent(final int expectedLength) {
-        byte[] actual = new AbsolutePathURLProvider().getContent(
+        byte[] actual = new AbsolutePathURLLoader().getContent(
                 mockURL(Objects.requireNonNull(Thread.currentThread().getContextClassLoader().getResource("config/driver/foo-driver-fixture.yaml")).getPath()));
         assertThat(actual.length, is(expectedLength));
     }
diff --git a/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProviderTest.java b/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProviderTest.java
index 182f7488ae6..cf949f3bd02 100644
--- a/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProviderTest.java
+++ b/jdbc/core/src/test/java/org/apache/shardingsphere/driver/jdbc/core/driver/url/type/ClassPathURLProviderTest.java
@@ -43,7 +43,7 @@ class ClassPathURLProviderTest {
     }
     
     private void assertGetContent(final int expectedLength) {
-        assertThat(new ClassPathURLProvider().getContent(mockURL()).length, is(expectedLength));
+        assertThat(new ClassPathURLLoader().getContent(mockURL()).length, is(expectedLength));
     }
     
     private ShardingSphereURL mockURL() {