Spring MVC 完整示例

Franson發表於2016-06-21

在本例中,我們將使用Spring MVC框架構建一個入門級web應用程式。Spring MVC 是Spring框架最重要的的模組之一。它以強大的Spring IoC容器為基礎,並充分利用容器的特性來簡化它的配置。

MVC框架是什麼

模型-檢視-控制器(MVC)是一個眾所周知的以設計介面應用程式為基礎的設計模式。它主要通過分離模型、檢視及控制器在應用程式中的角色將業務邏輯從介面中解耦。通常,模型負責封裝應用程式資料在檢視層展示。檢視僅僅只是展示這些資料,不包含任何業務邏輯。控制器負責接收來自使用者的請求,並呼叫後臺服務(manager或者dao)來處理業務邏輯。處理後,後臺業務層可能會返回了一些資料在檢視層展示。控制器收集這些資料及準備模型在檢視層展示。MVC模式的核心思想是將業務邏輯從介面中分離出來,允許它們單獨改變而不會相互影響。

在Spring MVC應用程式中,模型通常由POJO物件組成,它在業務層中被處理,在持久層中被持久化。檢視通常是用JSP標準標籤庫(JSTL)編寫的JSP模板。控制器部分是由dispatcher servlet負責,在本教程中我們將會了解更多它的相關細節。
一些開發人員認為業務層和DAO層類是MVC模型元件的一部分。我對此持有不同的意見。我不認為業務層及DAO層類為MVC框架的一部分。通常一個web應用是3層架構,即資料-業務-表示。MVC實際上是表示層的一部分。


Dispatcher Servlet(Spring控制器)

在最簡單的Spring MVC應用程式中,控制器是唯一的你需要在Java web部署描述檔案(即web.xml檔案)中配置的Servlet。Spring MVC控制器 ——通常稱作Dispatcher Servlet,實現了前端控制器設計模式。並且每個web請求必須通過它以便它能夠管理整個請求的生命週期。

當一個web請求傳送到Spring MVC應用程式,dispatcher servlet首先接收請求。然後它組織那些在Spring web應用程式上下文配置的(例如實際請求處理控制器和檢視解析器)或者使用註解配置的元件,所有的這些都需要處理該請求。


在Spring3.0中定義一個控制器類,這個類必須標有@Controller註解。當有@Controller註解的控制器收到一個請求時,它會尋找一個合適的handler方法去處理這個請求。這就需要控制器通過一個或多個handler對映去把每個請求對映到handler方法。為了這樣做,一個控制器類的方法需要被@RequestMapping註解裝飾,使它們成為handler方法。

handler方法處理完請求後,它把控制權委託給檢視名與handler方法返回值相同的檢視。為了提供一個靈活的方法,一個handler方法的返回值並不代表一個檢視的實現而是一個邏輯檢視,即沒有任何副檔名。你可以將這些邏輯檢視對映到正確的實現,並將這些實現寫入到上下文檔案,這樣你就可以輕鬆的更改檢視層程式碼甚至不用修改請求handler類的程式碼。
為一個邏輯名稱匹配正確的檔案是檢視解析器的責任。一旦控制器類已將一個檢視名稱解析到一個檢視實現。它會根據檢視實現的設計來渲染對應物件。

Spring入門示例

在這個應用程式中,我將建立最簡單的員工管理應用程式的演示,它只有一個功能,即系統提供的所有僱員的列表。讓我們記下此應用程式的目錄結構。

現在讓我們編寫所有涉及的主要幾個檔案。

匯入程式所需的依賴jar包。如上圖所示。

web.xml

這最精簡的web.xml檔案宣告瞭一個Servlet(即dispatcher servlet)來接收所有型別的請求。Dispatcher servlet在這裡充當前端控制器的角色。

<?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"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">
    <display-name>springmvc_employee</display-name>
    <!-- The front controller of this Spring Web application, responsible for 
        handling all application requests -->
    <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:springmvc-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <!-- Map all requests to the DispatcherServlet for handling -->
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

