Spring+SpringMVC4+Mybatis3+MySQL框架环境搭建和案例解析

• 框架需求
• 案例解析
• 经验问题总结

SSM框架，已经被越来越多的公司企业所采用的主流框架。本人出于兴趣原因，利用业余时间，从优快云上找了一些案例进行学习、研究，在案例的反复调试、测试过程中，遇到了很多问题（因为很多案例解析不详细，导致我反复碰壁~_~）。因此，我将在调试过程中遇到的问题和小小的心得分享出来，供各位网友借鉴。声明：高手请匆匆而过！针对一些初学者和有兴趣研究一下这个框架的同学，本文可能有一定的借鉴意义。

框架需求

1. IDE:eclipse(for jee)

2. 所需jar包：

• spring jar包
  
• mybatis jar包
  
• MySQL jar包（jdbc数据库链接）
  
• 其他 jar包 （log、jstl）
  

将上面的所有jar整合以后，全部放在WEB-INF下的lib文件夹中，如下：

案例解析

通过实际案例，分析代码，是学习知识最便捷的方式，因此，下面，我将通过一个“用户信息的增改删查”案例，详细介绍Spring+SpingMVC+Mybatis+Mysql框架的搭建和功能实现。

1. 新建web project项目

-项目名称：SpringAndMybatis

2. 在WEB-INF下，新建lib文件夹，并拷贝进上面所提到的所有jar包。

3. 配置web.xml

• 声明入口页面：即在index.jsp（这里切记一点：index.jsp文件必须放在WebContent文件夹下，不能放在WEB-INF下，否则，启动以后，无法进入第一个页面。

• 声明spring和mybatis配置文件：

    <!-- Spring和mybatis的配置文件 -->  
    <context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>classpath:applicationContext.xml</param-value>  
    </context-param>  

• 声明spring监听器：

    <!-- Spring监听器 -->  
    <listener>  
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
    </listener>  
    <!-- 防止Spring内存溢出监听器 -->  
    <listener>  
        <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>  
    </listener>

• 声明编码过滤器（编码过滤器是web开发中一般都是要使用的）

    <!-- 编码过滤器 -->  
    <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> 

• 声明dispatcherServlet（这是SpringMVC核心映射管理器）

    <!-- Spring MVC servlet -->  
    <servlet>  
        <servlet-name>SpringMVC</servlet-name>  
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
        <init-param>  
            <param-name>contextConfigLocation</param-name>  
            <param-value>classpath:spring-mvc.xml</param-value>  
        </init-param>  
        <load-on-startup>1</load-on-startup>  
        <async-supported>true</async-supported>  
    </servlet>  
    <servlet-mapping>  
        <servlet-name>SpringMVC</servlet-name>  
        <!-- 此处可以可以配置成*.do，对应struts的后缀习惯 -->  
        <url-pattern>*.do</url-pattern>  
    </servlet-mapping>

• 声明静态文件映射（在SpringMVC中，为了能访问静态文件，一般都需要声明静态文件映射）

    <!-- 配置静态资源不经过spring mvc -->
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.css</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.js</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.json</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.gif</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.png</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.jpg</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.ico</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.doc</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.xls</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.docx</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.xlsx</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.txt</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.swf</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.ocx</url-pattern>
    </servlet-mapping>
        <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.cab</url-pattern>
    </servlet-mapping>   

至此，web.xml基本配置完毕！

4. 配置applicationContext.xml

说明：在web.xml文件中，显示声明了上下文配置文件（即spring和mybatis配置文件）为classpath:applicationContext.xml
classpath：意思是只在class目录下（注意区别classpath*）。

• beans头声明：

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

这里需要注意：所有需要添加的链接都不能缺少，而且，同类声明之间不能随便隔开，例如：

上图，被红方框圈起来的两个链接，被其中选定的链接隔开了，就会报错（有些标签找不到声明）如下：
cvc-complex-type.2.4.c: The matching wildcard is strict, but no declaration can be found for element ‘tx:annotation-driven’.

• SpringMVC“注解”声明和扫描（每个SpringMVC都必须要配置的内容，只有配置这里，dispatcherServlet才能根据请求，找到指定的controller进行处理）：

  <!-- spring基础配置 begin -->  
    <context:annotation-config/>  

  <!-- 自动扫描 -->  
    <context:component-scan base-package="com.test" /> 

• 声明数据库链接配置信息：

这里首先需要建立一个数据库链接配置文件，这里以jdbc为例–“jdbc.properties”，该文件一般与其他配置文件放在一个目录下，例如：

jdbc-properties配置文件内容如下：

上图：mybatis为数据库名。

引入数据库配置文件：

   <!-- 引入配置文件 -->  
    <bean id="propertyConfigurer"  
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
        <property name="location" value="classpath:jdbc.properties" />  
    </bean>  

• 配置数据源（DataSource）：

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

