Tomcat配置JNDI数据源连接失败，正确步骤究竟是什么？

配置前的准备工作

在开始配置之前,请确保您已具备以下条件：

1. 一个可用的Tomcat服务器：确保Tomcat已正确安装并能正常启动。
2. 数据库JDBC驱动程序：根据您使用的数据库（如MySQL, PostgreSQL, Oracle等），下载对应的JDBC驱动JAR包，对于MySQL，您需要mysql-connector-java-x.x.x.jar。
3. 数据库连接信息：准备好数据库的URL、用户名和密码。

核心配置步骤

配置JNDI数据源主要涉及两个层面：在Tomcat服务器层面定义资源，以及在Web应用层面引用该资源。

步骤1：在Tomcat中定义数据源资源

最常见和推荐的方式是在Tomcat的context.xml文件中定义<Resource>元素，该文件位于$CATALINA_BASE/conf目录下，在此处配置的数据源对所有部署在该Tomcat实例上的Web应用都可见（全局配置），当然也可以为单个应用进行配置。

打开$CATALINA_BASE/conf/context.xml文件，在<Context>标签内添加如下配置：

<Context>
    <!-- ... 其他配置 ... -->
    <!-- 定义一个名为 jdbc/MyDataSource 的JNDI数据源 -->
    <Resource name="jdbc/MyDataSource"
              auth="Container"
              type="javax.sql.DataSource"
              driverClassName="com.mysql.cj.jdbc.Driver"
              url="jdbc:mysql://localhost:3306/your_database?useSSL=false&amp;serverTimezone=UTC"
              username="your_username"
              password="your_password"
              maxTotal="20"
              maxIdle="10"
              maxWaitMillis="10000"
              validationQuery="SELECT 1"
              testOnBorrow="true"/>
    <!-- ... 其他配置 ... -->
</Context>

关键属性解释：

• name：JNDI名称，Web应用将通过此名称查找数据源，通常以jdbc/开头作为约定。
• auth：认证方式，通常设为Container，表示由容器管理认证。
• type：资源类型，对于数据源，固定为javax.sql.DataSource。
• driverClassName：JDBC驱动的完整类名。
• url：数据库连接URL，注意，XML中的&字符需要转义为&。
• username / password：数据库登录凭据。
• maxTotal：连接池中允许存在的最大连接数。
• maxIdle：连接池中保持空闲的最大连接数。
• maxWaitMillis：当连接池中无可用连接时，获取连接的最长等待时间（毫秒），超过此时间将抛出异常。
• validationQuery：用于验证连接是否有效的SQL语句，简单的SELECT 1对大多数数据库都适用。
• testOnBorrow：设置为true，表示从连接池借用连接时，会执行validationQuery进行验证，确保获取到的连接是有效的。

步骤2：在Web应用中引用数据源

为了让您的Web应用能够使用Tomcat中定义的数据源,需要在应用的WEB-INF/web.xml部署描述符文件中声明对该资源的引用。

在web.xml文件中添加<resource-ref>元素：

<web-app ...>
    <!-- ... 其他配置 ... -->
    <resource-ref>
        <description>MySQL DataSource</description>
        <res-ref-name>jdbc/MyDataSource</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>
    <!-- ... 其他配置 ... -->
</web-app>

注意：<res-ref-name>的值必须与context.xml中<Resource>的name属性值完全一致。

步骤3：在Java代码中获取并使用连接

配置完成后,您就可以在Servlet、Filter、Listener或其他Java类中通过JNDI查找来获取数据源，并从中获取数据库连接了。

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;
public class DBUtil {
    private static DataSource dataSource;
    static {
        try {
            // 初始化JNDI上下文
            Context initContext = new InitialContext();
            // 在Java:comp/env环境中查找JNDI资源
            Context envContext = (Context) initContext.lookup("java:comp/env");
            // 获取数据源
            dataSource = (DataSource) envContext.lookup("jdbc/MyDataSource");
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException("Failed to lookup datasource", e);
        }
    }
    public static Connection getConnection() throws SQLException {
        // 从数据源获取连接
        return dataSource.getConnection();
    }
}

通过这种方式,每次调用DBUtil.getConnection()时，实际上是从Tomcat管理的连接池中获取一个连接，用完后只需调用connection.close()即可将连接返回池中，而非真正关闭物理连接。

配置作用域与连接池参数详解

配置文件的作用域

context.xml文件可以存在于不同位置，其作用域也不同。

常用连接池参数

合理调优连接池参数对应用性能至关重要。

相关问答FAQs

Q1：我已经按照步骤配置完毕，但在应用启动时或获取连接时抛出了ClassNotFoundException: com.mysql.cj.jdbc.Driver异常，这是为什么？

A1： 这个异常意味着Tomcat在加载数据源配置时，找不到指定的JDBC驱动类，解决方法非常直接：将您下载的数据库JDBC驱动JAR包（例如mysql-connector-java-x.x.x.jar）复制到Tomcat安装目录下的lib文件夹中（例如$CATALINA_HOME/lib），因为数据源是由Tomcat容器创建和管理的，所以驱动必须被容器的类加载器加载，而不是放在您Web应用的WEB-INF/lib下，放置后，重启Tomcat服务器即可解决问题。

Q2：将数据库用户名和密码明文写在context.xml中是否安全？有没有更安全的做法？

A2： 直接在context.xml中以明文存储密码确实存在安全风险，尤其是在生产环境中，更安全的做法包括：

1. 使用加密属性：Tomcat支持对Resource的属性进行加密，您可以使用Tomcat提供的脚本或自定义工具对密码进行加密，然后在context.xml中配置使用加密后的字符串，并提供解密所需的类和密钥。
2. 利用操作系统层面的安全机制：某些操作系统提供了安全存储（如密钥环、保险箱），可以通过配置让Tomcat从这些安全存储中读取凭据。
3. 使用外部配置管理工具：在微服务架构中，通常会使用Spring Cloud Config、Apollo或Nacos等配置中心来统一管理敏感信息，应用在启动时动态加载，对于传统的Tomcat部署，这种方式集成起来相对复杂，但提供了最高的灵活性和安全性，对于大多数中小型项目，至少应该采用第一种方式对密码进行加密存储。