Spring MVC + Mybatis 环境搭建

使用Spring MVC和Mybatis也做过几个项目了，一直没有整理过搭建过程，所以最近重新开始搞了一个最最基础的example，只有一个登陆，但是基础配置还是相对完整的，可供新人参考思路。该项目使用maven进行管理，如果有不理解的地方可自行搜索相关文档学习一下，也可去http://blog.csdn.net/qq_19656425找从零开始系列博客进行了解。
首先建立一个空的maven项目，在pom文件中配置好相关依赖。
配置web.xml文件

<!-- 该listener可视情况选择是否配置 -->
<listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring-config.xml</param-value>
    </context-param>
    <!-- html页面和静态资源交给容器（Tomcat、Jetty等）处理 -->
    <servlet-mapping>
        <!-- 容器默认的servlet名 -->
        <servlet-name>default</servlet-name>
        <url-pattern>*.html</url-pattern>
        <url-pattern>/static/</url-pattern>
    </servlet-mapping>
    <!-- 该项目中使用rest servlet拦截restful风格的请求，统一返回json字符串或json对象 -->
    <servlet>
        <servlet-name>rest</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:rest-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>rest</servlet-name>
        <!-- 如果访问/rest/login，会截掉前缀使用/login进行requestMapping的匹配 -->
        <url-pattern>/rest/*</url-pattern>
    </servlet-mapping>
    <!-- 该servlet拦截的请求返回jsp页面 -->
    <servlet>
        <servlet-name>pages</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:pages-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>pages</servlet-name>
        <url-pattern>/pages/*</url-pattern>
    </servlet-mapping>

web.xml的主要配置就这么多，rest和pages两个servlet可以根据需要一般只配置一个统一的即可。
spring-config.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:tx="http://www.springframework.org/schema/tx"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
       xsi:schemaLocation="http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       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/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd
       http://mybatis.org/schema/mybatis-spring
       http://mybatis.org/schema/mybatis-spring.xsd">
    <!-- 开始Spring MVC功能 -->
    <mvc:annotation-driven/>
    <context:component-scan base-package="com.heuman.service"/>
    <!-- 扫描base-package包下的接口并注册成bean -->
    <mybatis:scan base-package="com.heuman.mapper"/>
    <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <!-- 数据库配置资源文件 -->
                <value>classpath:properties/db.properties</value>
            </list>
        </property>
    </bean>
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="typeAliasesPackage" value="com.heuman.vo"/>
        <property name="mapperLocations" value="classpath*:com/heuman/mapper/xml/**/*.xml"/>
        <!--<property name="typeHandlersPackage" value="com.heuman.config.mybatis.typehandler"/>-->
        <property name="configuration">
            <bean class="org.apache.ibatis.session.Configuration">
                <property name="mapUnderscoreToCamelCase" value="true"/>
            </bean>
        </property>
    </bean>
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close">
        <!-- 数据库基本信息配置，可以使用${key}从上面配置的资源文件中拿对应的value -->
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
        <property name="driverClassName" value="${driverClassName}"/>
        <property name="maxActive" value="${maxActive}"/>
        <property name="initialSize" value="${initialSize}"/>
        <property name="maxWait" value="${maxWait}"/>
        <property name="minIdle" value="${minIdle}"/>
        <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
        <property name="timeBetweenEvictionRunsMillis" value="${timeBetweenEvictionRunsMillis}"/>
        <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
        <property name="minEvictableIdleTimeMillis" value="${minEvictableIdleTimeMillis}"/>
        <property name="validationQuery" value="${validationQuery}"/>
    </bean>
    <!-- 配置事务 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!-- 使用@Transactional开启事务（注：方法修饰符必须为public） -->
    <tx:annotation-driven transaction-manager="transactionManager"/>
</beans>

db.properties

url=jdbc:mysql://localhost:3306/test
driverClassName=com.mysql.jdbc.Driver
username=root
password=admin
maxActive=20
initialSize=1
maxWait=30000
minIdle=1
timeBetweenEvictionRunsMillis=60000
minEvictableIdleTimeMillis=300000
validationQuery=SELECT 1

