使用Eclipse创建SpringMVC项目

ゝ一纸荒年。 2022-11-27 00:41 236阅读 0赞

演示通过Eclipse创建SpringMVC工程的基本过程并编写一个最简单的SpringMVC项目。

### 1. 创建一个Web项目 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjM0MDE1_size_16_color_FFFFFF_t_70_pic_center]

填写项目名称之后一路点击Next，然后勾选创建 web.xml。最后点Finish，完成工程的创建。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjM0MDE1_size_16_color_FFFFFF_t_70_pic_center 1]  
创建之后,**工程结构**如下图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjM0MDE1_size_16_color_FFFFFF_t_70_pic_center 2]

### 2. 为 Web 工程添加 SpringMVC 的相关类库 ###

将 spring-framework 中 libs 目录下的 JAR 类库复制到 Web 工程 WEB-INF/lib 目录下。复制时只需要复制XXX.RELEASE.jar 的文件。

由于 SpringMVC 依赖于 Apache Commons Logging 组件，所以还需要复制 commons-logging-1.2.jar 文件。

### 3.在 web.xml 文件中部署 DispatcherServlet ###

<?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" id="WebApp_ID" version="4.0">
 <display-name>FirstSpringMVC</display-name>
 <welcome-file-list>
 <welcome-file>index.html</welcome-file>
 <welcome-file>index.htm</welcome-file>
 <welcome-file>index.jsp</welcome-file>
 <welcome-file>default.html</welcome-file>
 <welcome-file>default.htm</welcome-file>
 <welcome-file>default.jsp</welcome-file>
 </welcome-file-list>
 
 
 <servlet>
 	<servlet-name>springmvc</servlet-name>
 	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 	<load-on-startup>1</load-on-startup>
 </servlet>
 <servlet-mapping>
 	<servlet-name>springmvc</servlet-name>
 	<url-pattern>/</url-pattern>
 </servlet-mapping>
 </web-app>

上述 DispatcherServlet 的 servlet 对象初始化的时候，将在工程的 WEB-INF 目录下查找一个配置文件，这个配置文件的命名规则是“servletName-servlet.xml”，如上面的配置中使用的是**springmvc**，那么配置文件的名称应该是**springmvc-servlet.xml**。

另外，也可以将 SpringMVC 的配置文件存放到工程目录中的任何地方，不过此时需要使用 servlet 的 init-param 元素**加载配置文件**。示例代码如下：

<servlet>
 <servlet-name>springmvc</servlet-name>
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 <init-param>
 	<param-name>contextConfigLocation</param-name>
 <param-value>/WEB-INF/spring-config/springmvc-servlet.xml</param-value>
 </init-param>
 <load-on-startup>1</load-on-startup>
 </servlet>
 <servlet-mapping>
 <servlet-name>springmvc</servlet-name>
 <url-pattern>/</url-pattern>
 </servlet-mapping>

### 4. 创建 SpringMVC 的配置文件 ###

跟随上一步，在合适的位置创建 springmvc-servlet.xml 文件。在这个文件中声明与 SpringMVC 应用相关的配置。配置内容包含但是不限于以下内容：

<?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:p="http://www.springframework.org/schema/p"
 	xmlns:context="http://www,springframework.org/schema/context"
 	xmlns:mvc="http://www.springframework.org/schema/mvc"
 	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.xsd
 	http://www.springframework.org/schema/mvc
 	http://www.springframework.org/schema/spring-mvc.xsd">
 	
 
 	<bean name="/login" class="controller.LoginController" />
 	<bean name="/register" class="controller.RegisterController" />
 
 </beans>

--------------------

通过上面的步骤已经完成了 SpringMVC 项目的基本配置，可以基于上面的配置进行应用程序的开发。  
实现一个简单的，没有数据传输的页面跳转功能，虽然HTML本身就可以实现无数据传输的页面跳转，但是现在为了梳理SpringMVC的运行逻辑，将通过后台进行页面跳转。  
创建三个JSP页面，分别是首页、注册页面和登录页面。在首页通过不同的链接跳转到注册或者登录页面。  
由于只是为了演示跳转，登录和注册页面十分简单。

<%@ page language="java" contentType="text/html; charset=UTF-8"
 pageEncoding="UTF-8"%>
 <!DOCTYPE html>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>登录页面</title>
 </head>
 <body>
 这里是登录页面
 </body>
 </html>

<%@ page language="java" contentType="text/html; charset=UTF-8"
 pageEncoding="UTF-8"%>
 <!DOCTYPE html>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>注册页面</title>
 </head>
 <body>
 这里是注册页面
 </body>
 </html>

