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");
...

1. JNDI配置

第一步需要导入数据库连接需要用到的jar包。

1.1 web.xml配置

在java web项目中的WEB-INF目录下的web.xml中添加数据库资源的引用。

<!-- 配置连接池JNDI的引用 -->
	<resource-ref>
		<description>MySQL DataBase Connection</description>
		<res-ref-name>jdbc/mysql</res-ref-name><!-- name应于context.xml中引用的名字相同 -->
		<res-type>javax.sql.DataSource</res-type>
		<res-auth>Container</res-auth>
	</resource-ref>

1.2 context.xml配置

在java web项目中的META-INF目录下的context.xml中添加数据库配置资源，如果没有context.xml文件可以自行创建并添加。在tomcat运行时会自动的将项目下的该文件配置信息加载到服务器的contex.xml文件中，所以不需要像网上说的那样都配置。

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

	<!-- 连接池属性配置 -->
	<!-- 
		name应于web.xml中引用的名字相同，maxTotal是最大连接人数
		maxIdle最大等待人数，maxWaitMillis最大的等待时间（以毫秒计算）
	-->
	<Resource name="jdbc/mysql" auth="Container"
		type="javax.sql.DataSource"
		driverClassName="com.mysql.cj.jdbc.Driver"
		url="jdbc:mysql://localhost:3306/test"
		username="root" password="root"
		maxTotal="10" maxIdle="4" maxWaitMillis="6000"/>
		
</Context>

1.3 连接池工具类

import java.sql.Connection;
import java.sql.SQLException;

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

public class ConnectionPoolUtil {
	
	// 内容环境固定写法
	private static final String ENVIRONMENT = "java:comp/env/";
	// web.xml配置文件中数据库资源的名称，需要web.xml和context.xml都一致
	private static final String RESOURCE_NAME = "jdbc/mysql";
	private static DataSource dataSoruce = null;
	
	static {
		try {
			// 初始化上下文内容对象
			Context context = new InitialContext();
			// 在上下文内容对象中寻找内容环境和配置信息
			dataSoruce = (DataSource)context.lookup(ENVIRONMENT.concat(RESOURCE_NAME));
			// 关闭内容对象
			context.close();
		} catch (NamingException e) {
			e.printStackTrace();
		}
	}
	
	/**
	 * 获取数据库连接
	 * @return 数据库连接对象
	 */
	public static final Connection getConnection() {
		Connection connection = null;
		try {
			// 获取数据库连接
			connection = dataSoruce.getConnection();
		}catch (SQLException e) {
			e.printStackTrace();
		}
		return connection;
	}
	
}

2. JNDI测试

创建一个jsp文件，编写测试。连接池因为需要内容对象，所以只能通过服务器加载来进行测试。

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ page import="javax.naming.*,javax.sql.*,java.sql.*,util.ConnectionPoolUtil"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<%
	Connection connection = ConnectionPoolUtil.getConnection();
	String sql = "select * from user";
	PreparedStatement preparedStatement;
	try {
		preparedStatement = connection.prepareStatement(sql);
		ResultSet resultSet = preparedStatement.executeQuery();
		int id;
		String name = null,sex = null;
		while(resultSet.next()) {
			id = resultSet.getInt("id");
			name = resultSet.getString("name");
			sex = resultSet.getString("sex");
			out.println("id:"+id+"name:"+name+"sex:"+sex+"<br>");
		}
		resultSet.close();
		preparedStatement.close();
		// 若想测试最大连接人数可以把下面这句注释掉，一直占用连接资源
		connection.close();
	} catch (SQLException e) {
		e.printStackTrace();
	}
%>
</body>
</html>

前言：最近在研究邮箱激活账号，借此介绍一下Tomcat配置数据源的方法

一，JNDI简介与优点

JNDI(Java Naming and Directory Interface，Java命名和目录接口)是一组在Java应用中访问命名和目录服务的API。在Tomcat服务器中配置JNDI参数，定义一个数据源，在程序中通过数据源名称引用数据源从而与数据库交互，避免了程序与数据库之间的紧耦合，使应用更加易于配置、易于部署。

二，环境准备

 JDK, Eclipse  IDE，Tomcat服务器， Oracle数据库

三，开始配置

