Spring Web MVC和Hibernate的集成

女爷i 2022-07-12 03:14 149阅读 0赞

网上看到很多关于Spring与Hibernate的集成的文章，奈何由于那些文章写作时间较早，很多都是Spring 3 和Hibernate 4等较旧的版本。所以我在这里使用更新的版本来说明一下。

## 添加项目依赖 ##

首先我们需要一个Java Web项目，最好使用Maven或Gradle构建工具，方便我们解决软件依赖。我在这里使用Gradle构建工具，构建脚本如下。我们只要引入`spring-webmvc`和`spring-orm`这两个包，其他的Spring依赖会自动由构建工具解决。然后还需要引入数据源、Hibernate、JSTL等依赖项。脚本的最后定义了一个任务用于生成对应的pom文件方便Maven工具使用。

group 'yitian.learn'
    version '1.0-SNAPSHOT'
    
    apply plugin: 'java'
    apply plugin: 'war'
    apply plugin: 'maven'
    apply from: 'https://raw.github.com/akhikhl/gretty/master/pluginScripts/gretty.plugin'
    
    sourceCompatibility = 1.8
    
    repositories {
        maven {
            url "http://maven.aliyun.com/nexus/content/groups/public/"
        }
        jcenter()
    }
    ext {
        springVersion = '4.3.6.RELEASE'
        aspectjVerison = '1.8.10'
    }
    
    dependencies {
        testCompile group: 'junit', name: 'junit', version: '4.12'
    
        compile group: 'org.springframework', name: 'spring-webmvc', version: springVersion
        compile group: 'org.springframework', name: 'spring-orm', version: springVersion
    
        compile group: 'org.glassfish.web', name: 'jstl-impl', version: '1.2'
        compile group: 'org.projectlombok', name: 'lombok', version: '1.16.12'
        compile group: 'org.hibernate', name: 'hibernate-core', version: '5.2.6.Final'
        compile group: 'mysql', name: 'mysql-connector-java', version: '5.1.40'
        compile group: 'org.apache.commons', name: 'commons-dbcp2', version: '2.1.1'
    
        compile group: 'org.aspectj', name: 'aspectjweaver', version: aspectjVerison
    
    }
    
    task writeNewPom {
        doLast {
            pom {
            }.writeTo("$projectDir/pom.xml")
        }
    }

## 配置web.xml ##

然后打开`WEB-INF/web.xml`文件，添加以下内容。

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1">
        <context-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/applicationContext.xml</param-value>
        </context-param>
        <servlet>
            <servlet-name>dispatcher</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <load-on-startup>1</load-on-startup>
            <async-supported>true</async-supported>
        </servlet>
        <servlet-mapping>
            <servlet-name>dispatcher</servlet-name>
            <url-pattern>/</url-pattern>
        </servlet-mapping>
        <listener>
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
        </listener>
    </web-app>

## 配置Spring ##

相对应的应该有两个Spring配置文件`/WEB-INF/applicationContext.xml`和`/WEB-INF/dispatcher-servlet.xml`。前者是根配置文件，用于配置数据库等后端、全局的组件，后者是MVC配置文件，用于配置MVC和Web相关的组件。

然后在`/WEB-INF/applicationContext.xml`中，我们配置Hibernate和Spring集成的组件。我们需要配置数据源、HibernateSessionFactory、Hibernate事务管理器、事务连接点、Hibernate模板等Bean，然后在操作数据的时候使用Hibernate模板，就能获得Spring控制的事务管理功能了。

<?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:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
    
        <context:annotation-config/>
        
        <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">
            <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql://localhost:3306/test"/>
            <property name="username" value="root"/>
            <property name="password" value="12345678"/>
        </bean>
    
        
        <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean">
            <property name="dataSource" ref="dataSource"/>
            <property name="hibernateProperties">
                <props>
                    <prop key="hibernate.format_sql">true</prop>
                    <prop key="hibernate.show_sql">true</prop>
                    <prop key="hibernate.hbm2ddl.auto">create</prop>
                </props>
            </property>
            <property name="packagesToScan" value="yitian.learn.entity"/>
        </bean>
        
        <bean id="hibernateTemplate" class="org.springframework.orm.hibernate5.HibernateTemplate">
            <property name="sessionFactory" ref="sessionFactory"/>
        </bean>
        
        <bean id="transactionManager" class="org.springframework.orm.hibernate5.HibernateTransactionManager">
            <property name="sessionFactory" ref="sessionFactory"/>
        </bean>
        
        <bean id="userDao" class="yitian.learn.dao.HibernateUserDao"/>
        
        <tx:advice id="txAdvice" transaction-manager="transactionManager">
            <tx:attributes>
                <tx:method name="find*" read-only="true"/>
                <tx:method name="*"/>
            </tx:attributes>
        </tx:advice>
        
        <aop:config>
    
            <aop:pointcut id="userDaoPointcut" expression="execution(* yitian.learn.dao.*.*(..))"/>
            <aop:advisor advice-ref="txAdvice" pointcut-ref="userDaoPointcut"/>
    
        </aop:config>
    
    </beans>

然后来配置一下Spring Web MVC的组件。在`dispatcher-servlet.xml`中添加以下配置。这里添加了JSP视图解析器和类型转换器，如果不需要自定义类型转换可以将对应片段删掉。

至此，Hibernate与Spring的集成就算配置完了。最后我还写了一个小例子，放在了[Github][]上，有兴趣的同学可以看看。

[Github]: https://github.com/techstay/spring-project-templates