Spring MVC 完整示例

Posted 2020-07-28 Franson

在本例中，我们将使用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

可看到如下图所示的结果：