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:/test
driverClassName=com.mysql.jdbc.Driver
username=root
password=admin
maxActive=
initialSize=
maxWait=
minIdle=
timeBetweenEvictionRunsMillis=
minEvictableIdleTimeMillis=
validationQuery=SELECT

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。

Spring MVC + Mybatis 環境搭建

繼續閱讀

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

用mybatis的generator插件在項目中自動生成dao及entity

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

SpringMVC傳回用戶端Json/XML資料

Ajax發送和擷取json資料到Spring mvc 1.spring mvc後端2.web前段

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

從mybatis到mybatis plus(mp)

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method