Java使用JNDI配置WEB项目数据源

参考http://www.devzeng.com/blog/java-jndi-datasource.html


JNDI(Java Naming and Directory Interface,Java命名与目录接口)是Java提供的一种标准的命名系统接口，JNDI提供统一的客户端API，通过不同的访问提供者接口JNDI SPI(Service Provider Interface,服务提供者接口)的实现，由管理者将JNDI API映射为特定的命名服务和目录系统，使得Java应用程序可以和这些命名服务和目录服务之间进行交互。

使用传统的方式

一般对于普通的项目，习惯上使用.properties的文件来配置数据源的一些信息。在.properties文件中配置数据源连接字符串、用户名、密码和驱动的类，然后在代码中读取配置文件的信息再通过DriverManager.getConnection(url, username, password)的方式获取数据源连接对象，步骤如下,以SQLServer为例:

(1)注册驱动

Class.forName(“com.microsoft.sqlserver.jdbc.SQLServerDriver”);

(2)获取连接对象

Connection conn = DriverManager.getConnection(url, username, password);

(3)示例代码
public static Connection getDefaultConnection() {
    try {
        String url = "jdbc:sqlserver://localhost:1433;databaseName=DBName";
        String username = "sa";
        String password = "*";
        String driver = "com.microsoft.sqlserver.jdbc.SQLServerDriver";
        //注册SQLServer的驱动
        Class.forName(driver);
        //获取数据源连接对象
        Connection conn = DriverManager.getConnection(url,  username, password);
        return conn;
    } catch (Exception e) {
        e.printStackTrace();
        return null;
    }
}


使用JNDI的方式

1、获取数据源的连接对象Connection
public static Connection getConnection(String jndi) {
    DataSource datasource = null;
    Connection connection = null;
    try {
        Context context = new InitialContext();
        Context envContext = null;
        try {
            envContext = (Context) context.lookup("java:/comp/env");
        } catch (Exception e1) {
            // 无法通过java:方式获得换用/comp/env的方式
            try {
                envContext = (Context) context.lookup("/comp/env");
            } catch (Exception fff) {
                e1.printStackTrace();
            }
        }
        //如果数据源的名称不为空的话使用指定的数据源的名称来获取数据库连接对象
        if(StringUtils.isNotEmpty(jndi)) {
            datasource = (DataSource) envContext.lookup(jndi);
        } else {
            datasource = (DataSource) envContext.lookup("sqlserver/default");
        }
        connection = datasource.getConnection();
    } catch (Exception e2) {
        e2.printStackTrace();
    }
    return connection;
}


2、在Tomcat中的webapp中加入Resource配置
<Resource name="sqlserver/default"
    auth="Container"
    type="javax.sql.DataSource"
    maxActive="100"
    maxIdle="30"
    maxWait="10000"
    username="sa"
    password="*"
    driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
    url="jdbc:sqlserver://localhost:1433;databasename=DBNAME"/>


常见配置属性描述:


name：JDBC数据源的名称


auth：认证方式，一般设置为Container,还有一种是Application


type：当前配置资源的类别


factory：数据源工厂,默认为"org.apache.commons.dbcp.BasicDataSourceFactory"


driverClassName：驱动的全路径类名


maxActive：当前数据源支持的最大并发数


maxIdle：连接池中保留最大数目的闲置连接数


maxWait：当连接池中无连接时的最大等待毫秒数，在等当前设置时间过后还无连接则抛出异常


username：访问数据库的用户名


password：访问数据库的密码


url：JDBC驱动的连接字符串


validationQuery：在返回应用之前，用于校验当前连接是否有效的SQL语句，如果指定了，当前查询语句至少要返回一条记录,可以写成select top 1 * from sysobjects

3、在Tomcat的lib目录下面添加数据库的驱动文件

MySQL:mysql-connector-java-5.1.20-bin.jar

SQLServer:sqljdbc4.jar

Oracle:ojdbc14.jar

4、在web.xml加入如下配置
<resource-ref>
    <res-ref-name>sqlserver/default</res-ref-name>
    <res-type>javax.sql.DataSource</res-type>
    <res-auth>Container</res-auth>
</resource-ref>


注:属于可选配置，如果在web.xml中加入了上面的配置，则需要在Tomcat中一定要配置对应的Resource，否则会报错。

5、使用方式
Connection conn = getConnection("sqlserver/default");
...

      用eclipse开发项目，tomcat为web server. 
      1.  配置项目在server.xml中
           <Context docBase="wishone" path="/" reloadable="true" source="org.eclipse.jst.jee.server:wishone"/>
           这样访问自己的项目，将没有web名称的context, 例如:  127.0.0.1/login


     2. 在tomcat/conf/context.xml中添加数据源配置
          <Resource name="jdbc/your jndi" auth="Container" type="javax.sql.DataSource"

              initialSize="10" maxActive="100" maxIdle="30" maxWait="10000"

              username="*" password="*" driverClassName="com.mysql.jdbc.Driver"

              url="jdbc:mysql://localhost:3306/youdblink"

              validationQuery="SELECT 1" testOnBorrow="true"/>


      3. 在项目的web.xml中添加
           <resource-ref> 
 <description>JNDI DataSource</description> 
 <res-ref-name>jdbc/wishone</res-ref-name> 
 <res-type>javax.sql.DataSource</res-type> 
 <res-auth>Container</res-auth> 

  </resource-ref>

