feature: auto get driver class name (#91)

* feat: add get driver class name api

* feat: update frontend resources

* fix: checkstyle

core/build.gradle

@@ -30,11 +30,12 @@ dependencies {
     implementation 'com.auth0:java-jwt:3.18.3'
     implementation 'org.commonmark:commonmark:0.18.1'
     implementation 'com.github.javafaker:javafaker:1.0.2'
+    implementation 'commons-io:commons-io'
     implementation 'com.alibaba:easyexcel'
     implementation "org.freemarker:freemarker"
 
-    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
-    implementation 'com.squareup.retrofit2:converter-jackson:2.9.0'
+    implementation "com.squareup.retrofit2:retrofit:${retrofitVersion}"
+    implementation "com.squareup.retrofit2:converter-jackson:${retrofitVersion}"
 
     // test
     testImplementation "mysql:mysql-connector-java:${mysqlConnectorVersion}"

core/src/main/java/com/databasir/core/domain/DomainErrors.java

@@ -43,6 +43,7 @@ public enum DomainErrors implements DatabasirErrors {
     DUPLICATE_COLUMN("A_10028", "重复的列"),
     INVALID_MOCK_DATA_SCRIPT("A_10029", "不合法的表达式"),
     CANNOT_DELETE_SELF("A_10030", "无法对自己执行删除账号操作"),
+    DRIVER_CLASS_NAME_OBTAIN_ERROR("A_10031", "获取驱动类名失败"),
     ;
 
     private final String errCode;

core/src/main/java/com/databasir/core/domain/database/data/DriverClassNameResolveRequest.java

@@ -0,0 +1,15 @@
+package com.databasir.core.domain.database.data;
+
+import lombok.Data;
+
+import javax.validation.constraints.NotBlank;
+
+@Data
+public class DriverClassNameResolveRequest {
+
+    private String databaseType;
+
+    @NotBlank
+    private String jdbcDriverFileUrl;
+
+}

core/src/main/java/com/databasir/core/domain/database/data/DriverDownloadRequest.java

@@ -0,0 +1,16 @@
+package com.databasir.core.domain.database.data;
+
+import lombok.Data;
+
+import javax.validation.constraints.NotBlank;
+
+@Data
+public class DriverDownloadRequest {
+
+    @NotBlank
+    private String databaseType;
+
+    @NotBlank
+    private String jdbcDriverFileUrl;
+
+}

core/src/main/java/com/databasir/core/domain/database/service/DatabaseTypeService.java

@@ -107,4 +107,9 @@ public class DatabaseTypeService {
         return databaseTypeDao.selectOptionalById(id)
                 .map(databaseTypePojoConverter::toDetailResponse);
     }
+
+    public String resolveDriverClassName(DriverClassNameResolveRequest request) {
+        return driverResources.resolveSqlDriverNameFromJar(request.getJdbcDriverFileUrl());
+    }
+
 }

core/src/main/java/com/databasir/core/infrastructure/connection/CustomDatabaseConnectionFactory.java

@@ -10,7 +10,6 @@ import org.springframework.core.annotation.Order;
 import org.springframework.stereotype.Component;
 
 import java.io.File;
-import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 import java.net.MalformedURLException;
 import java.net.URL;
@@ -38,14 +37,7 @@ public class CustomDatabaseConnectionFactory implements DatabaseConnectionFactor
     @Override
     public Connection getConnection(Context context) throws SQLException {
         DatabaseTypePojo type = databaseTypeDao.selectByDatabaseType(context.getDatabaseType());
-        File driverFile;
-        try {
-            driverFile = driverResources.download(context.getDatabaseType(), type.getJdbcDriverFileUrl());
-        } catch (IOException e) {
-            log.error("download driver error " + context, e);
-            throw DomainErrors.DOWNLOAD_DRIVER_ERROR.exception(e.getMessage());
-        }
-
+        File driverFile = driverResources.loadOrDownload(context.getDatabaseType(), type.getJdbcDriverFileUrl());
         URLClassLoader loader = null;
         try {
             loader = new URLClassLoader(
@@ -58,6 +50,7 @@ public class CustomDatabaseConnectionFactory implements DatabaseConnectionFactor
             log.error("load driver error " + context, e);
             throw DomainErrors.CONNECT_DATABASE_FAILED.exception(e.getMessage());
         }
+        // retrieve the driver class
 
         Class<?> clazz = null;
         Driver driver = null;
@@ -68,9 +61,9 @@ public class CustomDatabaseConnectionFactory implements DatabaseConnectionFactor
             log.error("init driver error", e);
             throw DomainErrors.CONNECT_DATABASE_FAILED.exception("驱动初始化异常, 请检查 Driver name：" + e.getMessage());
         } catch (InvocationTargetException
-                | InstantiationException
-                | IllegalAccessException
-                | NoSuchMethodException e) {
+                 | InstantiationException
+                 | IllegalAccessException
+                 | NoSuchMethodException e) {
             log.error("init driver error", e);
             throw DomainErrors.CONNECT_DATABASE_FAILED.exception("驱动初始化异常：" + e.getMessage());
         }

core/src/main/java/com/databasir/core/infrastructure/driver/DriverResources.java

@@ -3,18 +3,19 @@ package com.databasir.core.infrastructure.driver;
 import com.databasir.core.domain.DomainErrors;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.io.IOUtils;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.HttpMethod;
 import org.springframework.stereotype.Component;
 import org.springframework.util.StreamUtils;
 import org.springframework.web.client.RestTemplate;
 
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
+import java.io.*;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.UUID;
+import java.util.jar.JarFile;
 
 @Component
 @Slf4j
@@ -26,44 +27,8 @@ public class DriverResources {
 
     private final RestTemplate restTemplate;
 
-    public File download(String databaseType, String driverFileUrl) throws IOException {
-        // create parent directory
-        if (Files.notExists(Path.of(driverBaseDirectory))) {
-            Files.createDirectory(Path.of(driverBaseDirectory));
-        }
-
-        String filePath = driverPath(databaseType);
-        Path path = Path.of(filePath);
-        if (Files.exists(path)) {
-            // ignore
-            log.debug("{} already exists, ignore download from {}", filePath, driverFileUrl);
-            return path.toFile();
-        } else {
-            // download
-            try {
-                return restTemplate.execute(driverFileUrl, HttpMethod.GET, null, response -> {
-                    if (response.getStatusCode().is2xxSuccessful()) {
-                        File file = path.toFile();
-                        StreamUtils.copy(response.getBody(), new FileOutputStream(file));
-                        log.info("{} download success ", filePath);
-                        return file;
-                    } else {
-                        log.error("{} download error from {}: {} ", filePath, driverFileUrl, response);
-                        throw DomainErrors.DOWNLOAD_DRIVER_ERROR.exception("驱动下载失败："
-                                + response.getStatusCode()
-                                + ", "
-                                + response.getStatusText());
-                    }
-                });
-            } catch (IllegalArgumentException e) {
-                log.error(filePath + " download driver error", e);
-                throw DomainErrors.DOWNLOAD_DRIVER_ERROR.exception(e.getMessage());
-            }
-        }
-    }
-
     public void delete(String databaseType) {
-        Path path = Paths.get(driverPath(databaseType));
+        Path path = Paths.get(driverFilePath(driverBaseDirectory, databaseType));
         try {
             Files.deleteIfExists(path);
         } catch (IOException e) {
@@ -71,13 +36,106 @@ public class DriverResources {
         }
     }
 
-    private String driverPath(String databaseType) {
+    public String resolveSqlDriverNameFromJar(String driverFileUrl) {
+        String tempFilePath = "temp/" + UUID.randomUUID() + ".jar";
+        File driverFile = doDownload(driverFileUrl, tempFilePath);
+        String className = doResolveSqlDriverNameFromJar(driverFile);
+        try {
+            Files.deleteIfExists(driverFile.toPath());
+        } catch (IOException e) {
+            log.error("delete driver error " + tempFilePath, e);
+        }
+        return className;
+    }
+
+    public File loadOrDownload(String databaseType, String driverFileUrl) {
+        String filePath = driverFilePath(driverBaseDirectory, databaseType);
+        Path path = Path.of(filePath);
+        if (Files.exists(path)) {
+            // ignore
+            log.debug("{} already exists, ignore download from {}", filePath, driverFileUrl);
+            return path.toFile();
+        }
+        return this.doDownload(driverFileUrl, filePath);
+    }
+
+    private File doDownload(String driverFileUrl, String filePath) {
+        Path path = Path.of(filePath);
+
+        // create parent directory
+        if (Files.notExists(path)) {
+            path.getParent().toFile().mkdirs();
+            try {
+                Files.createFile(path);
+            } catch (IOException e) {
+                log.error("create file error " + filePath, e);
+                throw DomainErrors.DOWNLOAD_DRIVER_ERROR.exception(e.getMessage());
+            }
+        }
+
+        // download
+        try {
+            return restTemplate.execute(driverFileUrl, HttpMethod.GET, null, response -> {
+                if (response.getStatusCode().is2xxSuccessful()) {
+                    File file = path.toFile();
+                    FileOutputStream out = new FileOutputStream(file);
+                    StreamUtils.copy(response.getBody(), out);
+                    IOUtils.closeQuietly(out, ex -> log.error("close file error", ex));
+                    log.info("{} download success ", filePath);
+                    return file;
+                } else {
+                    log.error("{} download error from {}: {} ", filePath, driverFileUrl, response);
+                    throw DomainErrors.DOWNLOAD_DRIVER_ERROR.exception("驱动下载失败："
+                            + response.getStatusCode()
+                            + ", "
+                            + response.getStatusText());
+                }
+            });
+        } catch (IllegalArgumentException e) {
+            log.error(filePath + " download driver error", e);
+            throw DomainErrors.DOWNLOAD_DRIVER_ERROR.exception(e.getMessage());
+        }
+    }
+
+    private String doResolveSqlDriverNameFromJar(File driverFile) {
+        JarFile jarFile = null;
+        try {
+            jarFile = new JarFile(driverFile);
+        } catch (IOException e) {
+            log.error("resolve driver class name error", e);
+            throw DomainErrors.DRIVER_CLASS_NAME_OBTAIN_ERROR.exception(e.getMessage());
+        }
+
+        final JarFile driverJar = jarFile;
+        String driverClassName = jarFile.stream()
+                .filter(entry -> entry.getName().contains("META-INF/services/java.sql.Driver"))
+                .findFirst()
+                .map(entry -> {
+                    InputStream stream = null;
+                    BufferedReader reader = null;
+                    try {
+                        stream = driverJar.getInputStream(entry);
+                        reader = new BufferedReader(new InputStreamReader(stream));
+                        return reader.readLine();
+                    } catch (IOException e) {
+                        log.error("resolve driver class name error", e);
+                        throw DomainErrors.DRIVER_CLASS_NAME_OBTAIN_ERROR.exception(e.getMessage());
+                    } finally {
+                        IOUtils.closeQuietly(reader, ex -> log.error("close reader error", ex));
+                    }
+                })
+                .orElseThrow(DomainErrors.DRIVER_CLASS_NAME_OBTAIN_ERROR::exception);
+        IOUtils.closeQuietly(jarFile, ex -> log.error("close jar file error", ex));
+        return driverClassName;
+    }
+
+    private String driverFilePath(String baseDir, String databaseType) {
         String fileName = databaseType + ".jar";
         String filePath;
-        if (driverBaseDirectory.endsWith(File.separator)) {
-            filePath = driverBaseDirectory + fileName;
+        if (baseDir.endsWith(File.separator)) {
+            filePath = baseDir + fileName;
         } else {
-            filePath = driverBaseDirectory + File.separator + fileName;
+            filePath = baseDir + File.separator + fileName;
         }
         return filePath;
     }