springMVC入门实例

Akiler

已于 2023-08-29 10:03:48 修改

阅读量449

点赞数 4

于 2022-06-19 08:30:52 首次发布

本文链接：https://blog.csdn.net/Akiler/article/details/125310946

版权

spring mvc 专栏收录该内容

10 篇文章 1 订阅

订阅专栏

对于Spring MVC而言，其最大的特色是结构松散，比如几乎可以在Spring MVC中使用各类视图，包括json、jsp、xml、pdf等，所以它能够满足手机端、PC页面端和平板及物联网等各类请求。Spring MVC的核心在于其流程，这是使用Spring MVC的基础，Spring MVC是一种基于servlet的技术，它提供了核心控制器DispatcherServlet和相关的组件，并制定了松散的结构，以适合各种灵活的需要。下图让大家对Spring MVC有个简单的认识。

Spring MVC框架是围绕DispatcherServlet而工作的，所以这个类是其最为重要的类。他是一个Servlet，可以拦截http发送过来的请求，在Servlet初始化时，Spring MVC会根据配置，获取配置信息，从而得到统一资源标识符和处理器之间的映射关系，为了更加灵活和增强功能，Spring MVC还会给处理器加入拦截器，所以还可以在处理器执行前后加入自己的代码。这样就构成一个处理器的执行链，并且根据上下文初始化视图解析器等内容，当处理器返回的时候就可以通过视图解析器定位视图，然后将数据模型渲染到视图中，用来响应用户的请求。

当一个请求到来时，DispatcherServlet首先通过请求和事先解析好的HandlerMapping配置，找到相应的Handler（处理器），这样就准备开始运行处理器和拦截器组成的执行链，而运行处理器需要一个对应的环境，这样它就有了一个处理器的适配器HandlerAdapter，通过这个适配器就能运行对应的处理器和拦截器，这里的处理器包含了控制器的内容和其他增强功能，在处理器返回模型和视图给DispatcherServlet后，DispatcherServlet就会把对应的视图信息传递给视图解析器。

Spring MVC环境搭建

首先添加相关依赖

plugins {
    id 'war'
    id 'java'
}

group 'edu.uestc.avatar'
version '1.0-SNAPSHOT'
sourceCompatibility = 17

repositories {
    mavenLocal()//添加本地仓库
    //私有仓库，阿里云镜像
    maven { url 'https://maven.aliyun.com/repository/central' } 
    mavenCentral()
}

dependencies {
    implementation 'org.springframework:spring-webmvc:5.3.20'
    implementation 'org.springframework:spring-test:5.3.20'
    compileOnly 'javax.servlet:javax.servlet-api:4.0.1'
    compileOnly 'javax.servlet.jsp:javax.servlet.jsp-api:2.3.3'

    testImplementation 'junit:junit:4.11'
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}

test {
    useJUnitPlatform()
}
//构建的字符编码
tasks.withType(JavaCompile){
    options.encoding = 'UTF-8'
}

在Spring MVC官方文档上可以看到两个容器有父子的关系，SpringMVC中两个WebApplicationContext的继承关系。RootContext会被注入到ServletContext的parentBeanFactory中。SpringMVC的容器ServletContext中如果没有bean，则委派RootContext中去查找，也就是SevletContext中可以访问RootContext中的bean，反过来则不行。

通常情况下我们会在web.xml中进行这样配置：

<?xml version="1.0" encoding="UTF-8"?>  
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"  
    version="4.0">  
      
    <!-- 配置ContextLoaderListener用于初始化Spring IoC容器（root WebApplicationContext） -->  
    <listener>  
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
    </listener>  
    <!-- 配置sping IoC配置文件路径 -->  
    <context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>classpath:spring-root.xml</param-value>  
    </context-param>  
      
    <!-- 配置DispatcherServlet -->  
    <servlet>  
        <servlet-name>dispatcherServlet</servlet-name>  
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
        <!--如果没有指定加载文件，会从/WEB-INF/下去加载以 servlet-name，即dispatcherServlet的xml文件-->  
        <init-param>  
            <param-name>contextConfigLocation</param-name>  
            <param-value>classpath:spring-mvc.xml</param-value>  
        </init-param>  
        <load-on-startup>1</load-on-startup>  
    </servlet>  
  
    <servlet-mapping>  
        <servlet-name>dispatcherServlet</servlet-name>  
        <url-pattern>*.do</url-pattern>  
    </servlet-mapping>  
</web-app>

讨论一下这个文件的配置内容：

系统变量contextConfigLocation的配置，它会告诉SpringMVC其Spring IoC的配置文件在哪里，这样spring就会找到这些配置文件去加载它们。如果是多个配置文件，可以使用逗号将它们分割开来，并且它还支持正则式匹配，进行模糊匹配，这样就更加灵活了，其默认值为：/WEB-INF/applicationContext.xml.
ContextLoaderListener实现了接口ServletContextListener，在web工程初始化之前先完成对Spring IoC容器的初始化，也可以在web工程关闭时完成spring IoC容器的资源进行释放
配置DispatcherServlet，并且配置了在服务器启动期间的时候就对其进行初始化
配置DispatcherServlet拦截以后缀'do'结尾的请求，这样所有以后缀'do'结尾的请求都会被它拦截。

配置spring-root.xml(对应Root WebApplicaitonContext容器)

