JDBC API 4.2（三）：DriverManager 源码分析

旧城等待， 2023-06-13 09:37 5阅读 0赞

### 文章目录 ###

*   *  1、简述
     *  2、什么是 Driver
     *   *  2.1、Driver 接口源码
         *   *  2.1.1、Connection connect(String url, java.util.Properties info)
             *  2.1.2、 boolean acceptsURL(String url)
             *  2.1.3、DriverPropertyInfo\[\] getPropertyInfo(String url, java.util.Properties info)
             *  2.1.4、int getMajorVersion()
             *  2.1.5、int getMinorVersion()
             *  2.1.6、boolean jdbcCompliant()
             *  2.1.7、Logger getParentLogger()
     *  3、Class.forName() 手动加载驱动
     *  4、DriverManager 源码分析
     *   *  4.1、DriverManager 加载驱动
         *  4.2、DriverManager 注册驱动
         *  4.3、DriverManager 取消注册驱动
         *  4.4、DriverManager 创建连接

## 1、简述 ##

DriverManager 是用于管理JDBC驱动程序的基础服务。DriverManger 可以注册、删除、加载的驱动程序，可以根据给定的url获取符合url协议的驱动Driver 并建立Conenction连接，进行数据库交互。当DriverManager被使用时，DriverManager类将尝试加载“ jdbc.drivers”系统属性中的驱动程序类。

JDBC 4.0驱动程序必须包含文件 META-INF/services/java.sql.Driver，该文件包含了实现java.sql.Driver的JDBC驱动程序的名称。例如，要加载my.sql.Driver类，META-INF/services/java.sql.Driver文件中将包含以下内容：my.sql.Driver。

使用DriverManager之后，应用程序不再需要使用 Class.forName() 显式加载JDBC驱动程序了。已经使用 Class.forName() 显式加载JDBC驱动的程序也不会受到影响，也无需刻意去修改。

当调用方法getConnection时，DriverManager将尝试从初始化时加载的驱动程序和当前应用程序显式加载的驱动程序中找到合适的驱动程序。

## 2、什么是 Driver ##

Driver 就是驱动程序，当我们的应用程序需要连接 mysql、oracle 等数据库时，需要一个相应的驱动程序来实现搭桥牵线才行。

一般不同的厂商都会提供相应的数据库驱动程序，来方便应用程序的连接。那么怎么加载不同厂商的数据库驱动呢，有没有一个统一的标准规范呢？答案是有的，那就是 java.sql.Driver 接口，也就是说实现了该接口的类就是驱动类（Driver）。比如MySQL：com.mysql.cj.jdbc.Driver。

### 2.1、Driver 接口源码 ###

DriverManager将尝试加载尽可能多的驱动程序，然后针对任何给定的连接请求，依次要求每个驱动程序尝试连接到目标URL。

#### 2.1.1、Connection connect(String url, java.util.Properties info) ####

/**
         * 尝试建立给定URL的数据库连接。 如果驱动程序意识到连接到给定URL的驱动程序类型错误，则应返回“ null”。 这是很常见的，因为当要求JDBC驱动程序管理器连接到给定的URL时，它将URL依次传递给每个已加载的驱动程序。
         *
         *如果驱动程序是连接到给定URL的正确驱动程序，但在连接数据库时遇到问题，则应引发SQLException。
         *
         注意：如果将属性指定为url的一部分，并且也在Properties对象中指定了属性，则该实现将由实现定义，以哪个值优先。 为了获得最大的可移植性，应用程序应仅指定一次属性。
         *
         * @param url 连接到指定url的数据库地址
         * @param 键值对格式的连接参数，通常会包含用户名和密码
         * @return 与URL的连接的Connection对象
         */
    Connection connect(String url, java.util.Properties info)
            throws SQLException;

#### 2.1.2、 boolean acceptsURL(String url) ####

/**
         * 检索驱动程序是可以打开与给定URL的连接。 通常，如果驱动程序识别出 URL中指定的子协议，则将返回true；否则，将返回false。
         *
         * @param 数据库的URL
         * @return 如果此驱动程序可以理解给定的URL，则为true；否则为false。 否则为假
         * @exception 如果发生数据库访问错误或url为null，将抛出 SQLException
         */
     boolean acceptsURL(String url) throws SQLException;

#### 2.1.3、DriverPropertyInfo\[\] getPropertyInfo(String url, java.util.Properties info) ####

/**
         * 获取有关此驱动程序可能的属性的信息。
         * 
         getPropertyInfo方法旨在允许通用的GUI工具发现应该提示的属性，以便获得足够的信息以连接到数据库。 
         *
         * @param u要连接的数据库的URL
         * @param 连接打开时需要的参数
         * @return 描述属性的DriverPropertyInfo对象的数组。 
         */
        DriverPropertyInfo[] getPropertyInfo(String url, java.util.Properties info)
                             throws SQLException;

#### 2.1.4、int getMajorVersion() ####

/**
         * 获取驱动程序的主版本号。 最初应为1。
         *
         */
    int getMajorVersion();

#### 2.1.5、int getMinorVersion() ####

