JNDI技术扩展

一、什么是JNDI

JNDI的全称是Java Naming and Directory Interface （java命名与目录接口），它是一个有关应用程序设计的API，为开发人员提供了查找和访问各种命名和目录服务的通用接口

JNDI中的命名（Naming），就是将Java对象以某个名称的形式绑定到一个容器环境（Context）中，以后调用容器环境（Context）的查找（lookup）方法又可以查找出某个名称所绑定的Java对象。你也许会感到奇怪：自己创建一个Java对象，将其绑定到JNDI容器环境中后又查询出来，这有什么意思？在真实的项目应用中，通常是由系统程序或框架程序先将资源对象绑定到JNDI环境中，以后在该系统或框架中运行的模块程序就可以从JNDI环境中查找这些资源对象了。例如，Tomcat服务器在启动时可以创建一个连接到某种数据库系统的数据源（DataSource）对象，并将该数据源（DataSource）对象绑定到JNDI环境中，以后在这个Tomcat服务器中运行的Servlet和JSP程序就可以从JNDI环境中查询出这个数据源（DataSource）对象进行使用，而不用关心数据源（DataSource）对象是如何创建出来的，这种方式极大地增强了系统的可维护性，当数据库系统的连接参数发生变更时，这只是Tomcat系统管理员一个人要关心的事情，而与所有的应用程序开发人员无关。 

JNDI中的目录（Directory）与文件系统中的目录概念有很大的不同，JNDI中的目录（Directory）是指将一个对象的所有属性信息保存到一个容器环境中。JNDI的目录（Directory）原理与JNDI的命名（Naming）原理非常相似，主要的区别在于目录容器环境中保存的是对象的属性信息，而不是对象本身，所以，目录提供的是对属性的各种操作。事实上，JNDI的目录（Directory）与命名（Naming）往往是结合在一起使用的，JNDI API中提供的代表目录容器环境的类为DirContext，DirContext是Context的子类，显然它除了能完成目录相关的操作外，也能完成所有的命名（Naming）操作。DirContext是对Context的扩展，它在Context的基础上增加了对目录属性的操作功能，可以在其中绑定对象的属性信息和查找对象的属性信息

二、JNDI + 配置数据源

Tomcat配置

在Tomcat 4.1.27之后，在服务器上就直接增加了数据源的配置选项，直接在服务器上配置好数据源连接池即可。在J2EE服务器上保存着一个数据库的多个连接。每一个连接通过DataSource可以找到。DataSource被绑定在了JNDI树上（为每一个DataSource提供一个名字）客户端通过名称找到在JNDI树上绑定的DataSource，再由DataSource找到一个连接。如下图所示：

 

那么在以后的操作中，除了数据库的连接方式不一样之外，其他的所有操作都一样，只是关闭的时候不是彻底地关闭数据库，而是把数据库的连接放回到连接池中去。

如果要想使用数据源的配置，则必须配置虚拟目录，因为此配置是在虚拟目录之上起作用的。需要注意的是，如果要想完成以上的功能，在Tomcat服务器上一定要有各个数据库的驱动程序。

全局JNDI配置

此种配置需要在server.xml中配置数据源，具体的配置步骤如下：

（1）在tomcat服务器的lib目录下加入数据库连接的驱动jar包（MySQL、Oracle和SQLServer）

（2）修改tomcat服务器的conf目录下server.xml配置文件

打开server.xml配置文件，可以看到里面自带的一个全局JNDI配置，如下图所示：

编辑server.xml文件，添加全局JNDI数据源配置，配置如下

<!-- Global JNDI resources
       Documentation at /docs/jndi-resources-howto.html
  -->
  <GlobalNamingResources>
    <!-- Editable user database that can also be used by
         UserDatabaseRealm to authenticate users
    -->
    <Resource name="UserDatabase" auth="Container"
              type="org.apache.catalina.UserDatabase"
              description="User database that can be updated and saved"
              factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
              pathname="conf/tomcat-users.xml" />
<!--
  |- name：表示以后要查找的名称。通过此名称可以找到DataSource，此名称任意更换，但是程序中最终要查找的就是此名称，
           为了不与其他的名称混淆，所以使用jdbc/oracle，现在配置的是一个jdbc的关于oracle的命名服务。
  |- auth：由容器进行授权及管理，指的用户名和密码是否可以在容器上生效
  |- type：此名称所代表的类型，现在为javax.sql.DataSource
  |- maxTotal：表示一个数据库在此服务器上所能打开的最大连接数
  |- maxIdle：表示一个数据库在此服务器上维持的最小连接数
  |- maxWaitMillis：最大等待时间。10000毫秒
  |- username：数据库连接的用户名
  |- password：数据库连接的密码
  |- driverClassName：数据库连接的驱动程序
  |- url：数据库连接的地址
-->

<!--配置Oracle数据库的JNDI数据源-->
<Resource 
        name="jdbc/oracle"
        auth="Container" 
        type="javax.sql.DataSource"
        maxTotal="100" 
        maxIdle="30" 
        maxWaitMillis="10000"
        username="lead_oams" 
        password="p"
        driverClassName="oracle.jdbc.driver.OracleDriver"
        url="jdbc:oracle:thin:@192.168.1.229:1521:lead"/>
 