index.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
 pageEncoding="UTF-8"%>
 <!DOCTYPE html>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>首页</title>
 </head>
 <body>
 没有注册的用户请<a href="register">前往注册</a> 
 已经注册的用户请<a href="login">前往登录</a>
 </body>
 </html>

`<a>`链接的`href`属性内容并不是注册和登录页面的物理路径，而是请求名称。

--------------------

SpringMVC工作流程的第一步是：**客户端请求提交到DispatcherServlet**。这一步是通过创建工程第三步中的 web.xml 配置文件中的内容实现的。xml文件中 servlet-mapping 的 url-pattern 配置了一个`/`，表示处理所有请求。所以，通过页面链接的请求都会经过这个配置，然后指向`DispatcherServlet`。  
工作流程的第二步是：**由DispatcherServlet控制器寻找一个或者多个HandlerMapping（处理器映射器）。找到处理请求的Controller**。这一步是通过 springmvc-servlet.xml 配置文件的内容实现的。通过 name 属性对应的 class 值找到处理对应请求的 Controller，class 的内容是 Controller 类的全限定名。  
工作流程的第三步是：**DispatcherServlet将请求提交到 Controller**。Controller 接收到请求之后，将调用业务层进行逻辑业务的处理。以 LoginController 和 RegisterController 为例：

package controller;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.mvc.Controller;
 
 /**
 * @ClassName: LoginController
 * @Description: 
 * @Author: coder
 * @Date: 2020年4月15日
 */
 public class LoginController implements Controller {
 
 	/* (non-Javadoc)
 	* Title: handleRequest
 	* Description: 
 	* @param arg0
 	* @param arg1
 	* @return
 	* @throws Exception
 	* @see org.springframework.web.servlet.mvc.Controller#handleRequest(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
 	*/
 	@Override
 	public ModelAndView handleRequest(HttpServletRequest arg0, HttpServletResponse arg1) throws Exception {
 
 		// TODO Auto-generated method stub
 		return new ModelAndView("/WEB-INF/jsp/login.jsp");
 	}
 }

package controller;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.mvc.Controller;
 
 /**
 * @ClassName: RegisterController
 * @Description: 
 * @Author: coder
 * @Date: 2020年4月15日
 */
 public class RegisterController implements Controller {
 
 	/* (non-Javadoc)
 	* Title: handleRequest
 	* Description: 
 	* @param arg0
 	* @param arg1
 	* @return
 	* @throws Exception
 	* @see org.springframework.web.servlet.mvc.Controller#handleRequest(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
 	*/
 	@Override
 	public ModelAndView handleRequest(HttpServletRequest arg0, HttpServletResponse arg1) throws Exception {
 
 		// TODO Auto-generated method stub
 		return new ModelAndView("/WEB-INF/jsp/register.jsp");
 	}
 }

由于没有业务逻辑需要处理，Controller直接返回了 ModelAndView 。返回 ModelAndView 正是工作流程的第四步。工作流程的第四步是：**Controller 调用业务逻辑处理后，返回 ModelAndView**。  
工作流程的第五步是：**DispatcherServlet 寻找一个或者多个 ViewResolver（视图解析器），找到ModelAndView 对应的视图**。这一步的完成依赖于\*\*\*视图解析器\*\*\*。  
**视图解析器**可以为自动添加前缀和后缀。需要在 springmvc-servlet.xml 中进行配置。配置方法如下所示：

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
 
 <property name="prefix" value="/WEB-INF/jsp/" />
 
 <property name="suffix" value=".jsp" />
 </bean>

工作流程的第六步，也是最后一步：**视图负责将结果显示到客户端**。

--------------------

综上所述：  
使用 Eclipse 创建一个单纯的 SpringMVC 项目的时候，第一步是创建一个空的动态web项目，第二步是将 springmvc 的 jar 包复制到项目的 WEB-INF/lib 中。第三步是在 web.xml 中部署 DispatcherServlet。第四步根据第三步在合适的位置创建 xxx-servlet.xml 的配置文件，用来注册 Controller、配置视图解析器等。然后就是编写代码了。  
编码的时候，自己的 Controller 需要实现 `org.springframework.web.servlet.mvc.Controller`接口并实现其中的`handleRequest`方法。该方法的返回值类型是`ModelAndView`，方法需要两个参数，分别是`HttpServletRequest`和`HttpServletResponse`。创建了新的 Controller 之后需要在 xxx-servlet.xml 文件中注册这个 Controller，以便让这个 Controller 能被 DispatcherServlet 找到。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjM0MDE1_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/201e4afe053040dbab72c931a5e4c081.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjM0MDE1_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221124/480e1977104e423ea7e72b6d2e7b2400.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjM0MDE1_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221124/82df71d0c773445f99f7b1304ecf7477.png