/**
         * 获取驱动程序的次要版本号。 最初应为0。
         */
     int getMinorVersion();

#### 2.1.6、boolean jdbcCompliant() ####

/**
 *报告此驱动程序是否是正版JDBC Compliant™驱动程序。 如果驱动程序通过了JDBC兼容性测试，则仅在此处报告true。 否则需要返回false。
 * 
 * JDBC合规性要求对JDBC API的完全支持和对SQL 92 Entry Level的完全支持。 期望所有主要的商业数据库都可以使用符合JDBC的驱动程序。
 * 
 */
 boolean jdbcCompliant();

#### 2.1.7、Logger getParentLogger() ####

/**
         *返回此驱动程序使用的所有Logger的父Logger。 这应该是距离根Logger最远的Logger，它仍然是该驱动程序使用的所有Logger的祖先。 配置此Logger将影响驱动程序生成的所有日志消息。 在最坏的情况下，它可能是根Logger。
         * @since 1.7
         */
        public Logger getParentLogger() throws SQLFeatureNotSupportedException;

## 3、Class.forName() 手动加载驱动 ##

Class.forName()将对应的驱动类加载到内存中时，会执行驱动类中的static 静态代码快，创建一个驱动Driver的实例，注册到DriverManager中，供DriverManager使用。

JDBC驱动程序可以创建DriverAction实现，以便在调用DriverManager.deregisterDriver（java.sql.Driver）时接收通知。

//加载Oracle数据库驱动
    Class.forName("oracle.jdbc.driver.OracleDriver");
    
    //加载hive数据库驱动
    Class.forName("org.apache.hive.jdbc.HiveDriver");
    
    //加载MySQL 数据库驱动
    Class.forName("com.mysql.cj.jdbc.Driver");

以MySQL驱动加载为例：

在使用 Class.forName() 加载mysql的驱动 com.mysql.cj.jdbc.Driver 时，会执行 mysql Driver 中的静态代码块，创建一个 mysql Driver 实例，然后调用DriverManager.registerDriver()注册自己

package com.mysql.cj.jdbc;
 
 import java.sql.SQLException;
 
 /**
 * Java SQL框架允许多个数据库驱动程序。 每个驱动程序应提供一个实现Driver接口的类。
 * 
 * 
 * DriverManager将尝试加载尽可能多的驱动程序，然后针对任何给定的连接请求，依次要求每个驱动程序尝试连接到目标URL。
 * 
 * 
 * 强烈建议每个Driver类都应较小且独立，以便可以在不引入大量支持代码的情况下加载和查询Driver类。
 * 
 * 
 * 加载Driver类时，它应该创建其自身的实例并将其注册到DriverManager。 这意味着用户可以通过执行 Class.forName("foo.bah.Driver") 来加载和注册驱动程序
 */
 public class Driver extends NonRegisteringDriver implements java.sql.Driver {
 
 static {
 try {
 java.sql.DriverManager.registerDriver(new Driver());
 } catch (SQLException E) {
 throw new RuntimeException("Can't register driver!");
 }
 }
 
 /**
 * 构造一个新的驱动程序并向DriverManager注册
 * 
 * @throws SQLException
 * if a database error occurs.
 */
 public Driver() throws SQLException {
 // Required for Class.forName().newInstance()
 }
 }

## 4、DriverManager 源码分析 ##

### 4.1、DriverManager 加载驱动 ###

从源码中，我们可以看出 DriverManager 作为 Driver 的管理器，在首次被使用时，会执行其定义的static静态代码块，在静态代码快中，有一个 loadInitialDrivers() 静态方法，会首先加载配置在jdbc.drivers 系统属性内的驱动Driver。

public class DriverManager {
 
 
 // List of registered JDBC drivers
 private final static CopyOnWriteArrayList<DriverInfo> registeredDrivers = new CopyOnWriteArrayList<>();
 private static volatile int loginTimeout = 0;
 private static volatile java.io.PrintWriter logWriter = null;
 private static volatile java.io.PrintStream logStream = null;
 // Used in println() to synchronize logWriter
 private final static Object logSync = new Object();
 
 /* Prevent the DriverManager class from being instantiated. */
 private DriverManager(){}
 
 
 /**
 * Load the initial JDBC drivers by checking the System property
 * jdbc.properties and then use the {@code ServiceLoader} mechanism
 */
 static {
 loadInitialDrivers();
 println("JDBC DriverManager initialized");
 }
 }

下面我们就一起看一下它是如何加载的：

在驱动jar包配置文件中，指定了驱动类实现java.sql.Driver接口；然后DriverManager在初始化的时候，自动扫描所有jar包中实现了java.sql.Driver的类，便可找到并加载驱动类。

