整合Spring+SpringMVC+MyBatis详细指南

最近刚好写完一个 ssm 项目，趁着现在知识点记得还算比较清晰，赶紧写一篇小文章记录一下如何整合Spring+SpringMVC+MyBatis。需要注意的是，本教程是基于注解的方式整合ssm框架的。

一、目录结构

首先，让我们瞅一瞅搭建完成后的目录结构，如下图所示：

然后，再介绍下该目录结构各部分在整个工程中所扮演的角色。

• dao：数据访问层，封装了基本的数据库操作，即简单的增删改查。
• meta：实体类层，包含我们通常所说的 POJO（Plain Ordinary Java Object），即简单 Java 对象。关于 meta 层常见的叫法还有 model 层或者 entity 层。
• service：业务层，负责业务逻辑的设计与处理。该层可以通过调用 dao 层的接口，来实现对复杂业务的处理。举例说明，我们有一个购买的业务，该业务一方面会生成订单，另一方面会对用户的账户余额、购物车等信息进行修改，这就会涉及到对多张表的操作。这时候，我们就是通过在 service 层注入 dao 来实现对数据库的各种操作，从而保证业务的实现。
• controller：控制层。这个控制，体现在两个方面：一方面，是控制业务流程。通过调用 service 接口实现对业务流程的控制；另一方面，是控制用户请求。根据用户请求的 URL 地址，找到对应的控制器，并提供相应的视图。
• util：工具层，主要封装了项目中的公用类方法，比如 web 开发中的分页插件、文件服务、日期处理等。
  
  

二、配置文件（核心）

配置文件是整合 ssm 框架的重中之重。在整合 ssm 框架的过程中，问题经常出现于配置文件。这类问题，往往十分严重又不易发现。因此，要避免因配置文件导致整合失败，就必须理清配置文件之间的关系，以及各部分配置的具体作用。在本例中，配置文件主要有以下 4 个：

• pom.xml 文件：负责依赖管理与插件配置等。
• web.xml 文件：负责Serlvet、Filter、Listener、ServletContext（上下文环境）的配置。
• spring-servlet.xml文件：负责视图层、控制层、静态资源的配置。
• application-context.xml 文件：负责数据源配置和 MyBatis 整合。

2.1 配置pom.xml

<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>panda.spring.learning</groupId>
    <artifactId>ssm-project</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <properties>
        <!-- 编码设置 -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
    </properties>
    <dependencies>
        <!-- servlet -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.0.1</version>
            <scope>provided</scope>
        </dependency>
        <!-- springMVC相关依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>4.3.2.RELEASE</version>
        </dependency>
        <!-- freemarker模板 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>4.2.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.23</version>
        </dependency>
        <!-- spring-jdbc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.2.1.RELEASE</version>
        </dependency>
        <!-- MySQL驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.40</version>
        </dependency>
        <!-- DBCP连接池 -->
        <dependency>
            <groupId>commons-dbcp</groupId>
            <artifactId>commons-dbcp</artifactId>
            <version>1.4</version>
        </dependency>
        <!-- MyBatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.0</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.5.1</version>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2.2 配置web.xml

在 ssm 项目中，web.xml 的作用主要就是配置 DispatcherServlet 转发器及配置文件路径，Tomcat 可以通过这些配置信息搭建起 web 服务。以下是 web.xml 的完整代码。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    version="3.0">
    <display-name>ssm-project</display-name>

    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>default.html</welcome-file>
        <welcome-file>default.htm</welcome-file>
        <welcome-file>default.jsp</welcome-file>
    </welcome-file-list>

    <!-- 加载配置文件 -->
    <!-- 如果没有指定，默认会去/WEB-INF/下加载 application-context.xml -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value> 
        classpath:application-context.xml </param-value>
    </context-param>

    <!-- 编码过滤器 -->
    <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <async-supported>true</async-supported>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!-- ContextLoaderListener监听器 -->
    <!-- 作用是启动 Web 容器时，自动装配 ApplicationContext 的配置信息 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <!-- DispatcherServlet请求转发器 -->
    <servlet>
        <servlet-name>spring</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>spring</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

2.3 配置spring-servlet.xml

我们在 web.xml 中已经配置了 DispatcherServlet 及其映射路径，但这还不够，我们还需要专门新建一个 xml 文件来配置 DispatcherServlet 的详细信息。需要注意的是，这个 xml 文件需要以 ${name}-servlet 的形式命名。比如在我的示例中，就是 spring-servlet.xml。
那么，现在有一个问题来了，这个 DispatcherServlet 转发器，究竟是干啥用的？这就要说一段比较久远的故事了。在以前，我们要使用 web 项目的某个服务，都是通过 URL 映射到 web.xml 中对应的 Servlet，由该 Servlet 的实现来提供具体的服务。但是，想想一种情况，当我们的项目非常大的时候，怎么办？web.xml 中要配置成千上万的 Servlet 吗？若真如此，面对如此臃肿的配置文件，我们该如何维护？所幸，springMVC 提供了请求转发器 DispatcherServlet，由其来拦截用户的请求，然后再根据请求的 URL 来转发到对应的控制器。所以，我们的控制层和视图层相关的配置，可以写在这里。
注：本例视图层使用的是 FreeMarker，所以用的视图解析器是 FreeMarkerViewResolver。如果想使用 JSP，可以使用 InternalResourceViewResolver。

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/mvc
    http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自动扫描的包 -->
    <context:component-scan base-package="panda.spring.learning.*" />

    <!-- 开启注解映射的支持 -->
    <mvc:annotation-driven />

    <!-- 访问静态资源 -->
    <mvc:resources mapping="/**" location="/" />

    <!-- 配置 freemarker 解析器 -->
    <bean id="freemarkerConfig"
        class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
        <!-- 指定模板路径 -->
        <property name="templateLoaderPath" value="/template" />
        <property name="freemarkerSettings"> 
            <props>
                <prop key="defaultEncoding">UTF-8</prop> 
                <prop key="url_escaping_charset">UTF-8</prop> 
                <prop key="locale">zh_CN</prop> 
                <prop key="boolean_format">true,false</prop> 
                <prop key="datetime_format">yyyy-MM-dd HH:mm:ss</prop> 
                <prop key="date_format">yyyy-MM-dd</prop> 
                <prop key="time_format">HH:mm:ss</prop> 
                <prop key="number_format">0.######</prop> 
                <prop key="whitespace_stripping">true</prop>
            </props>
        </property> 
    </bean>
    <bean id="viewResolver"
        class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
        <!-- 开启缓存，当再次请求时直接拿上次的结果，开发的时候先关闭 -->
        <property name="cache" value="false" />
        <property name="prefix" value="" />
        <property name="suffix" value=".ftl" />
        <property name="contentType" value="text/html; charset=utf-8" />
        <property name="exposeRequestAttributes" value="false" /> 
        <property name="exposeSessionAttributes" value="false" /> 
        <property name="exposeSpringMacroHelpers" value="true" /> 
    </bean>
