ChatGPT、Java 8 文档、MySQL都说 JDBC 没必要 `Class.forName()`,结果报错了……

news/2024/7/17 13:58:35

文章目录

    • 回顾 Tomcat 部署 WAR 应用报错找不到数据库驱动的问题
    • ChatGPT、Javadoc 和 MySQL 驱动都说没必要 `Class.forName()`
    • 实验
      • 创建一个最小复现问题的 Demo
      • 不调用 `Class.forName("com.mysql.cj.jdbc.Driver")`
      • 调用 `Class.forName("com.mysql.cj.jdbc.Driver")`
    • 为什么找不到驱动?原因很简单
      • Java 8 源码
      • Java 17 源码
      • 结论

前段时间,有同学在使用 Apache ShardingSphere-JDBC 时遇到报错 java.sql.SQLException: No suitable driver。经过调查,发现这个问题和使用独立 Tomcat 部署应用有关。

相信做 Java 的同学对以下这段代码都不陌生。JDBC 获取一个数据库连接,然后使用这个连接做增删改查操作。

Class.forName("com.mysql.jdbc.Driver");
Connection conn = DriverManager.getConnection("jdbc:mysql://127.0.0.1:3306");

自 Java 引入 SPI 机制后,JDBC 的驱动可以注册为 SPI 的实现类,一般情况无须再通过 Class.forName 加载。但是,有些场景

探究独立 Tomcat 报错 java.sql.SQLException: No suitable driver 的根本原因

回顾 Tomcat 部署 WAR 应用报错找不到数据库驱动的问题

经历过 Tomcat 部署 WAR 包的开发者,可能多少都有遇到过,明明项目的 lib 目录下已经有了数据库驱动,但是应用却仍然报错 No suitable driver

getConnection: no suitable driver found for jdbc:mysql://127.0.0.1:3306
java.sql.SQLException: No suitable driver found for jdbc:mysql://127.0.0.1:3306
        at java.sql.DriverManager.getConnection(DriverManager.java:689)
        at java.sql.DriverManager.getConnection(DriverManager.java:247)
        at icu.wwj.hello.tomcat.driverdemo.HelloServlet.doGet(HelloServlet.java:18)

当然,去网上查一下会有很多解决方法的搜索结果,主要都是:

  • 确保已经添加了驱动;
  • 检查 JDBC URL 确保没有写错;
  • 把驱动放进 Tomcat 的 lib 目录(甚至有放进 JRE lib 目录的方法);
  • 获取连接前先调用 Class.forName("com.mysql.jdbc.Driver")
  • ……

至此,基本大多数场景找不到驱动的问题都能解决。但是,为什么把驱动放进 Tomcat 的 lib 目录,或者先调用 Class.forName() 能够解决问题?

看看 ChatGPT 提供的答案:
在这里插入图片描述

看起来与 Tomcat 的类加载器、部署机制有关系。

ChatGPT、Javadoc 和 MySQL 驱动都说没必要 Class.forName()

ChatGPT 的说法:
在这里插入图片描述

JDK 8 的 DriverManager 的 javadoc 中有这么一段话:

Applications no longer need to explicitly load JDBC drivers using Class.forName(). Existing programs which currently load JDBC drivers using Class.forName() will continue to work without modification.

意思就是应用程序不再需要通过 Class.forName() 显式加载 JDBC 驱动了,已有的程序这么干了也没问题。

在这里插入图片描述

追踪了一下历史,这段话在 GitHub OpenJDK 仓库的初始提交 中就已经存在了,所以是谁在什么时候写的也就不知道了。

就连 MySQL Connector/J 8.0.x 也输出警告说:驱动自动通过 SPI 注册,没有必要手动加载驱动类了:

package com.mysql.jdbc;

import java.sql.SQLException;

/**
 * Backwards compatibility to support apps that call <code>Class.forName("com.mysql.jdbc.Driver");</code>.
 */
public class Driver extends com.mysql.cj.jdbc.Driver {
    public Driver() throws SQLException {
        super();
    }

    static {
        System.err.println("Loading class `com.mysql.jdbc.Driver'. This is deprecated. The new driver class is `com.mysql.cj.jdbc.Driver'. "
                + "The driver is automatically registered via the SPI and manual loading of the driver class is generally unnecessary.");
    }
}

在 JDK 9,这套说辞被改掉了:

在这里插入图片描述

