Spring 5 MVC + Hibernate 5 示例 · HowToDoInJava 中文系列教程

# Spring 5 MVC + Hibernate 5 示例 > 原文： [https://howtodoinjava.com/spring5/webmvc/spring5-mvc-hibernate5-example/](https://howtodoinjava.com/spring5/webmvc/spring5-mvc-hibernate5-example/) 在本 **spring 5 Hibernate 5 注解示例**教程中，學習**創建 Spring 5 MVC Web 應用程序**，**處理表單提交**，**集成 Hibernate 5** 連接到后端數據庫并為輸入表單[字段驗證](https://howtodoinjava.com/resteasy/resteasy-bean-validation-using-hibernate-validator-provider/)添加**Hibernate 驗證器**。我們將創建一個簡單的屏幕，可以在其中添加用戶字段（名稱和電子郵件）。這些詳細信息將首先通過 Hibernate 進行驗證，然后存儲在[ HSQL 數據庫中](https://howtodoinjava.com/hibernate/hibernate-4-using-in-memory-database-with-hibernate/)。該頁面還將列出所有已存儲的用戶。 ## 1\. 開發環境 * Eclipse Neon 2 * JDK 1.8 * Spring 5.2.0.發布 * Hibernate 5.2.11.Final * Hibernate 驗證器 5.4.1.Final * Servlet 3.1.0 * HSQLDB 1.8.0.10 * Tomcat 7 Maven 插件 2.2 ## 2\. 項目結構該項目具有典型的[ Maven Web 應用程序](https://howtodoinjava.com/maven/how-to-create-a-eclipse-web-application-using-maven/)結構。 ![Spring5 WebMVC Project Structure](https://img.kancloud.cn/ca/ee/caee33cfef199a8485e576044cc8440c_331x651.jpg) Spring5 WebMVC 項目結構 #### 2.1. 類圖 ![Class Diagram](https://img.kancloud.cn/f0/ca/f0ca5063b5d3c94ab2bb0e352a12a978_978x473.jpg) 類圖 ## 3\. Maven 依賴在`pom.xml`文件中找到用于運行此示例的項目依賴項。 `pom.xml` ```java <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd; <modelVersion>4.0.0</modelVersion> <groupId>com.howtodoinjava.spring5.demo</groupId> <artifactId>spring5-mvc-hibernate-example</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>war</packaging> <properties> <failOnMissingWebXml>false</failOnMissingWebXml> <spring.version>5.2.0.RELEASE</spring.version> <hibernate.version>5.2.11.Final</hibernate.version> <hibernate.validator>5.4.1.Final</hibernate.validator> <c3p0.version>0.9.5.2</c3p0.version> <jstl.version>1.2.1</jstl.version> <tld.version>1.1.2</tld.version> <servlets.version>3.1.0</servlets.version> <jsp.version>2.3.1</jsp.version> <hsqldb.version>1.8.0.10</hsqldb.version> </properties> <dependencies>  <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency>  <dependency> <groupId>org.springframework</groupId> <artifactId>spring-orm</artifactId> <version>${spring.version}</version> </dependency>  <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-core</artifactId> <version>${hibernate.version}</version> </dependency>  <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-c3p0</artifactId> <version>${hibernate.version}</version> </dependency>  <dependency> <groupId>com.mchange</groupId> <artifactId>c3p0</artifactId> <version>${c3p0.version}</version> </dependency>  <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>${hibernate.validator}</version> </dependency>  <dependency> <groupId>javax.servlet.jsp.jstl</groupId> <artifactId>javax.servlet.jsp.jstl-api</artifactId> <version>${jstl.version}</version> </dependency> <dependency> <groupId>taglibs</groupId> <artifactId>standard</artifactId> <version>${tld.version}</version> </dependency>  <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>${servlets.version}</version> <scope>provided</scope> </dependency>  <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>javax.servlet.jsp-api</artifactId> <version>${jsp.version}</version> <scope>provided</scope> </dependency>  <dependency> <groupId>hsqldb</groupId> <artifactId>hsqldb</artifactId> <version>${hsqldb.version}</version> </dependency> </dependencies> <build> <sourceDirectory>src/main/java</sourceDirectory> <resources> <resource> <directory>src/main/resources</directory> </resource> </resources> <plugins> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.5.1</version> <configuration> <source>1.8</source> <target>1.8</target> </configuration> </plugin> <plugin> <groupId>org.apache.tomcat.maven</groupId> <artifactId>tomcat7-maven-plugin</artifactId> <version>2.2</version> <configuration> <path>/</path> </configuration> </plugin> </plugins> </build> </project> ``` ## 4\. `DispatcherServlet`配置隨著[ Servlet 3.0 規范](https://download.oracle.com/otndocs/jcp/servlet-3.0-fr-oth-JSpec/)的發布，可以（幾乎）沒有 xml 配置 Servlet 容器。為此，Servlet 規范中有[`ServletContainerInitializer`](https://docs.oracle.com/javaee/7/api/javax/servlet/ServletContainerInitializer.html)。在該類中，您可以注冊過濾器，監聽器，servlet 等，就像您在`web.xml`中傳統上所做的那樣。 Spring 提供了[`SpringServletContainerInitializer`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/SpringServletContainerInitializer.html)，它知道如何處理`WebApplicationInitializer`類。 `AbstractAnnotationConfigDispatcherServletInitializer`類實現了`WebMvcConfigurer`，而該內部實現了`WebApplicationInitializer`。它注冊了`ContextLoaderlistener`（可選）和`DispatcherServlet`，并允許您輕松添加配置類以加載這兩個類，并將過濾器應用于`DispatcherServlet`并提供 Servlet 映射。 `AppInitializer.java` ```java package com.howtodoinjava.demo.spring.config; public class AppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { @Override protected Class<?>[] getRootConfigClasses() { return new Class[] { HibernateConfig.class }; } @Override protected Class<?>[] getServletConfigClasses() { return new Class[] { WebMvcConfig.class }; } @Override protected String[] getServletMappings() { return new String[] { "/" }; } } ``` ## 5\. Spring WebMVC 配置下面給出了使用**注解配置**的 Spring MVC 配置。 `WebMvcConfig.java` ```java package com.howtodoinjava.demo.spring.config; import org.springframework.context.MessageSource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.support.ResourceBundleMessageSource; import org.springframework.validation.Validator; import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import org.springframework.web.servlet.view.InternalResourceViewResolver; import org.springframework.web.servlet.view.JstlView; @Configuration @EnableWebMvc @ComponentScan(basePackages = { "com.howtodoinjava.demo.spring"}) public class WebMvcConfig implements WebMvcConfigurer { @Bean public InternalResourceViewResolver resolver() { InternalResourceViewResolver resolver = new InternalResourceViewResolver(); resolver.setViewClass(JstlView.class); resolver.setPrefix("/WEB-INF/views/"); resolver.setSuffix(".jsp"); return resolver; } @Bean public MessageSource messageSource() { ResourceBundleMessageSource source = new ResourceBundleMessageSource(); source.setBasename("messages"); return source; } @Override public Validator getValidator() { LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean(); validator.setValidationMessageSource(messageSource()); return validator; } } ``` 1. [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html)定義用于自定義或添加到通過使用`@EnableWebMvc`啟用的默認 Spring MVC 配置的選項。 2. `@EnableWebMvc`啟用默認的 Spring MVC 配置，并注冊`DispatcherServlet`期望的 Spring MVC 基礎結構組件。 3. `@Configuration`指示一個類聲明一個或多個`@Bean`方法，并且可以由 Spring 容器進行處理以在運行時為這些 bean 生成 bean 定義和服務請求。 4. `@ComponentScan`注解用于指定要掃描的基本軟件包。任何用`@Component`和`@Configuration`注解的類都將被掃描。 5. `InternalResourceViewResolver`有助于將邏輯視圖名稱映射為直接查看特定預配置目錄下的文件。 6. `ResourceBundleMessageSource`使用指定的基本名稱（這里是消息）訪問資源包。 7. `LocalValidatorFactoryBean`運行`javax.validation.ValidationFactory`，并通過 Spring `Validator`接口以及 JSR-303 `Validator`接口和`ValidatorFactory`接口本身公開它。 ## 6\. Hibernate 配置該示例中使用的 Hibernate 配置是**基于 Hibernate Java 的配置**。 `HibernateConfig.java` ```java package com.howtodoinjava.demo.spring.config; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.ComponentScans; import org.springframework.context.annotation.Configuration; import org.springframework.orm.hibernate5.HibernateTransactionManager; import org.springframework.orm.hibernate5.LocalSessionFactoryBean; import org.springframework.transaction.annotation.EnableTransactionManagement; import com.howtodoinjava.demo.spring.model.User; @Configuration @EnableTransactionManagement public class HibernateConfig { @Autowired private ApplicationContext context; @Bean public LocalSessionFactoryBean getSessionFactory() { LocalSessionFactoryBean factoryBean = new LocalSessionFactoryBean(); factoryBean.setConfigLocation(context.getResource("classpath:hibernate.cfg.xml")); factoryBean.setAnnotatedClasses(User.class); return factoryBean; } @Bean public HibernateTransactionManager getTransactionManager() { HibernateTransactionManager transactionManager = new HibernateTransactionManager(); transactionManager.setSessionFactory(getSessionFactory().getObject()); return transactionManager; } } ``` * `LocalSessionFactoryBean`創建一個 Hibernate`SessionFactory`。這是在 Spring 應用程序上下文中設置共享的 Hibernate `SessionFactory`的常用方法。 * `EnableTransactionManagement`啟用 Spring 的注解驅動的事務管理功能。 * `HibernateTransactionManager`將來自指定工廠的 Hibernate 會話綁定到線程，可能每個工廠允許一個線程綁定的`Session`。該事務管理器適用于使用單個 Hibernate `SessionFactory`進行事務數據訪問的應用程序，但它也支持事務內的直接`DataSource`訪問，即純 JDBC。 `hibernate.cfg.xml` ```java <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> <hibernate-configuration> <session-factory> <property name="hibernate.archive.autodetection">class,hbm</property> <property name="hibernate.dialect">org.hibernate.dialect.HSQLDialect</property> <property name="hibernate.show_sql">true</property> <property name="hibernate.connection.driver_class">org.hsqldb.jdbcDriver</property> <property name="hibernate.connection.username">sa</property> <property name="hibernate.connection.password"></property> <property name="hibernate.connection.url">jdbc:hsqldb:mem:howtodoinjava</property> <property name="hibernate.hbm2ddl.auto">create</property> <property name="hibernate.c3p0.min_size">5</property> <property name="hibernate.c3p0.max_size">20</property> <property name="hibernate.c3p0.acquire_increment">2</property> <property name="hibernate.c3p0.acquire_increment">1800</property> <property name="hibernate.c3p0.max_statements">150</property> </session-factory> </hibernate-configuration> ``` ## 7\. Spring 控制器和 REST 映射控制器類具有用于`GET`和`POST`操作的兩個簡單的[ REST 映射](https://howtodoinjava.com/spring5/webmvc/controller-getmapping-postmapping/)。如果輸入字段未經驗證，則返回相同的表單 bean 以顯示錯誤消息。否則返回刷新的視圖。 `UserController.java` ```java package com.howtodoinjava.demo.spring.controller; import java.util.Locale; import javax.validation.alid; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.validation.BindingResult; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.PostMapping; import com.howtodoinjava.demo.spring.model.User; import com.howtodoinjava.demo.spring.service.UserService; @Controller public class UserController { @Autowired private UserService userService; @GetMapping("/") public String userForm(Locale locale, Model model) { model.addAttribute("users", userService.list()); return "editUsers"; } @ModelAttribute("user") public User formBackingObject() { return new User(); } @PostMapping("/addUser") public String saveUser(@ModelAttribute("user") @Valid User user, BindingResult result, Model model) { if (result.hasErrors()) { model.addAttribute("users", userService.list()); return "editUsers"; } userService.save(user); return "redirect:/"; } } ``` ## 8\. 服務和 DAO 層服務和 DAO 層是用`@Service`和`@Repository`注解注解的常規服務組件。 `@Transactional`注解在服務層應用，以支持事務。 > 閱讀更多：[`@Service`和`@Repository`注解](https://howtodoinjava.com/spring/spring-core/how-to-use-spring-component-repository-service-and-controller-annotations/) `UserService Interface amd Impl` ```java public interface UserService { void save(User user); List<User> list(); } @Service public class UserServiceImp implements UserService { @Autowired private UserDao userDao; @Transactional public void save(User user) { userDao.save(user); } @Transactional(readOnly = true) public List<User> list() { return userDao.list(); } } ``` `UserDao Interface and Impl` ```java public interface UserDao { void save(User user); List<User> list(); } @Repository public class UserDaoImp implements UserDao { @Autowired private SessionFactory sessionFactory; @Override public void save(User user) { sessionFactory.getCurrentSession().save(user); } @Override public List<User> list() { @SuppressWarnings("unchecked") TypedQuery<User> query = sessionFactory.getCurrentSession().createQuery("from User"); return query.getResultList(); } } ``` `User.java` ```java package com.howtodoinjava.demo.spring.model; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.Id; import javax.persistence.Table; import javax.validation.constraints.Size; import org.hibernate.validator.constraints.Email; import org.hibernate.validator.constraints.NotEmpty; @Entity @Table(name = "TBL_USERS") public class User { @Id @GeneratedValue @Column(name = "USER_ID") private Long id; @Column(name = "USER_NAME") @Size(max = 20, min = 3, message = "{user.name.invalid}") @NotEmpty(message="Please Enter your name") private String name; @Column(name = "USER_EMAIL", unique = true) @Email(message = "{user.email.invalid}") @NotEmpty(message="Please Enter your email") private String email; public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } } ``` ## 9\. 視圖和消息資源最后，使用了 JSP 文件，并使用了[消息資源包](https://howtodoinjava.com/spring-core/resolving-text-messages-in-spring-resourcebundlemessagesource-example/)。 `editUsers.jsp` ```java <%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%> <%@taglib uri="http://www.springframework.org/tags/form" prefix="form"%> <%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%> <!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>Spring5 MVC Hibernate Demo</title> <style type="text/css"> .error { color: red; } table { width: 50%; border-collapse: collapse; border-spacing: 0px; } table td { border: 1px solid #565454; padding: 20px; } </style> </head> <body> <h1>Input Form</h1> <form:form action="addUser" method="post" modelAttribute="user"> <table> <tr> <td>Name</td> <td> <form:input path="name" /> <br /> <form:errors path="name" cssClass="error" /> </td> </tr> <tr> <td>Email</td> <td> <form:input path="email" /> <br /> <form:errors path="email" cssClass="error" /> </td> </tr> <tr> <td colspan="2"><button type="submit">Submit</button></td> </tr> </table> </form:form> <h2>Users List</h2> <table> <tr> <td><strong>Name</strong></td> <td><strong>Email</strong></td> </tr> <c:forEach items="${users}" var="user"> <tr> <td>${user.name}</td> <td>${user.email}</td> </tr> </c:forEach> </table> </body> </html> ``` `messages.properties` ```java user.name.invalid = Name must be between {2} and {1} characters. user.email.invalid = Please enter valid email address. ``` ## 10\. 演示讓我們使用 [**maven tomcat7 插件**](https://howtodoinjava.com/maven/tomcat-maven-plugin-example/) 運行應用程序。執行 Maven 目標：`tomcat7:run`。網址：`http://localhost:8080` ![Initial Screen](https://img.kancloud.cn/2a/0d/2a0da27b06d78f1baeb75276bfe04eff_653x416.jpg) 初始界面 ![Invalid Input Validation](https://img.kancloud.cn/42/48/4248b042a870f3ce05ba366f9f48aaf8_657x429.jpg) 無效輸入的驗證 ![Valid Form Submission](https://img.kancloud.cn/44/05/4405bb8601bf4030207afa2ed812a3a8_654x450.jpg) 有效表單的提交檢查服務器日志。 `Console` ```java Hibernate: call next value for hibernate_sequence Hibernate: insert into TBL_USERS (USER_EMAIL, USER_NAME, USER_ID) values (?, ?, ?) Hibernate: select user0_.USER_ID as USER_ID1_0_, user0_.USER_EMAIL as USER_EMA2_0_, user0_.USER_NAME as USER_NAM3_0_ from TBL_USERS user0_ ``` 我希望您能找到這個 **Spring Hibernate Web 應用程序示例**，以開始開發自己的應用程序。這主要是針對初學者的，但是它將幫助您構建帶有注解的任何帶有 Hibernate 集成示例的 **Spring MVC**。學習愉快！ [下載源碼](https://github.com/lokeshgupta1981/spring-webmvc)