spring-servlet.xml(你也可以用applicationContext.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: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/context http://www.springframework.org/schema/context/spring-context-4.2.xsd">

    <context:component-scan base-package="com.franson"></context:component-scan>
    <!-- configure the InternalResourceViewResolver -->
    <bean
        class="org.springframework.web.servlet.view.InternalResourceViewResolver"
        id="internalResourceViewResolver">
        <!-- 字首 -->
        <property name="prefix" value="/WEB-INF/views/" />
        <!-- 字尾 -->
        <property name="suffix" value=".jsp" />
    </bean>
</beans>

EmployeeController.java

package com.franson.controller;

import javax.annotation.Resource;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import com.franson.service.EmployeeService;

@Controller
@RequestMapping(value="employee")
public class EmployeeController {
    @Resource
    EmployeeService employeeService;
    @RequestMapping(value = "getall",method=RequestMethod.GET)
    public String getAllEmployees(Model model) {    
        model.addAttribute("employees",employeeService.getAllEmployees());
        return "employeeList";
    }
}

模型Employee.java

package com.franson.model;

public class Employee {
    private String dept;
    private int id;
    private String name;

    public String getDept() {
        return dept;
    }
    public int getId() {
        return id;
    }
    public String getName() {
        return name;
    }
    public void setDept(String dept) {
        this.dept = dept;
    }
    public void setId(int id) {
        this.id = id;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Override
    public String toString() {
        return "Employee [dept=" + dept + ", id=" + id + ", name=" + name + "]";
    }
}

IEmployeeDAO.java

這個類位於三層架構中的第三層。負責與底層的資料庫儲存進行互動。

package com.franson.dao;

import java.util.List;

import com.franson.model.Employee;

public interface IEmployeeDao {
    List<Employee> getAllEmployees();
}

EmployeeDAO.java

package com.franson.dao;

import java.util.ArrayList;
import java.util.List;

import org.springframework.stereotype.Repository;

import com.franson.model.Employee;
@Repository(value="defaultEmployeeDao")
public class EmployeeDao implements IEmployeeDao {
    @Override
    public List<Employee> getAllEmployees() {
        List<Employee> lstEmployees = new ArrayList<Employee>();
        Employee p1 = new Employee();
        p1.setId(1);
        p1.setName("Franson");
        p1.setDept("三所");
        Employee p2 = new Employee();
        p2.setId(2);
        p2.setName("Lily");
        p2.setDept("一所");
        Employee p3 = new Employee();
        p3.setId(3);
        p3.setName("Tom");
        p3.setDept("二所");
        Employee p4 = new Employee();
        p4.setId(4);
        p4.setName("Liao");
        p4.setDept("五所");
        lstEmployees.add(p1);
        lstEmployees.add(p2);
        lstEmployees.add(p3);
        lstEmployees.add(p4);
        return lstEmployees;
    }

}

IEmployeeService.java

這個類處於三層架構中的第二層。負責與DAO層互動。

package com.franson.service;

import java.util.List;

import com.franson.model.Employee;

public interface IEmployeeService {
List<Employee> getAllEmployees();
}

具體實現類如下:

package com.franson.service;

import java.util.List;

import javax.annotation.Resource;

import org.springframework.stereotype.Service;

import com.franson.dao.IEmployeeDao;
import com.franson.model.Employee;

@Service
public class EmployeeService implements IEmployeeService {
    @Resource(name = "defaultEmployeeDao")
    IEmployeeDao employeeDao;

    @Override
    public List<Employee> getAllEmployees() {
        return employeeDao.getAllEmployees();
    }

}

employeesList.jsp(結合bootstrap使用)

<%@ page language="java" contentType="text/html; charset=UTF-8"
    import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>員工表</title>
<!-- Bootstrap -->
<link rel="stylesheet"
    href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
</head>
<body>
    <div class="container">
        <div class="row">

            <table class="table table-striped">
                <tr>
                    <th>ID</th>
                    <th>使用者名稱</th>
                    <th>所在部門</th>
                </tr>
                <c:forEach items="${employees}" var="employ">
                    <tr>
                        <td>${employ.id}</td>
                        <td>${employ.name}</td>
                        <td>${employ.dept}</td>
                    </tr>
                </c:forEach>
            </table>
        </div>
    </div>
    <script src="//cdn.bootcss.com/jquery/1.11.3/jquery.min.js" />
    <script
        src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" />
</body>
</html>

部署於tomcat6容器中,在瀏覽器中輸入地址:http://localhost:8080/springmvc_employee/mvcemployee/all

可看到如下圖所示的結果:

相關文章