JNDI 之web项目数据源配置 

1.把数据源配置到Server下context.xml 文件中(也可以配置在web.xml中) 




<?xml version="1.0" encoding="UTF-8"?>
<Context>
    <WatchedResource>WEB-INF/web.xml</WatchedResource>
    <Resource  
    name="jdbc/mysql"   
    scope="Shareable"   
    type="javax.sql.DataSource"  
    factory="org.apache.tomcat.dbcp.dbcp.BasicDataSourceFactory"  
    url="jdbc:mysql://localhost:3306/test"  
    driverClassName ="com.mysql.jdbc.Driver"  
    username="root"
    password="123456"  
    />  
</Context>

这样Spring等框架可以引用了. 下面做了一个简单的测试,在该web项目中获取数据库里的数据.



package com.iris.coon;

import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;

public class Jndi {
    public static void testConnection() {  
        String message = "Not Connected";  
        Connection conn=null;  
        ResultSet rst = null;  
        Statement stmt = null;  
        Context ctx;  
        try {  
            ctx = new InitialContext();  
            Context envContext = (Context) ctx.lookup("java:comp/env");  
            Object datasourceRef=envContext.lookup("jdbc/mysql");  
            DataSource  ds=(DataSource)datasourceRef;  
            conn=ds.getConnection();  
            if (conn != null) {  
                    message = "Got Connection " + conn.toString() + ", ";  
                    stmt = conn.createStatement();  
                    rst = stmt.executeQuery("select t.prp_code,t.prp_no from proposal t");  
                    while(rst.next()){
                        int prp_code = rst.getShort("prp_code");
                        String prp_no = rst.getString("prp_no");
                        System.out.println(prp_code+" "+prp_no+"\t");
                    }
                    System.out.println("Jndi Test Succeed!");  
                 }  
        } catch (NamingException e) {  
            e.printStackTrace();  
        } catch (SQLException e) {  
            e.printStackTrace();  
        }finally{  
            if(conn!=null){  
                try {  
                    conn.close();  
                } catch (SQLException e) {  
                    e.printStackTrace();  
                }  
            }  
        }  
    }  
} 


新建index.jsp文件,调取testConnection方法得到结果.表示数据源配置是正确的.

对于这样的配置,spring的jee:jndi-lookup 直接就获取到.

<jee:jndi-lookup id="dataSource" jndi-name="jdbc/mysql"></jee:jndi-lookup>

Tomcat-->conf-->在context.xml节点中添加配置
<?xml version='1.0' encoding='utf-8'?>

<Context>

    <!-- Default set of monitored resources -->

    <WatchedResource>WEB-INF/web.xml</WatchedResource>


    <!-- Uncomment this to disable session persistence across Tomcat restarts -->

    <!--

    <Manager pathname="" />

    -->



    <!-- Uncomment this to enable Comet connection tacking (provides events

         on session expiration as well as webapp lifecycle) -->

    <!--

    <Valve className="org.apache.catalina.valves.CometConnectionManagerValve" />

    -->
<Resource name="jdbc/source"
auth="Container" 

                 type="javax.sql.DataSource" 

                 maxActive="100" 

                 maxIdle="30" 

                 maxWait="10000" 

                 username="scott" 

                 password="smq" 

                 driverClassName="oracle.jdbc.OracleDriver"  

                 url="jdbc:oracle:thin:@localhost:1521:XE" />


</Context>



Web项目-->Web-Root-->在web.xml节点中添加配置

<?xml version="1.0" encoding="UTF-8"?>

<web-app version="2.5" 
xmlns="http://java.sun.com/xml/ns/javaee" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

  <welcome-file-list>

    <welcome-file>index.jsp</welcome-file>

  </welcome-file-list>

  <resource-ref>

  <res-ref-name>jdbc/source</res-ref-name>

  <res-type>javax.sql.DataSource</res-type>

  <res-auth>Container</res-auth>

  </resource-ref>

</web-app>

web项目-->src-->com.niit.util-->DBUtil.Java

public class DBUtil {

private DBUtil(){}

//JNDI方式配置数据源
public synchronized static Connection getConnectionByJNDI(){
Connection con = null;
try {
Context ctx = new InitialContext();
DataSource ds = (DataSource)ctx.lookup("java:comp/env/jdbc/source");
con = ds.getConnection();
} catch (NamingException e) {
System.out.println("连接错误！");

// e.printStackTrace();
}catch(SQLException e){
System.out.println("获取连接失败！");

// e.printStackTrace();
}
return con;
}


public static void closeResource(ResultSet rs,Statement stmt,Connection con){

try {
if(rs != null){
rs.close();
}
if(stmt != null){
stmt.close();
}
if(con != null){
con.close();
}
}catch (SQLException e) {
System.out.println("关闭资源失败！");

// e.printStackTrace();
}
}

}



注意事项：

1、在context.xml中的引用的资源名称必须和web.xml中保持一致；

2、web容器中要添加数据库的驱动jar，将tomecat目录中lib文件夹下的class12文件替换为ojdbc14；

3、java中访问数据源应在web容器开启后在jsp或servlet中进行访问，不能再main方法中直接调用。


JNDI配置数据源就是应用服务器通过WEB容器连接数据库，达到分布式的开发并集成服务器的目的，不像JDBC直接使用应用程序进行数据库连接。不开启任何WEB服务器，就无法启动JNDI。