<!--配置MySQL数据库的JNDI数据源-->
<Resource 
        name="jdbc/mysql"
        auth="Container" 
        type="javax.sql.DataSource"
        maxTotal="100" 
        maxIdle="30" 
        maxWaitMillis="10000"
        username="root" 
        password="root"
        driverClassName="com.mysql.jdbc.Driver"
        url="jdbc:mysql://192.168.1.144:3306/leadtest?useUnicode=true&amp;characterEncoding=utf-8"/>
 
<!--配置SQLServer数据库的JNDI数据源-->
<Resource 
        name="jdbc/sqlserver"
        auth="Container" 
        type="javax.sql.DataSource"
        maxTotal="100" 
        maxIdle="30" 
        maxWaitMillis="10000"
        username="sa" 
        password="p@ssw0rd"
        driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
        url="jdbc:sqlserver://192.168.1.51:1433;DatabaseName=demo"/>
 
  </GlobalNamingResources>

注意：<Resource/>标签有很多可配置项，可以配置哪些属性取决于你使用哪种数据源（c3p0、dbcp2、Druid），默认是使用dbcp2数据源。name、auth和type这三个属性是一定要配置的

经过以上的两个步骤，全局JNDI数据源就配置好了，在上述的server.xml文件中，分别配置了Oracle、MySQL、SQLServer这三种数据库的全局JNDI数据源。

（3）创建一个JNDI测试项目，项目名JNDITest，在web.xml中添加JNDI配置的资源引用

<!-- 
 JNDI配置的资源引用：
 • res-ref-name：表示引用资源的名称
 • res-type：此资源对应的类型为javax.sql.DataSource
 • res-auth：容器授权管理
  -->
    <!--Oracle数据库JNDI数据源引用 -->
    <resource-ref>
        <description>Oracle DB Connection</description>
        <res-ref-name>oracleDataSource</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>

    <!--MySQL数据库JNDI数据源引用 -->
    <resource-ref>
        <description>MySQL DB Connection</description>
        <res-ref-name>mysqlDataSource</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>

    <!--SQLServer数据库JNDI数据源引用 -->
    <resource-ref>
        <description>SQLServer DB Connection</description>
        <res-ref-name>sqlserverDataSource</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>

（4）映射JNDITest项目的虚拟目录

在tomcat的confCatalinalocalhost下（没有目录就新建）创建一个xml文件，文件名必须和项目的应用上下文（创建项目时默认是项目名）相同，这里我将应用的上下文改为demo，则应该创建的文件名称是demo.xml。

编辑demo.xml，配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--
    jndi配置方法（tomcat）：
    将此文件放置在tomcatconfCatalinalocalhost下（没有目录就新建）
 -->
<!--映射JNDITest项目的虚拟目录-->
<Context docBase="D:/MyEclipse8.5/workspace/JNDITest/WebRoot" debug="0" reloadable="false">
    <!--引用Oracle数据库的JNDI数据源-->
    <ResourceLink name="oracleDataSource" global="jdbc/oracle" type="javax.sql.DataSource"/>
    <!--引用mysql数据库的JNDI数据源-->
    <ResourceLink name="mysqlDataSource" global="jdbc/mysql" type="javax.sql.DataSource"/>
    <!--引用sqlserver数据库的JNDI数据源-->
    <ResourceLink name="sqlserverDataSource" global="jdbc/sqlserver" type="javax.sql.DataSource"/>
</Context>

非全局JNDI配置

非全局JNDI数据源是针对某一个Web项目配置的数据源，具体的配置步骤如下：

（1）在tomcat服务器的lib目录下加入数据库连接的驱动jar包

（2）针对具体的web项目映射虚拟目录，然后在虚拟目录映射的配置文件中配置JNDI数据源

在tomcat目录下的confCatalinalocalhost目录下创建一个demo.xml文件（如果有多个项目就新建多个应用上下文为名称的xml文件），配置内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--
    jndi配置方法（tomcat）：
    将此文件放置在tomcatconfCatalinalocalhost下（没有目录就新建）
 -->
 
<Context docBase="D:/MyEclipse8.5/workspace/JNDITest/WebRoot" debug="0" reloadable="false">

<!--
  |- name：表示以后要查找的名称。通过此名称可以找到DataSource，此名称任意更换，但是程序中最终要查找的就是此名称，
           为了不与其他的名称混淆，所以使用jdbc/oracle，现在配置的是一个jdbc的关于oracle的命名服务。
  |- auth：由容器进行授权及管理，指的用户名和密码是否可以在容器上生效
  |- type：此名称所代表的类型，现在为javax.sql.DataSource
  |- maxTotal：表示一个数据库在此服务器上所能打开的最大连接数
  |- maxIdle：表示一个数据库在此服务器上维持的最小连接数
  |- maxWaitMillis：最大等待时间。10000毫秒
  |- username：数据库连接的用户名
  |- password：数据库连接的密码
  |- driverClassName：数据库连接的驱动程序
  |- url：数据库连接的地址