rest-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:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <mvc:annotation-driven>
        <!-- 使用fastjson对json（content-type为application/json）进行解析（Spring MVC默认使用jackson） -->
        <mvc:message-converters register-defaults="true">
            <bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter4">
                <property name="fastJsonConfig">
                    <bean class="com.alibaba.fastjson.support.config.FastJsonConfig">
                        <property name="dateFormat" value="yyyy-MM-dd"/>
                    </bean>
                </property>
                <property name="supportedMediaTypes">
                    <list>
                        <bean class="org.springframework.http.MediaType">
                            <constructor-arg type="java.lang.String" value="application"/>
                            <constructor-arg type="java.lang.String" value="json"/>
                        </bean>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    <context:component-scan base-package="com.heuman.controller.rest"/>
</beans>

pages-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:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <mvc:annotation-driven/>
    <context:component-scan base-package="com.heuman.controller.page"/>
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

LoginController.java

@Controller
public class LoginController {

    private final transient Logger logger = LoggerFactory.getLogger(LoginController.class);

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/login", method = RequestMethod.POST, consumes = {"application/json"})
    @ResponseBody
    public Object login(@RequestBody User user, HttpSession session) {
        if (logger.isDebugEnabled()) {
            logger.debug(user.toJson());
        }
        // 已经登录
        if (session.getAttribute("user") != null) {
            return Result.newSuccessResult().toJson();
        }
        String errorMsg;
        if (StringUtils.isBlank(user.getUsername()) || StringUtils.isBlank(user.getPassword())) {
            errorMsg = "用户名和密码不能为空";
        } else {
            User u = userService.findByUsernamePassword(user);
            if (u == null) {
                errorMsg = "用户名或密码错误";
            } else {
                if (logger.isInfoEnabled()) {
                    logger.info("####### {} login #######", u.getUsername());
                }
                session.setAttribute("user", u);
                return Result.newSuccessResult().toJson();
            }
        }
        Result result = Result.newErrorResult();
        result.setMsg(errorMsg);
        return result.toJson();
    }

    @RequestMapping(value = "/logout")
    public String logout(HttpSession session) {
        session.removeAttribute("user");
        return PathUtil.append("redirect:", Config.getPagesPath(), "/index");
    }
}

注：toJson方法是自定义的对象转json
UserService.java

@Service
public class UserService {

    private final transient Logger logger = LoggerFactory.getLogger(UserService.class);

    @Autowired
    private UserMapper userMapper;

    public User findByUsernamePassword(User user) {
        return userMapper.findByUsernameAndPassword(user.getUsername(), user.getPassword());
    }
}

UserMapper.java

@Mapper
public interface UserMapper {
    //也可不用@Param，而使用#{param1}，#{param2}...去获取参数
    @Select("select * from user where username=#{username} and password=#{password}")
    User findByUsernameAndPassword(@Param("username") String username, @Param("password") String password);

}

HomeController.java

@Controller
public class HomeController {

    private final transient Logger logger = LoggerFactory.getLogger(HomeController.class);

    @RequestMapping("/index")
    public String index(HttpSession session, Model model) {
        if (session.getAttribute("user") != null) {
            model.addAttribute("username", ((User)session.getAttribute("user")).getUsername());
            return "index";
        }
        return "logout";
    }

}

login.html页面是登录页面，当用户登录时通过ajax访问/rest/login页面，如果返回结果表示登录成功，则转到/pages/index，HomeController类中的index方法接收到该请求把username放到request中，接着转到/WEB-INF/pages/index.jsp页面。
index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<!DOCTYPE html>
<html lang="zh-cmn-Hans">
<head>
    <title>首页</title>
</head>
<body>
<div>
    <h4><%=request.getAttribute("username")%>, HelloWorld welcome you!</h4>
</div>
</body>
</html>

代码已上传到github：https://github.com/heumanpub/ssm-example，细节解释的不多，不理解的地方可以google。