• 声明与数据库进行具体操作的mapper.xml（具体内容即sql操作语句）的位置信息：

    <!-- 2.spring和MyBatis完美整合，不需要mybatis的配置映射文件 -->  
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  
        <property name="dataSource" ref="dataSource" />  
        <!-- 自动扫描mapper.xml文件 :这里有下面两种方式-->  
        <!-- 第一种是：直接声明mapper.xml文件所在位置 （如采用这种方式，则不需要mybatis-config.xml配置文件）-->
        <!-- <property name="mapperLocations" value="classpath:mapper/*.xml"></property> -->

        <!-- 第二种是：采用mybatis配置文件(mybatis-config.xml)的方式来间接声明mapper.xml文件的位置，同时，这里可以直接定义mapper.xml文件中所用到的各种类的别名 -->
        <property name="configLocation" value="classpath:mybatis-config.xml" />  

    </bean>

从上图，大家可以看到，我已经说明了两种声明方式，第一种是直接通过mapperLocations指定*mapper.xml文件位置；

上图声明的是mapperLocation，位置是在class路径下的mapper文件夹下的所有xml文件，即mapper.xml。

另一种是间接通过声明mybatis的配置文件（mybatis-config.xml）位置，声明*mapper.xml的位置信息，当然mybatis-config.xml还可以*mapper.xml文件中所有类型的别名等。

上图声明的mybatis配置文件在class路径下，名字为mybatis-config.xml，该文件其中声明了*mapper.xml的位置。

• 声明与*mapper.xml对应的DAO所在包名（这个很关键！必须要正确！）

    <!-- 3.DAO接口所在包名，Spring会自动查找其下的类 -->  
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">  
        <property name="basePackage" value="com.test.mapper" />  
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>  
    </bean>

上图，所有与各种*mapper.xml对应的DAO，都放在了com.test.mapper包下。

• 设定事务管理（transactionManager）

    <!-- 4.设定事务管理配置(transactionManager) -->    
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">    
            <property name="dataSource" ref="dataSource" />  
    </bean>    

    <!-- 通过注解配置事务 -->  
   <!-- 5. 使用声明式事务  
         transaction-manager：引用上面定义的事务管理器  
     -->  
    <tx:annotation-driven transaction-manager="txManager" /> 
    <!-- spring基础配置 end -->  

至此，spring和mybatis全局配置文件，总算配置完成了~

5. 配置mybatis的配置文件–mybatis-config.xml

• 声明mybatis-config.xml（如果在applicationContext.xml中声明*mapper.xml位置信息的方式采用的是第二种：configLocation的形式。否则，这个文件就不需要配置）

上图，最关键的是（必须配置的）：

这个配置，是与前面第一种mapper.xml位置信息声明异曲同工：

• 别名设置：

如果这里不设置User和Integer的别名，那么在mapper.xml中的类型，就必须要声明清楚：java.lang.Integer,com.test.model.User。

6. 配置DispatcherServlet的配置文件–spring-mvc.xml

说明：web.xml显式声明了DispatcherServlet——SpringMVC的contextConfigLocation是class路径下的spring-mvc.xml（如果这里没有声明，系统将默认SpringMVC的配置文件是SpringMVC-Servlet.xml）。

• 配置Controller控制器所在包名，以及视图解析器的解析模式。

    <!-- 注解驱动:相当于注册了DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter两个bean，配置一些messageconverter。即解决了@Controller注解的使用前提配置。 -->  
    <mvc:annotation-driven/>  

    <!-- 配置自动扫描的包路径:自动扫描该包，使SpringMVC认为包下用了@controller注解的类是控制器  -->    
    <context:component-scan base-package="com.test"/>   

    <!-- 定义跳转的文件的前后缀 ，视图模式配置-->  
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  
        <!-- 这里的配置我的理解是自动给后面action的方法return的字符串加上前缀和后缀，变成一个 可用的url地址 -->  
        <property name="prefix" value="/WEB-INF/" />  
        <property name="suffix" value=".jsp" />  
    </bean>

• 配置json响应模式以及文件上传下载配置（如果web中需要页面响应功能–“添加成功”“删除成功”等提示，以及文件上传下载功能）

  <!--避免IE执行AJAX时，返回JSON出现下载文件 -->  
    <bean id="mappingJacksonHttpMessageConverter"  
        class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">  
        <property name="supportedMediaTypes">  
            <list>  
                <value>text/html;charset=UTF-8</value>  
            </list>  
        </property>  
    </bean>  

    <!-- 启动SpringMVC的注解功能，完成请求和注解POJO的映射 -->  
    <bean  
        class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">  
        <property name="messageConverters">  
            <list>  
                <ref bean="mappingJacksonHttpMessageConverter" /> <!-- JSON转换器 -->  
            </list>  
        </property>  
    </bean>    

      <!-- 配置文件上传，如果没有使用文件上传可以不用配置，当然如果不配，那么配置文件中也不必引入上传组件包 -->  
    <bean id="multipartResolver"    
        class="org.springframework.web.multipart.commons.CommonsMultipartResolver">    
        <!-- 默认编码 -->  
        <property name="defaultEncoding" value="utf-8" />    
        <!-- 文件大小最大值 -->  
        <property name="maxUploadSize" value="10485760000" />    
        <!-- 内存中的最大值 -->  
        <property name="maxInMemorySize" value="40960" />    
    </bean>