</beans>

2.4 配置application-context.xml

在本例中，将与 MyBatis 、数据源、事务的相关配置放在 application-context.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:aop="http://www.springframework.org/schema/aop"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
    xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/aop
    http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
    http://www.springframework.org/schema/tx
    http://www.springframework.org/schema/tx/spring-tx.xsd
    http://mybatis.org/schema/mybatis-spring
    http://mybatis.org/schema/mybatis-spring.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 整合 MyBatis -->
    <!-- 扫描 dao 层，告知 MyBatis dao 层的位置 -->
    <mybatis:scan base-package="panda.spring.learning.dao"/>
    <!-- 配置 MyBatis 核心 SqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!-- 指明 mybatis 配置文件路径 -->
        <property value="classpath:mybatis-conf.xml" name="configLocation" />
    </bean>

    <!-- 配置事务管理器 -->
    <bean id="txManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>

    <!-- 使用注解方式实现事务 -->
    <tx:annotation-driven transaction-manager="txManager"/>

    <!-- 使用声明式事务管理 -->
    <!-- <tx:advice id="txAdvice" transaction-manager="txManager">
        <tx:attributes>
            <tx:method name="transfer*"/>
        </tx:attributes>
    </tx:advice> -->

    <!-- 配置数据源 -->
    <bean id="dataSource" class=
        "org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driverClassName}" />
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
    </bean>

    <!-- 指定 db 配置文件 -->
    <bean id="dbProperties" 
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="classpath:db.properties"></property>
    </bean>

</beans>

关于配置文件的展示，就到这里，至于其他的配置文件，如 db.properties、mybatis-conf.xml、log4j.properties 等，就不予展示啦。如有兴趣，可以直接将源码下下来瞅瞅。

扫描二维码关注公众号，回复： 2753185 查看本文章

三、项目代码

3.1 dao 层代码

package panda.spring.learning.dao;

import panda.spring.learning.meta.User;

/**
 * 用户数据访问对象
 * @author panda
 *
 */
public interface UserDao {
    /**
     * 根据用户名获取账号信息
     * @param userName
     * @return
     */
    public User getUser(String userName);

}

3.2 meta 层代码

package panda.spring.learning.meta;


public class User {

    /**
     * 用户名
     */
    private String userName;
    /**
     * 用户密码
     */
    private String pwd;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

}

3.3 service 层代码

3.3.1 UserService

package panda.spring.learning.service;

import panda.spring.learning.meta.User;

public interface UserService {

    User getUser(String userName);
}

3.3.2 UserServiceImpl

package panda.spring.learning.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import panda.spring.learning.dao.UserDao;
import panda.spring.learning.meta.User;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    public User getUser(String userName) {
        return userDao.getUser(userName);
    }

}

3.4 controller 层代码

package panda.spring.learning.web.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

import panda.spring.learning.meta.User;
import panda.spring.learning.service.UserService;

@Controller
public class UserLoginController {

    @Autowired
    private UserService userService;

    /**
     * 进入登录页
     * @return
     */
    @RequestMapping(value="/login")
    public String getLoginPage() {
        // springMVC 会根据你返回的名称，找到对应的 FreeMarker 模板，注意，返回值是 String
        return "login";
    }

    /**
     * 登录后跳转页
     * @param loginUser
     * @param model
     * @return
     */
    @RequestMapping(value="/index")
    public String login(User loginUser, ModelMap model) {
        User user = null;
        if( loginUser == null || loginUser.getUserName() == null || loginUser.getUserName().equals("") ) {
            return "error";
        }
        if( loginUser != null) {
            user = userService.getUser(loginUser.getUserName());
            if( user != null ) {
                if( user.getPwd().equals(loginUser.getPwd()) ) {
                    model.addAttribute("user", user);
                } else {
                    model.addAttribute("user", null);
                }
            }
        }
        return "index";
    }
}

3.5 util 层代码

咳咳，因为本例过于简单，所以暂时不需要工具类。

四、成果展示

至此，我们的 ssm 项目整合成功！一起瞅瞅具体的效果吧！

最后，源码已经发到 github 上，详情请戳链接：项目源码。

结语

关于 ssm 整合的分享就到这里。因为本人还只是入行不到一年的小菜鸟，所以很多东西上的阐述可能不严谨甚至是有纰漏的地方，因此还要麻烦各位大神多多指点！