教程：Hibernate，JPA和Spring MVC

本教程將向您展示如何使用基本的Hibernate / JPA應用程序，如何將其轉換為Spring MVC Web項目，以便能夠在Web瀏覽器中查看數據庫，以及最后使用Spring的@Transactional注釋來減少樣板代碼。

本教程假定您熟悉Java和Maven，并且已經完成了本教程的第一部分。您還需要下載并安裝Tomcat。

您可能希望從Github全新簽出代碼。

容器管理的數據源

我們需要修改或創建許多密鑰文件，才能將第1部分中的代碼轉換為Web項目。我們需要做的第一件事（假設您已經安裝了Tomcat并在計算機環境中設置了CATALINA_HOME）是將JDBC配置移至Tomcat的配置，以便數據源由Tomcat管理，而不是通過編程方式進行管理，并且可以使用JNDI訪問。

為此，請在$ CATALINA_HOME / conf / server.xml的GlobalNamingResources元素內添加以下行：

<Resource auth='Container' driverClassName='org.apache.derby.jdbc.EmbeddedDriver' maxActive='8' maxIdle='4' name='jdbc/tutorialDS' type='javax.sql.DataSource' url='jdbc:derby:tutorialDB;create=true' username='' password='' />

包含org.apache.derby.jdbc.EmbeddedDriver的jar必須可用于Tomcat。獲取jar的一種快速方法是從您的Maven本地存儲庫，例如?/ .m2 / repository / org / apache / derby / derby / 10.4.1.3 / derby-10.4.1.3.jar。將該文件復制到$ CATALINA_HOME / lib中，然后重新啟動Tomcat，以確保沒有錯誤。

這些更改將創建已部署的應用程序可以訪問的數據源。在Tomcat 7中，您可以在http：// localhost：8080 / manager / text / resources上查看托管資源；您應該看到類似以下內容：

OK - Listed global resources of all types
jdbc/tutorialDS:org.apache.tomcat.dbcp.dbcp.BasicDataSource
UserDatabase:org.apache.catalina.users.MemoryUserDatabase

轉換為Web項目

使用第1部分中的some項目，我們需要進行以下更改：

我們需要更改項目以生成Web存檔，因此在pom.xml中添加以下內容：

<packaging>war</packaging>

您將想要（為了方便）在build部分中添加一行，以創建一個沒有項目版本的.war：

<finalName>${project.artifactId}</finalName>

我們還需要Servlet API庫：
<依賴性>

<groupId>javax.servlet</groupId><artifactId>servlet-api</artifactId><version>2.5</version><scope>provided</scope></dependency>

注意：“范圍”是“提供的”，因為Tomcat已經具有內置的servlet庫。

為了使數據源可用于應用程序，請使用以下幾行創建src / main / webapp / META-INF / context.xml：

<Context><ResourceLink global='jdbc/tutorialDS' name='jdbc/tutorialDS' type='javax.sql.DataSource'/>
</Context>

這使得由Tomcat管理的數據源可用于我們的應用程序。我們還需要src / main / webapp / WEB-INF / web.xml的存根：

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

編譯應用程序并將其部署到Tomcat。此時您將看不到任何內容，因為沒有servlet或頁面。

可以讓Maven為您構建并部署到Maven，或者您可以在大多數IDE中運行Tomcat。在其他地方有很多關于此的文章，因此在此不做介紹。

添加Spring MVC

我們將為此使用Spring MVC，因此我們需要一些其他更改來支持這一點：

將以下依賴項添加到pom.xml中：

<dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>3.0.6.RELEASE</version></dependency>

我們要告訴Tomcat使用Spring來調度請求，因此我們需要在web.xml中添加以下幾行：
<context-param>

<param-name>contextConfigLocation</param-name><param-value>/WEB-INF/mvc-dispatcher-servlet.xml</param-value></context-param><listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener><servlet><servlet-name>mvc-dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>mvc-dispatcher</servlet-name><url-pattern>*.html</url-pattern></servlet-mapping>

這會將所有以'.html'結尾的頁面的請求轉發給Spring，Spring將選擇適當的控制器來服務每個請求。我們還需要為Spring Servlet創建一個應用程序上下文，并且必須存在于src / main / webapp / WEB-INF / mvc-dispatcher-servlet.xml中：

<?xml version='1.0' encoding='UTF-8'?>
<beans xmlns='http://www.springframework.org/schema/beans'xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'xmlns:context='http://www.springframework.org/schema/context'xsi:schemaLocation='http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd'><context:component-scan base-package='tutorial'/><context:annotation-config/><bean class='org.springframework.web.servlet.view.InternalResourceViewResolver'><property name='prefix'><value>/WEB-INF/pages/</value></property><property name='suffix'><value>.jsp</value></property></bean></beans>

該XML有兩件事：

它告訴Spring掃描軟件包“ tutorial”中和其下的類，以查找標注為bean的類。
如何將視圖名稱轉換為資源。本質上，它說“使用名稱，在名稱前加上'/ WEB-INF / pages”，然后在結果后加上“ .jsp”。

您可能需要重新部署此產品以進行煙霧測試。

要對此進行測試，我們需要顯示一個頁面。第一頁將顯示所有用戶的列表。我們需要兩個文件；第一個是服務請求的控制器：

package tutorial;import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;@Controller
public class UsersController {@RequestMapping('/users')public String users(Model model) {return 'users';}
}