DriverManager 的驱动加载变成了懒加载,并使用线程上下文累加载器触发 SPI 机制加载驱动。应用程序加载和可用的驱动程序将取决于触发驱动程序初始化的线程的线程上下文类加载器。

虽然 SPI 加载驱动的时机做了调整,但一般情况下不需要显式调用 Class.forName 这点还是不变的。

实验

创建一个最小复现问题的 Demo

准备一个独立 Tomcat 并写一个简单的 Servlet,通过调试和源码分析为什么使用独立 Tomcat 会遇到 No suitable driver 的问题。

题外话:以前学习 Servlet 的时候都没有用过注解,都是在 web.xml 写一堆配置。使用自 Servlet 3.0 的注解,写一个 Servlet 的 hello, world 快多了,不需要像以前那样在 web.xml 写一堆配置了。

实现一个 HTTP GET 方法,在里面尝试获取数据库连接。

import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;

@WebServlet(name = "driver", value = "/driver")
public class HelloServlet extends HttpServlet {
    
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
        response.setContentType("text/plain");
        DriverManager.setLogWriter(response.getWriter()); // 将 JDBC 日志直接输出到 HTTP 响应
        // try { Class.forName("com.mysql.cj.jdbc.Driver"); } catch (ClassNotFoundException e) { response.getWriter().println(e); }
        try (Connection c = DriverManager.getConnection("jdbc:mysql://127.0.0.1:3306", "root", "root")) {
            response.getWriter().println("Connected to MySQL " + c.getMetaData().getDatabaseProductVersion());
        } catch (Exception ex) {
            response.getWriter().println();
        }
    }
}

不调用 Class.forName("com.mysql.cj.jdbc.Driver")

考虑到不同版本 Java 的 DriverManager 存在差异,尝试过以下版本,均发生同样的错误:

  • Java 8
  • Java 17
  • Java 20(本文编写时 Java 已发布的最新版本)

Java 8 输出结果如下,Java 17 与 Java 20 的输出除了 DriverManager.java 的行数不一样外,其他完全一样。

$ curl -s 127.0.0.1:8080/driver

DriverManager.getConnection("jdbc:mysql://127.0.0.1:3306")
getConnection: no suitable driver found for jdbc:mysql://127.0.0.1:3306
java.sql.SQLException: No suitable driver found for jdbc:mysql://127.0.0.1:3306
	at java.sql.DriverManager.getConnection(DriverManager.java:689)
	at java.sql.DriverManager.getConnection(DriverManager.java:247)
	at icu.wwj.hello.tomcat.driverdemo.HelloServlet.doGet(HelloServlet.java:18)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:529)
# ... 省略 Tomcat 调用栈	
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
	at java.lang.Thread.run(Thread.java:750)
SQLException: SQLState(08001)

调用 Class.forName("com.mysql.cj.jdbc.Driver")

数据库操作正常执行。

$ curl -s 127.0.0.1:8080/driver

registerDriver: com.mysql.cj.jdbc.Driver@547a2eb2
DriverManager.getConnection("jdbc:mysql://127.0.0.1:3306")
    trying com.mysql.cj.jdbc.Driver
getConnection returning com.mysql.cj.jdbc.Driver
Connected to MySQL 5.7.36

接下来笔者将探究问题的根本原因。

为什么找不到驱动?原因很简单

Java 8 源码

本节源码选自 JDK Azul Zulu Community 1.8.0_372

DriverManager 在 static 方法中通过系统变量、配置文件、SPI 加载 JDBC 驱动。

java.sql.DriverManager 源码节选

public class DriverManager {

    // List of registered JDBC drivers
    private final static CopyOnWriteArrayList<DriverInfo> registeredDrivers = new CopyOnWriteArrayList<>();

// 省略部分代码
	