至此，SpringMVC最关键的DispatcherServlet配置完成~

7.配置mapper.xml

例如，在本案例中，操作数据库表User，所对应的mapper.xml是UserMapper.xml，它对应的类是com.test.mapper下面的类UserMapper。
UserMapper.java:

package com.test.mapper;

import java.util.List;

import com.test.model.User;

public interface UserMapper {

    void save(User user);
    boolean update(User user);
    boolean delete(int id);
    User findById(int id);
    List<User> findAll();
}

UserMapper.xml：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"   
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">  
<!-- 
    这里需要注意的事项：  
    1.namespace：必须与对应的接口全类名一致  
    2.id:必须与对应接口的某个对应的方法名一致  
    3.数据类型（例如User、Integer等，如果在mybatis-config中已经声明了别名，则直接使用别名，否则，必须使用全名（例如com.test.model.User、java.lang.Integer）） 

 --> 
<mapper namespace="com.test.mapper.UserMapper">
    <insert id="save" parameterType="User">
        insert into user (user_name,user_age) values (#{userName},#{age})
    </insert>

    <update id="update" parameterType="User">
        update user set user_name=#{userName}, user_age=#{age} where user_id=#{id}
    </update>

    <delete id="delete" parameterType="Integer">
        delete from user where user_id=#{id}
    </delete>

    <select id="findById" parameterType="Integer" resultType="User">
        select user_id id,user_name userName,user_age age from user where user_id =#{id}
    </select>

    <select id="findAll" resultType="User">
        select user_id id,user_name userName,user_age age from user
    </select>
</mapper>

8.编写具体web页面和逻辑代码

这里只贴一下UserController的代码，因为这是前端控制器Controller的处理逻辑。

UserController.java:

package com.test.controller;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

import com.test.service.UserService;
import com.test.model.User;

@Controller
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    /**
     * 获取所有用户列表
     * @param request
     * @return
     */
    @RequestMapping("/getAllUser.do")
    public String getAllUser(HttpServletRequest request){

        List<User> findAll = userService.findAll();

        request.setAttribute("userList", findAll);
        return "allUser";
    }

    /**
     * 跳转到添加用户界面
     * @param request
     * @return
     */
    @RequestMapping("/toAddUser.do")
    public String toAddUser(HttpServletRequest request){

        return "addUser";
    }

    /**
     * 添加用户并重定向
     * @param user
     * @param request
     * @return
     */
    @RequestMapping("/addUser.do")
    public String addUser(User user,HttpServletRequest request){
        userService.save(user);
        return "redirect:/user/getAllUser.do";
    }

    /**
     * 获取所有用户列表
     * @param request
     * @return
     */
    @RequestMapping("/save.do")
    public String save(HttpServletRequest request){

        System.out.println("save");
        User user = new User();
        user.setUserName("yanwenju");
        user.setAge("100");
        userService.save(user);

        //request.setAttribute("userList", findAll);
        return "index";
    }

    /**
     * 删除用户
     * @param id
     * @param request
     * @param response
     */
    @RequestMapping("/deleteUser.do")
    public void delUser(int id,HttpServletRequest request,HttpServletResponse response){
        String result = "{\"result\":\"error\"}";

        if(userService.delete(id)){
            result = "{\"result\":\"success\"}";
        }

        response.setContentType("application/json");

        try {
            PrintWriter out = response.getWriter();
            out.write(result);
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    /**
     * 根据id查询单个用户
     * @param id
     * @param request
     * @return
     */
    @RequestMapping("/getUser.do")
    public String getUser(int id,HttpServletRequest request){

        request.setAttribute("user", userService.findById(id));
        return "editUser";
    }
    /**
     *编辑用户
     * @param user
     * @param request
     * @return
     */
    @RequestMapping("/updateUser.do")
    public String updateUser(User user,HttpServletRequest request){


        if(userService.update(user)){
            user = userService.findById(user.getId());
            request.setAttribute("user", user);
            return "redirect:/user/getAllUser.do";
        }else{
            return "error";
        }
    }   
}

如果需要整个项目的源代码，可以联系我，QQ：596703245

经验问题总结

• 项目的框架搭建很关键，要注意每个配置文件的具体位置，一旦配置文件的具体位置与配置信息不匹配，项目根本无法运行，或者各种错误。
  建议：除了web.xml放在webContent下的WEB-INF下面，其他配置文件统一放在javaResources->config下面。所有的mapper.xml统一放在javaResource->config->mapper下面。这样以来，除了web.xml文件以外，程序编译和发布后，其他配置文件都在classes文件夹下面。

• 一定要区分开全局配置文件(这里是applicationContext.xml)和DispatcherServelt的配置文件。mybatis的配置信息以及数据库链接信息等都是在applicationContext.xml中配置的。DispatcherServelt中配置的只是与请求访问相关的信息。

项目源代码下载