Hibernate与Tomcat整合：JNDI数据源配置完全指南
欢迎来到Hibernate Tomcat JNDI数据源示例教程。我们已经学习了如何在独立的Java应用程序中使用Hibernate ORM工具，今天我们将学习如何在Tomcat Servlet容器中使用Hibernate与数据源。在Web应用程序中使用Hibernate非常简单，我们只需要在Hibernate配置文件中配置数据源属性即可。首先，我们需要在Tomcat容器中设置测试数据库和JNDI数据源。
Hibernate数据源JNDI示例数据库设置
在本示例中，我们使用MySQL数据库。请执行以下脚本以创建一个简单的表并向其中插入一些数据。
employee.sql
CREATE TABLE `Employee` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(20) DEFAULT NULL,
`role` varchar(20) DEFAULT NULL,
`insert_time` datetime DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=26 DEFAULT CHARSET=utf8;
INSERT INTO `Employee` (`id`, `name`, `role`, `insert_time`)
VALUES
(3, 'Pankaj', 'CEO', now());
INSERT INTO `Employee` (`id`, `name`, `role`, `insert_time`)
VALUES
(14, 'David', 'Developer', now());
数据库模式名称为TestDB。
Tomcat JNDI 数据源配置
为了配置Tomcat容器初始化数据源(DataSource)，我们需要在Tomcat的server.xml和context.xml文件中进行一些更改。
在server.xml的GlobalNamingResources元素中添加以下资源：
<Resource name="jdbc/MyLocalDB"
global="jdbc/MyLocalDB"
auth="Container"
type="javax.sql.DataSource"
driverClassName="com.mysql.jdbc.Driver"
url="jdbc:mysql://localhost:3306/TestDB"
username="scdev"
password="scdev123"
maxActive="100"
maxIdle="20"
minIdle="5"
maxWait="10000"/>
在context.xml文件中添加以下ResourceLink：
<ResourceLink name="jdbc/MyLocalDB"
global="jdbc/MyLocalDB"
auth="Container"
type="javax.sql.DataSource" />
在context.xml文件中添加上述ResourceLink是必需的，以便应用程序可以通过名称jdbc/MyLocalDB访问JNDI资源。重新启动服务器后，您应该在Tomcat服务器日志中看不到任何错误。如果存在任何配置错误，比如密码错误，您将在服务器日志中看到相应的异常。您还需要确保MySQL驱动jar文件位于Tomcat的lib目录中，否则Tomcat将无法创建数据库连接，您将在日志中看到ClassNotFoundException。现在，我们的数据库和Tomcat服务器JNDI设置已经准备就绪，让我们开始使用Hibernate创建我们的Web应用程序。
深入研究动态Web项目的Hibernate数据源示例
在Eclipse中创建一个动态Web项目，然后将其配置为Maven项目。我们最终的项目结构将如下图所示。请注意，我在项目部署中使用Tomcat-7，并将其添加到构建路径中，因此我们不需要单独添加Servlet API依赖项到我们的项目中。Tomcat-7支持Servlet 3规范，我们将使用注解来创建我们的Servlet。如果您对Servlet 3注解不熟悉，建议您查阅Servlet初学者教程。让我们逐个浏览每个组件。
Hibernate Maven依赖
我们最终的pom.xml文件如下：
<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>HibernateDataSource</groupId>
<artifactId>HibernateDataSource</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>
<dependencies>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
<version>4.3.5.Final</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.0.5</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-war-plugin</artifactId>
<version>2.3</version>
<configuration>
<warSourceDirectory>WebContent</warSourceDirectory>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
</configuration>
</plugin>
</plugins>
<finalName>${project.artifactId}</finalName>
</build>
</project>
我正在使用最新的Hibernate版本4.3.5.Final，已添加了hibernate-core依赖以支持Hibernate功能。添加了mysql-connector-java依赖是因为我们使用的是MySQL数据库，虽然范围设置为provided，因为它已经是Tomcat容器库的一部分。即使我们不添加MySQL驱动程序依赖项，我们的项目仍能正常编译和运行。然而最好还是包含它，这样当有人查看项目的依赖关系时，就能清楚地知道我们正在使用MySQL数据库。
Hibernate数据源配置
这是文章《Hibernate Tomcat JNDI 数据源示例教程》的第2部分（共4部分）。
我们的Hibernate配置文件和数据源如下所示。hibernate.cfg.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
"https://hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
<session-factory>
<property name="hibernate.connection.driver_class">com.mysql.jdbc.Driver</property>
<property name="hibernate.dialect">org.hibernate.dialect.MySQLDialect</property>
<property name="hibernate.connection.datasource">java:comp/env/jdbc/MyLocalDB</property>
<property name="hibernate.current_session_context_class">thread</property>
<!-- 使用包含注解的模型类进行映射 -->
<mapping class="com.Olivia.servlet.hibernate.model.Employee"/>
</session-factory>
</hibernate-configuration>
hibernate.connection.datasource属性用于提供Hibernate在数据库操作中使用的DataSource名称。
Hibernate数据源示例模型类
如您所见，在hibernate配置文件中，我们在模型类Employee中使用了注解。我们的模型bean如下所示。Employee.java
package com.Olivia.servlet.hibernate.model;
import java.util.Date;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.UniqueConstraint;
@Entity
@Table(name="Employee",
uniqueConstraints={@UniqueConstraint(columnNames={"ID"})})
public class Employee {
@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="ID", nullable=false, unique=true, length=11)
private int id;
@Column(name="NAME", length=20, nullable=true)
private String name;
@Column(name="ROLE", length=20, nullable=true)
private String role;
@Column(name="insert_time", nullable=true)
private Date insertTime;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
public Date getInsertTime() {
return insertTime;
}
public void setInsertTime(Date insertTime) {
this.insertTime = insertTime;
}
}
模型bean与我们在Hibernate入门教程中使用的相同，如果您对使用的任何注解感到困惑，可以查看一下。
Hibernate 数据源 Tomcat JNDI Servlet 监听器
既然我们需要初始化Hibernate SessionFactory，因为我们需要在应用程序中使用它，还需要在Web应用程序销毁时销毁SessionFactory，所以最好的地方是在一个ServletContextListener实现中执行这个操作。HibernateSessionFactoryListener.java
package com.Olivia.servlet.hibernate.listener;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import org.hibernate.SessionFactory;
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.cfg.Configuration;
import org.hibernate.service.ServiceRegistry;
import org.jboss.logging.Logger;
@WebListener
public class HibernateSessionFactoryListener implements ServletContextListener {
public final Logger logger = Logger.getLogger(HibernateSessionFactoryListener.class);
public void contextDestroyed(ServletContextEvent servletContextEvent) {
SessionFactory sessionFactory = (SessionFactory) servletContextEvent.getServletContext().getAttribute("SessionFactory");
if(sessionFactory != null && !sessionFactory.isClosed()){
logger.info("Closing sessionFactory");
sessionFactory.close();
}
logger.info("Released Hibernate sessionFactory resource");
}
public void contextInitialized(ServletContextEvent servletContextEvent) {
Configuration configuration = new Configuration();
configuration.configure("hibernate.cfg.xml");
logger.info("Hibernate Configuration created successfully");
ServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder().applySettings(configuration.getProperties()).build();
logger.info("ServiceRegistry created successfully");
SessionFactory sessionFactory = configuration
.buildSessionFactory(serviceRegistry);
logger.info("SessionFactory created successfully");
servletContextEvent.getServletContext().setAttribute("SessionFactory", sessionFactory);
logger.info("Hibernate SessionFactory Configured successfully");
}
}
如果你对Servlet监听器不熟悉，请阅读Servlet监听器教程。
Tomcat JNDI示例Servlet实现中使用Hibernate
让我们编写一个简单的Servlet，它将员工ID作为请求参数传递，并从数据库中检索并显示员工信息。在这个示例中，我们将使用Hibernate来查询数据库并获取员工信息。以下是GetEmployeeByID.java的代码实现：
package com.Olivia.servlet.hibernate;
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.jboss.logging.Logger;
import com.Olivia.servlet.hibernate.model.Employee;
@WebServlet("/GetEmployeeByID")
public class GetEmployeeByID extends HttpServlet {
private static final long serialVersionUID = 1L;
public final Logger logger = Logger.getLogger(GetEmployeeByID.class);
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
int empId = Integer.parseInt(request.getParameter("empId"));
logger.info("请求参数 empId="+empId);
SessionFactory sessionFactory = (SessionFactory) request.getServletContext().getAttribute("SessionFactory");
Session session = sessionFactory.getCurrentSession();
Transaction tx = session.beginTransaction();
Employee emp = (Employee) session.get(Employee.class, empId);
tx.commit();
PrintWriter out = response.getWriter();
response.setContentType("text/html");
if(emp != null){
out.print("<html><body><h2>员工详细信息</h2>");
out.print("<table border=\"1\" cellspacing=10 cellpadding=5>");
out.print("<th>员工ID</th>");
out.print("<th>员工姓名</th>");
out.print("<th>员工职位</th>");
out.print("<tr>");
out.print("<td>" + empId + "</td>");
out.print("<td>" + emp.getName() + "</td>");
out.print("<td>" + emp.getRole() + "</td>");
out.print("</tr>");
out.print("</table></body><br/>");
out.print("</html>");
}else{
out.print("<html><body><h2>未找到ID为"+empId+"的员工</h2></body></html>");
}
}
}
这是一个非常简单的Servlet类，我使用@WebServlet注解为其指定了URI模式。
测试使用Hibernate数据源的Tomcat JNDI示例应用程序
Hibernate Tomcat JNDI 数据源示例教程 – 第四部分
我们的应用现在已经准备就绪，只需将其导出为WAR文件并部署到Tomcat容器中。以下是调用应用程序Servlet时的一些运行截图。请注意，示例中将empId请求参数传递到了请求URL的查询字符串中。您还将在服务器日志中看到应用程序生成的详细日志信息。
2014年5月8日 晚上8:14:16 org.hibernate.cfg.Configuration configure
INFO: HHH000043: 正在从资源配置: hibernate.cfg.xml
2014年5月8日 晚上8:14:16 org.hibernate.cfg.Configuration getConfigurationInputStream
INFO: HHH000040: 配置资源: hibernate.cfg.xml
2014年5月8日 晚上8:14:16 org.hibernate.cfg.Configuration doConfigure
INFO: HHH000041: 已配置SessionFactory: null
2014年5月8日 晚上8:14:16 com.Olivia.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: Hibernate配置创建成功
2014年5月8日 晚上8:14:16 com.Olivia.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: ServiceRegistry创建成功
2014年5月8日 晚上8:14:16 org.hibernate.dialect.Dialect <init>
INFO: HHH000400: 使用方言: org.hibernate.dialect.MySQLDialect
2014年5月8日 晚上8:14:17 org.hibernate.engine.jdbc.internal.LobCreatorBuilder useContextualLobCreation
INFO: HHH000423: 禁用上下文LOB创建，因为JDBC驱动报告的JDBC版本[3]小于4
2014年5月8日 晚上8:14:17 org.hibernate.engine.transaction.internal.TransactionFactoryInitiator initiateService
INFO: HHH000399: 使用默认事务策略（直接JDBC事务）
2014年5月8日 晚上8:14:17 org.hibernate.hql.internal.ast.ASTQueryTranslatorFactory <init>
INFO: HHH000397: 使用ASTQueryTranslatorFactory
2014年5月8日 晚上8:14:17 com.Olivia.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: SessionFactory创建成功
2014年5月8日 晚上8:14:17 com.Olivia.servlet.hibernate.listener.HibernateSessionFactoryListener contextInitialized
INFO: Hibernate SessionFactory配置成功
2014年5月8日 晚上8:14:32 com.Olivia.servlet.hibernate.GetEmployeeByID doGet
INFO: 请求参数empId=3
2014年5月8日 晚上8:15:22 com.Olivia.servlet.hibernate.GetEmployeeByID doGet
INFO: 请求参数empId=3如果您取消部署应用程序或停止服务器，将会在服务器日志中看到有关销毁SessionFactory的记录。
2014年5月8日 晚上11:31:16 com.Olivia.servlet.hibernate.listener.HibernateSessionFactoryListener contextDestroyed
INFO: 正在关闭sessionFactory
2014年5月8日 晚上11:31:16 com.Olivia.servlet.hibernate.listener.HibernateSessionFactoryListener contextDestroyed
INFO: 已释放Hibernate sessionFactory资源以上就是在Tomcat容器中使用Hibernate配置DataSource的完整示例，希望能够帮助您轻松理解和实现。请从下方链接下载示例项目，通过实践操作来深入学习更多Hibernate数据源配置知识。