第二項是要顯示的頁面。這基于UsersController.users（）返回的字符串，并使用資源解析器的規則，我們知道此文件必須為WEB-INF / pages / users.jsp。創建頁面的存根，如下所示：

<html>
<body>
<h1>Users</h1>
</body>
</html>

最后，您可以通過重新部署到Tomcat并使用瀏覽器查看http：// localhost：8080 / tutorial-hibernate-jpa / users.html進行測試。

添加Spring ORM

Spring包含了將實體管理器注入bean的支持，這僅需要將幾行代碼添加到pom.xml和mvc-dispatcher-context.xml中：

<dependency><groupId>org.springframework</groupId><artifactId>spring-orm</artifactId><version>3.0.6.RELEASE</version></dependency>

<jee:jndi-lookup id='tutorialDS' jndi-name='java:/comp/env/jdbc/tutorialDS' expected-type='javax.sql.DataSource'/><bean id='entityManagerFactory' class='org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean'><property name='dataSource' ref='tutorialDS'/></bean>

“ jndi-lookup”元素從JNDI資源創建一個bean，并且由實體管理器工廠使用它來創建實體管理器。其他JNDI對象也可以以此方式進行查找。

注意：您需要將XML名稱空間和XSD添加到根元素：xmlns：jee ='http：//www.springframework.org/schema/jee'。

最后，我們可以添加代碼以將實體管理器注入到控制器中并從數據庫中獲取用戶。

public class UsersController {@PersistenceContextprivate EntityManager entityManager;@RequestMapping('/users')public String users(Model model) {model.addAttribute('users', entityManager.createQuery('select u from User u').getResultList());return 'users';}
}

此代碼使用實體管理器來獲取所有用戶，并將其綁定到一個名為“用戶”的屬性，該屬性對于我們的JSP而言是可見的。

我們將要在頁面上顯示用戶。為此，我將使用JSTL。您可以根據需要使用其他技術，如果沒有，我會盡快為您提供所需的信息。同樣，如果您不熟悉的話，還有很多關于JSTL的優秀教程。首先，向您添加另一個依賴項pom.xml：

<dependency><groupId>javax.servlet</groupId><artifactId>jstl</artifactId><version>1.2</version></dependency>

并更新users.html顯示用戶：

<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %>
<html>
<body>
<h1>Users</h1>
<table><thead><tr><td>ID</td><td>Name</td></tr></thead><tbody><c:forEach var='user' items='${users}'><tr><td>${user.id}</td><td>${user.name}</td></tr></c:forEach></tbody>
</table>
</body>
</html>

最后，您可以在瀏覽器中進行抽煙測試。

@交易

難題的最后一步是創建用戶。為此，我們需要一種基本形式，例如，我已經創建了pages / create-user.jsp：

<html>
<body>
<h1>Create User</h1>
<form method='post'>
Name: <input name='name'/>
<input type='submit'/>
</form>
</body>
</html>

我們需要一個控制器來訪問它，因此將其添加到UsersController中：

@RequestMapping(value = '/create-user', method = RequestMethod.GET)publicString createUser(Model model) {return 'create-user';}

注意：此方法僅接受GET請求。發布表單時，我們需要其他方法。您可以通過重新部署到Tomcat并瀏覽到http：// localhost：8080 / tutorial-hibernate-jpa / create-user.html來進行抽煙測試。您會注意到，提交頁面會導致HTTP 405錯誤。我們可以使用以下（重載）方法處理POST請求：

@RequestMapping(value = '/create-user', method = RequestMethod.POST)@Transactionalpublic String createUser(Model model, String name) {User user = new User();user.setName(name);entityManager.persist(user);return 'redirect:/users.html';}

我們在這里使用了@Transactional批注。當我們這樣做時，Spring將為我們的bean創建一個代理對象并為我們管理事務，在發生錯誤時開始，提交和回滾。與我們自己打開和關閉交易相比，這要少得多的代碼（一行而不是一打），更安全（出現印刷錯誤的機會更少）。您可以在這篇文章中看到詳細版本代碼的示例。我們需要通過在Spring上下文中添加以下幾行來告訴Spring支持這一點：告訴它使用基于注釋的事務，以及應該由哪個bean管理事務：

<tx:annotation-driven/><bean id='transactionManager' class='org.springframework.orm.jpa.JpaTransactionManager'><property name='entityManagerFactory' ref='entityManagerFactory' /></bean>

注意：您還需要在文檔中添加正確的架構：

xmlns:tx='http://www.springframework.org/schema/tx'
...http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd

您可以通過轉到頁面并提交新用戶來進行測試。之后，您將被重定向到用戶頁面，在那里您應該能夠看到您的新用戶。

結論

在此示例中，XML的行比Java多，但是大多數XML是一次性設置，您會發現，隨著應用程序變大，比率會下降。您可以使用Spring支持JPA實體，從而使到JEE的遷移更加容易。

我在這里只介紹了CRUD的“ C”和“ R”部分，您應該在這里擁有足夠的信息，以便能夠自己嘗試其余的部分。

此代碼在Github上。 Hibernate Java Maven ORM Spring框架

參考： 教程：Hibernate，JPA和Spring MVC –來自我們的JCG合作伙伴 Alex Collins的第二部分，位于Alex Collins的博客博客中。