<?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
       https://www.springframework.org/schema/context/spring-context.xsd">
   
    <context:component-scan base-package="edu.uestc.avatar">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

</beans>

配置组件自动扫描，对以@Controller标注的组件进行排除（Root WebApplicaitonContext通常包含基础架构bean）

配置spring-mvc.xml，是与Spring MVC配置相关的内容

<?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"
       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
       https://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <context:component-scan base-package="edu.uestc.avatar">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
    </context:component-scan>

    <!--
        以注解驱动spring mvc
        内部已经包含针对注解的HandlerMapping和HandlerAdapter
     -->
    <mvc:annotation-driven/>

    <!-- 配置视图解析器:jstl + el解析jsp视图 -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 逻辑视图名的前缀 -->
        <property name="prefix" value="/WEB-INF/pages/"/>
        <!-- 逻辑视图名的后缀 -->
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

这里的配置也比较简单：

<mvc:annotation-driven/>表示使用注解驱动spring mvc
定义一个扫描包，用它来扫描加载对应的控制器
定义视图解析器，解析器中定义了前缀和后缀，这样视图就知道去web工程的/WEB-INF/pages文件夹中找到对应的jsp文件作为视图的响应用户请求。

控制器配置了注解驱动，并且定义了扫描的包，让我们开发一个简单的Controller，如下：

package edu.uestc.avatar.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class WelcomeController {
    /**
     * 处理器
     * @return 模型和视图
     * @RequestMapping: url(/mvc/index.do)和处理器映射
     */
    @RequestMapping("/mvc/index.do")
    public ModelAndView index(){
        //模型（共享数据,作用域范围为request）和视图
        ModelAndView mv = new ModelAndView();
        mv.addObject("message","hello spring mvc");//request.setAttribute("message","hello spring mvc");
        //绑定逻辑视图（默认是forward),指定了逻辑视图名，DispatcherServlet选择视图解析器解析视图，根据逻辑视图名找到view进行渲染
        mv.setViewName("index");//request.getRequestDispatcher(prefix + viewName + suffix).forward(request,response); //WEB-INF/pages/index.jsp
        //返回给DispatcherServlet
        return mv;
    }
}

首先注解@Controller是一个控制器，Spring MVC扫描的时候就会把它作为控制器加载进来。然后@RequestMapping("/mvc/index.do")指定了对应的请求的URI，Spring MVC在初始化的时候就会将这些信息解析，存放起来，于是便有了HandlerMapping。当发生请求时，springmvc就会去使用这些信息去找到对应的控制器提供服务。

方法定义返回ModelAndView，在方法中，视图名称为index，从配置的视图解析器中会寻找/WEB-INF/pages/index.jsp作为最后的响应。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>spring mvc 入门</title>
  </head>
  <body>
      ${message}
  </body>
</html>

附：

spring的启动过程：

ServletContext:首先说说ServletContext这个web应用级的上下文。web容器（比如tomcat、jboss、weblogic等）启动的时候，它会为每个web应用程序创建一个ServletContext对象它代表当前web应用的上下文（注意：是每个web应用有且仅创建一个ServletContext，一个web应用，就是你一个web工程）。一个web中的所有servlet共享一个ServletContext对象，所以可以通过ServletContext对象来实现Servlet之间的通讯。在一个继承自HttpServlet对象的类中，可以通过this.getServletContext来获取。
ApplicationContext:接下来说说在web应用中spring的上下文。在web程序中使用spring的时候，我们需要配置

<listener>  　
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
</listener>  　　
在web容器启动时，会触发容器初始化事件，此时ContextLoaderListener会监听到这个事件，其contextInitialized方法会被调用，在这个方法中，spring会初始化一个启动上下文，这个上下文被称为根上下文，即WebApplicationContext，这是一个接口（这个接口继承ApplicationContext这个接口），确切的说，其实际的实现类是XmlWebApplicationContext。这个就是Spring的IoC容器，其对应的Bean定义的配置由web.xml中的context-param标签指定。在这个IoC容器初始化完毕后，Spring以WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE为属性Key，将其存储到ServletContext中，便于获取。
    3. 再次，contextLoaderListener监听器初始化完毕后，开始初始化web.xml中配置的Servlet，这个servlet可以配置多个，以最常见的DispatcherServlet为例，这个servlet实际上是一个标准的前端控制器，用以转发、匹配、处理每个servlet请求。DispatcherServlet上下文在初始化的时候会建立自己的IoC上下文，用以持有spring mvc相关的bean。在建立DispatcherServlet自己的IoC上下文时，会利用WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE先从ServletContext中获取之前的根上下文(即WebApplicationContext)作为自己上下文的parent上下文（有个parent属性作为对Spring的ApplicationContext的引用）。有了这个parent上下文之后，再初始化自己持有的上下文。这个DispatcherServlet初始化自己上下文的工作在其initStrategies方法中可以看到，大概的工作就是初始化处理器映射、视图解析等。这个servlet自己持有的上下文默认实现类也是xmlWebApplicationContext。初始化完毕后，spring以与servlet的名字相关(此处不是简单的以servlet名为Key，而是通过一些转换，具体可自行查看源码)的属性为属性Key，也将其存到ServletContext中，以便后续使用。这样每个servlet就持有自己的上下文，即拥有自己独立的bean空间，同时各个servlet共享相同的bean，即根上下文(第2步中初始化的上下文)定义的那些bean。