private static void loadInitialDrivers() {
 String drivers;
 		//尝试从系统属性"jdbc.drivers"中获取驱动类
 try {
 drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
 public String run() {
 return System.getProperty("jdbc.drivers");
 }
 });
 } catch (Exception ex) {
 drivers = null;
 }
 //使用ServiceLoader 加载驱动程序
 AccessController.doPrivileged(new PrivilegedAction<Void>() {
 public Void run() {
 
 ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
 Iterator<Driver> driversIterator = loadedDrivers.iterator();
 
 // 加载这些驱动程序，以便可以实例化它们。
 try{
 while(driversIterator.hasNext()) {
 driversIterator.next();
 }
 } catch(Throwable t) {
 // Do nothing
 }
 return null;
 }
 });
 
 println("DriverManager.initialize: jdbc.drivers = " + drivers);
 
 if (drivers == null || drivers.equals("")) {
 return;
 }
 String[] driversList = drivers.split(":");
 println("number of Drivers:" + driversList.length);
 		//加载驱动类并实例化
 for (String aDriver : driversList) {
 try {
 println("DriverManager.Initialize: loading " + aDriver);
 Class.forName(aDriver, true,
 ClassLoader.getSystemClassLoader());
 } catch (Exception ex) {
 println("DriverManager.Initialize: load failed: " + ex);
 }
 }
 }

### 4.2、DriverManager 注册驱动 ###

将驱动添加到DriverManager 维护的内存中的集合 registeredDrivers 中。

public static synchronized void registerDriver(java.sql.Driver driver)
            throws SQLException {
    
            registerDriver(driver, null);
        }
    
      
        public static synchronized void registerDriver(java.sql.Driver driver,
                DriverAction da)
            throws SQLException {
    
            /* Register the driver if it has not already been added to our list */
            if(driver != null) {
                registeredDrivers.addIfAbsent(new DriverInfo(driver, da));
            } else {
                // This is for compatibility with the original DriverManager
                throw new NullPointerException();
            }
    
            println("registerDriver: " + driver);
    
        }

### 4.3、DriverManager 取消注册驱动 ###

从集合 registeredDrivers 中移除指定驱动，并告知驱动程序已经被取消注册。

@CallerSensitive
        public static synchronized void deregisterDriver(Driver driver)
            throws SQLException {
            if (driver == null) {
                return;
            }
    
            SecurityManager sec = System.getSecurityManager();
            if (sec != null) {
                sec.checkPermission(DEREGISTER_DRIVER_PERMISSION);
            }
    
            println("DriverManager.deregisterDriver: " + driver);
    
            DriverInfo aDriver = new DriverInfo(driver, null);
            if(registeredDrivers.contains(aDriver)) {
                if (isDriverAllowed(driver, Reflection.getCallerClass())) {
                    DriverInfo di = registeredDrivers.get(registeredDrivers.indexOf(aDriver));
                     // 如果指定了DriverAction，则调用它以通知驱动程序它已被注销。
                     if(di.action() != null) {
                         di.action().deregister();
                     }
                     registeredDrivers.remove(aDriver);
                } else {
                    // If the caller does not have permission to load the driver then
                    // throw a SecurityException.
                    throw new SecurityException();
                }
            } else {
                println("    couldn't find driver to unload");
            }
        }

### 4.4、DriverManager 创建连接 ###

通过遍历已加载的驱动程序，分别尝试连接指定的数据库，如果连接上则返回连接对象。

// Worker method called by the public getConnection() methods.
 private static Connection getConnection(
 String url, java.util.Properties info, Class<?> caller) throws SQLException {
 /*
 * 当callerCl为空时，我们应检查应用程序的类加载器，以便可以从此处加载rt.jar外部的JDBC驱动程序类。
 */
 ClassLoader callerCL = caller != null ? caller.getClassLoader() : null;
 synchronized(DriverManager.class) {
 // synchronize loading of the correct classloader.
 if (callerCL == null) {
 callerCL = Thread.currentThread().getContextClassLoader();
 }
 }
 
 if(url == null) {
 throw new SQLException("The url cannot be null", "08001");
 }
 
 println("DriverManager.getConnection(\"" + url + "\")");
 
 // 遍历每个驱动尝试连接指定的数据库地址
 SQLException reason = null;
 
 for(DriverInfo aDriver : registeredDrivers) {
 // If the caller does not have permission to load the driver then
 // skip it.
 if(isDriverAllowed(aDriver.driver, callerCL)) {
 try {
 println(" trying " + aDriver.driver.getClass().getName());
 Connection con = aDriver.driver.connect(url, info);
 if (con != null) {
 // Success!
 println("getConnection returning " + aDriver.driver.getClass().getName());
 return (con);
 }
 } catch (SQLException ex) {
 if (reason == null) {
 reason = ex;
 }
 }
 
 } else {
 println(" skipping: " + aDriver.getClass().getName());
 }
 
 }
 
 // if we got here nobody could connect.
 if (reason != null) {
 println("getConnection failed: " + reason);
 throw reason;
 }
 
 println("getConnection: no suitable driver found for "+ url);
 throw new SQLException("No suitable driver found for "+ url, "08001");
 }

> 注意：DataSource接口提供了另一种连接数据源的方法。 使用DataSource对象是连接数据源的首选方法。

参考资料：

https://docs.oracle.com/javase/8/docs/api/java/sql/DriverManager.html

https://docs.oracle.com/javase/8/docs/api/java/sql/Driver.html