-->

<!--配置Oracle数据库的JNDI数据源-->
<Resource 
        name="jdbc/oracle"
        auth="Container" 
        type="javax.sql.DataSource"
        maxTotal="100" 
        maxIdle="30" 
        maxWaitMillis="10000"
        username="lead_oams" 
        password="p"
        driverClassName="oracle.jdbc.driver.OracleDriver"
        url="jdbc:oracle:thin:@192.168.1.229:1521:lead"/>
 
<!--配置MySQL数据库的JNDI数据源-->
<Resource 
        name="jdbc/mysql"
        auth="Container" 
        type="javax.sql.DataSource"
        maxTotal="100" 
        maxIdle="30" 
        maxWaitMillis="10000"
        username="root" 
        password="root"
        driverClassName="com.mysql.jdbc.Driver"
        url="jdbc:mysql://192.168.1.144:3306/leadtest?useUnicode=true&amp;characterEncoding=utf-8"/>
 
<!--配置SQLServer数据库的JNDI数据源-->
<Resource 
        name="jdbc/sqlserver"
        auth="Container" 
        type="javax.sql.DataSource"
        maxTotal="100" 
        maxIdle="30" 
        maxWaitMillis="10000"
        username="sa" 
        password="p@ssw0rd"
        driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
        url="jdbc:sqlserver://192.168.1.51:1433;DatabaseName=demo"/>
        
</Context>

（3）在web项目的web.xml文件中引用配置好的JNDI数据源

<!-- 
  JNDI配置的资源引用：
  • res-ref-name：表示引用资源的名称
  • res-type：此资源对应的类型为javax.sql.DataSource
  • res-auth：容器授权管理
   -->
   <!--Oracle数据库JNDI数据源引用 -->
  <resource-ref>
      <description>Oracle DB Connection</description>
      <res-ref-name>oracleDataSource</res-ref-name>
      <res-type>javax.sql.DataSource</res-type>
      <res-auth>Container</res-auth>
 </resource-ref>
  
  <!--MySQL数据库JNDI数据源引用 -->
  <resource-ref>
      <description>MySQL DB Connection</description>
      <res-ref-name>mysqlDataSource</res-ref-name>
      <res-type>javax.sql.DataSource</res-type>
      <res-auth>Container</res-auth>
  </resource-ref>
  
  <!--SQLServer数据库JNDI数据源引用 -->
  <resource-ref>
      <description>SQLServer DB Connection</description>
      <res-ref-name>sqlserverDataSource</res-ref-name>
      <res-type>javax.sql.DataSource</res-type>
      <res-auth>Container</res-auth>
  </resource-ref>

三、使用JNDI查找数据源

配置完数据源连接池之后，就可以按照以下的步骤进行访问：

• 初始化名称查找上下文
• 通过JNDI名称找到DataSource
• 通过DataSource取得一个连接
• 操作数据库
• 关闭数据库，关闭的时候是将连接放回到连接池之中

web项目（带web.xml，不使用Spring）

<%@ page import="java.sql.Connection" %>
<%@ page import="javax.naming.InitialContext" %>
<%@ page import="javax.naming.Context" %>
<%@ page import="javax.sql.DataSource" %>
<%@ page import="javax.naming.NamingException" %>
<%@ page import="java.sql.SQLException" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>首页</title>
</head>
<body>
<%
    Connection connMySQL = null;
    try {
        //1、初始化名称查找上下文
        Context ctx = new InitialContext();
        //InitialContext ctx = new InitialContext();亦可
        //2、通过JNDI名称找到DataSource,对名称进行定位java:comp/env是必须加的,后面跟的是DataSource名
                /*
                DataSource名在web.xml文件中的<res-ref-name>mysqlDataSource</res-ref-name>进行了配置
                  <!--MySQL数据库JNDI数据源引用 -->
                  <resource-ref>
                      <description>MySQL DB Connection</description>
                      <res-ref-name>mysqlDataSource</res-ref-name>
                      <res-type>javax.sql.DataSource</res-type>
                      <res-auth>Container</res-auth>
                  </resource-ref>
                */
        DataSource ds = (DataSource)ctx.lookup("java:comp/env/mysqlDataSource");
        //3、通过DataSource取得一个连接
        connMySQL = ds.getConnection();
        System.out.println(connMySQL);
        System.out.println("MySQL Connection pool connected !!");
        //4、操作数据库
    } catch (NamingException e) {
        System.out.println(e.getMessage());
    } catch (SQLException e) {
        e.printStackTrace();
    } finally {
        //5、关闭数据库，关闭的时候是将连接放回到连接池之中
        connMySQL.close();
    }
%>
</body>
</html>

web项目（带web.xml， 使用Spring）

在spring配置文件中引入jee命名空间

xmlns:jee="http://www.springframework.org/schema/jee" 
http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee.xsd

配置内容如下（可以配置多个）：

<bean id="defaultDataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
   <property name="jndiName" value="java:comp/env/mysqlDataSource"></property>
</bean>

JNDI查找数据源的方式可以解决多数据源的事务问题。