1.在Eclipse左侧项目目录位置找到Servers，打开该项目找到context.xml配置文件，目录结构如下

打开该配置文件 ，添加如下配置，各属性说明如下

2.新建web项目 在WebContent/WEB-INF/lib 目录下添加oracle驱动包

3.新建DBUtil类 加载数据源 ，获取连接（估计到这里大家拿到Connection连接就该知道如何进行与数据库的操作了，还不会的继续往下看）

package com.mail.util;

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

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

public class DBUtil {

	/**
	 * 这里采用 JNDI(java命名和目录接口)方式加载JDBC DataSource
	 * 需要在Tomcat服务器context.xml中配置文件配置数据源
	 * 
	 * @return
	 */
	public static Connection getConnection() {
		Connection con = null;
		try {
			Context context = new InitialContext();
			DataSource dataSource = (DataSource) context.lookup("java:comp/env/jdbc/oracle");// 引用数据源
			con = dataSource.getConnection();
		} catch (Exception e) {
			e.printStackTrace();
		}
		return con;
	}

	/**
	 * 关闭资源
	 * 
	 * @param rs
	 *            要关闭的结果集
	 * @param pstmt
	 *            要关闭的预编译块
	 * @param con
	 *            要关闭的连接
	 */
	public static void close(ResultSet rs, PreparedStatement pstmt, Connection con) {
		if (rs != null) {
			try {
				rs.close();
			} catch (SQLException e) {
				e.printStackTrace();
			}
		}

		if (pstmt != null) {
			try {
				pstmt.close();
			} catch (SQLException e) {
				e.printStackTrace();
			}
		}

		if (con != null) {
			try {
				con.close();
			} catch (SQLException e) {
				e.printStackTrace();
			}
		}
	}
}

4.新建 PersonInfoDao类与数据库交互，进行增删查改，这里是基于我的邮箱激活小项目对与数据库交互的类，仅供参考。

package com.mail.dao;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;

import com.mail.pojo.PersonInfo;
import com.mail.util.DBUtil;

public class PersonInfoDao {

	/**
	 * 添加注册信息
	 * 
	 * @param personInfo
	 * @return
	 */
	public int regist(PersonInfo personInfo) {
		int result = 0;
		Connection conn = null;
		PreparedStatement pstmt = null;
		try {
			conn = DBUtil.getConnection();
			String sql = "insert into PersonInfo values(seq_personInfo_id.nextval,?,?,?,?,?)";
			pstmt = conn.prepareStatement(sql);
			pstmt.setString(1, personInfo.getName());
			pstmt.setString(2, personInfo.getMail());
			pstmt.setString(3, personInfo.getPassword());
			pstmt.setInt(4, personInfo.getState());
			pstmt.setString(5, personInfo.getActcode());
			result = pstmt.executeUpdate();
		} catch (SQLException e) {
			e.printStackTrace();
		} finally {
			DBUtil.close(null, pstmt, conn);

		}
		return result;

	}
	
	/**
	 * 激活账号
	 * 
	 * @param actcode
	 * @return
	 */
	public int active(String actcode) {
		int result = 0;
		Connection conn = null;
		PreparedStatement pstmt = null;
		try {
			conn = DBUtil.getConnection();
			String sql = "update PersonInfo set state=1 where actcode=?";
			pstmt = conn.prepareStatement(sql);
			pstmt.setString(1, actcode);
			result = pstmt.executeUpdate();
			DBUtil.close(null, pstmt, conn);
		} catch (SQLException e) {
			e.printStackTrace();
		} finally {
			DBUtil.close(null, pstmt, conn);
		}
		return result;

	}
	/**
	 * 登录
	 * 
	 * @param personInfo
	 * @return
	 */
	public int login(PersonInfo personInfo) {
		int result = 0;
		Connection conn = null;
		PreparedStatement pstmt = null;
		try {
			conn = DBUtil.getConnection();
			String sql = "select * from PersonInfo where state = 1 and mail = ? and password = ?";
			pstmt = conn.prepareStatement(sql);
			pstmt.setString(1, personInfo.getMail());
			pstmt.setString(2, personInfo.getPassword());
			result = pstmt.executeUpdate();
		} catch (SQLException e) {
			e.printStackTrace();
		} finally {
			DBUtil.close(null, pstmt, conn);

		}
		return result;

	}
}