    /**
     * 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");
    }
// 省略其余代码

打个断点调试发现,loadInitialDrivers() 方法执行完后,registeredDrivers 却是空的。查看代码调用栈,发现目前正处于 Tomcat 的启动阶段。MySQL JDBC 驱动在应用 WAR 包内,而应用的 WAR 包是在 Tomcat 启动完成后才开始加载的。

在这里插入图片描述

也就是,Tomcat 正在启动的时候就已经初始化了类 DriverManager,但此时 WAR 包还没有部署,所以 DriverManager 通过 SPI 加载不到任何驱动

Java 17 源码

Java 17 的 DriverManager 已经不在 static 代码块中调用 SPI 加载 JDBC 驱动类了,但问题的表现与 Java 8 却是一致的。调试发现,问题其实还是与 Tomcat 有关。
在这里插入图片描述
Tomcat 的 JreMemoryLeakPreventionListener.java 会调用一次 DriverManager.getDrivers() 方法,正是这个方法调用触发了 DriverManager 使用 SPI 加载驱动。

在这里插入图片描述

虽然 DriverManager 通过 SPI 加载驱动的时机变化了,但加载还是只会进行一次。所以后续通过 WAR 包部署应用,DriverManager 不会再通过 SPI 加载驱动了。

结论

  • java.sql.DriverManager 只会调用一次 SPI 加载 JDBC 驱动;
  • Tomcat 在启动时,部署 WAR 包应用前,调用了 DriverManager 的方法,触发了 SPI 加载机制;

于是,WAR 包中的 JDBC 驱动错过了 SPI JDBC 驱动加载,驱动无法自动注册。


http://lihuaxi.xjx100.cn/news/1175496.html

相关文章

Go 中的随机性测试

&#x1f447;我在这儿 这是关于 Go 语言模糊测试的四部分教程系列的第一部分: 1、Go 语言中的随机测试 2、Go 语言中的模糊测试 3、写一个 Go 语言的模糊测试目标(即将推出) 4、通过模糊化发现漏洞(即将推出) 为我们的 Go 程序选择好的测试用例有点看运气。有时我们很幸运找到…

Error: Flash Download failed - Target DLL has been cancelled

文章目录 背景参考 背景 在使用keilv5进行STM32开发时&#xff0c;配置用JLink进行文件烧录&#xff0c;出现如下错误&#xff1a; 查阅资料&#xff0c;是因为Keil未识别烧录工具&#xff0c;需要进行下面的操作&#xff1a; 1.打开工程配置窗口&#xff0c;点开Debug选项卡…

3D图像双线性插值

文章目录 前言结论说明&#xff1a;公式 测试 前言 看了一下2d图像的双线性插值的理论&#xff0c;基本上都是在原图上找到对应的浮点坐标 p f p_f pf​后&#xff0c;将以 p f p_f pf​外围的4个点进行计算。计算的方法类似于二维直线方程的理论&#xff0c;但是写成了权重的…

数据结构 第四章:串

文章目录 一、串的定义和实现1.1串的定义和基本操作1.1.1串的定义1.1.2串的基本操作1.1.3小结 1.2串的存储结构1.2.1顺序存储1.2.2链式存储1.2.3基于顺序存储实现基本操作1.2.4小结 二、串的模式匹配2.1什么是字符串的模式匹配2.2朴素模式匹配算法2.3KMP算法2.4求next数组2.5KM…

Rinne Loves Graph

Rinne Loves Graph (nowcoder.com) 链接&#xff1a;登录—专业IT笔试面试备考平台_牛客网 来源&#xff1a;牛客网 题目描述 Island 发生了一场暴乱&#xff01;现在 Rinne 要和 Setsuna 立马到地上世界去。 众所周知&#xff1a;Island 是有一些奇怪的城镇和道路构成的…

如何用海外代理辅助对接 ChatGPT

许多朋友问我有没有好用的海外代理。说实话&#xff0c;真的好用的并不多。 最近我了解到了一家还不错的海外代理&#xff0c;叫做 IPIDEA&#xff0c;我已经使用了一段时间了&#xff0c;觉得质量挺不错。 你可能知道&#xff0c;我最近在进行一些 ChatGPT 相关的研究&#xf…

平衡二叉树的插入,删除以及平衡调整。

一&#xff0c;平衡二叉树插入失衡情况及解决方案 由于各种的插入导致的不平衡&#xff0c;每次调整都是最小不平衡子树。 LL&#xff1a;由于在结点A的 左孩子的左子树 插入结点导致失衡。 右单旋&#xff1a;①将A的 左孩子B 向右上旋转 代替A成为根节点       ②将A结…

springboot+vue广场舞团系统(java项目源码+文档)

风定落花生&#xff0c;歌声逐流水&#xff0c;大家好我是风歌&#xff0c;混迹在java圈的辛苦码农。今天要和大家聊的是一款基于springboot的广场团舞系统。项目源码以及部署相关请联系风歌&#xff0c;文末附上联系信息 。 &#x1f495;&#x1f495;作者&#xff1a;风歌&a…