springmvc整理

本文详细介绍如何从零开始搭建SpringMVC项目,包括使用Idea创建Maven工程,配置pom.xml依赖,设置web.xml和springmvc.xml,以及编写HelloWorld示例代码。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

前言

日常开发中经常使用springmvc,但每次项目基本只配置过一次,或者复制粘贴,对于从零搭建springmvc,其中的原理流程模糊不清,所以在这里做个梳理,日后回顾也很方便。

入门demo

创建项目

使用Idea工具,新建maven工程,选择maven模板webapp模板,写好工程名,一直下一步到finish。

导入pom依赖

工程初始化完毕后,打开pom.xml,导入需要的依赖如下:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.ming</groupId>
  <artifactId>springmvc-helloworld</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>springmvc-helloworld Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <spring.version>5.0.2.RELEASE</spring.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>2.5</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>jsp-api</artifactId>
      <version>2.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>springmvc-helloworld</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

配置web.xml

springmvc是基于Servlet实现的,大概原理就是所有的请求都会进入DispatcherServlet的service方法,然后根据请求路径分配给不同的Controller来做处理。

所以需要在web.xml中配置DispatcherServlet,配置所有的请求路径都要访问它。同时,在程序启动的时候要加载springmvc.xml的配置文件。该配置文件是关于springmvc的一些配置。web.xml配置如下:

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--    启动程序后加载springmvc.xml配置文件-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
<!--  配置过滤路径,所有请求都会被dispatcherServlet拦截-->
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

配置springmvc.xml

在这里需要配置些什么呢?

学过spring我们知道,当我们注解了一些元件后,需要让程序知道去哪扫描这些注解。所以需要在该配置文件中说明扫描的具体包。在XML中配置了这个标签后,spring可以自动扫描base-package下面或者子包下面的java文件,如果扫描有@Component @Service @Controller等这些注解的类,则把这些类注册为bean

<context:component-scan base-package="com.ming.controller"/>

springmvc很重要的一个类视图解析器也需要配置一下,配置去哪个文件夹下找视图,视图的后缀名有哪些。 

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

前边说过,所有请求都会被DispatcherServlet拦截,但js\css\image等静态资源是不需要拦截的,那么我们也需要配置一下:

    <mvc:resources mapping="/css/**" location="/css/"/>
    <mvc:resources mapping="/images/**" location="/images/"/>
    <mvc:resources mapping="/js/**" location="/js/"/>

 整体的配置文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="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
		http://www.springframework.org/schema/context
		http://www.springframework.org/schema/context/spring-context.xsd">
<!--    配置哪些路径下需要扫描-->
    <context:component-scan base-package="com.ming.controller"/>
<!--    配置试图解析器,以及去哪个路径下解析-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
    <!-- 配置哪些静态资源不会被dispatcherServlet拦截-->
    <mvc:resources mapping="/css/**" location="/css/"/>
    <mvc:resources mapping="/images/**" location="/images/"/>
    <mvc:resources mapping="/js/**" location="/js/"/>
<!--    默认会帮我们注册默认处理请求,参数和返回值的类,其中最主要的两个类:DefaultAnnotationHandlerMapping 和 AnnotationMethodHandlerAdapter ,分别为HandlerMapping的实现类和HandlerAdapter的实现类,-->
    <mvc:annotation-driven/>
</beans>

 HelloWorld代码

在我们创建的模板中,已经自动创建了webapp文件夹以及index.jsp页面,该页面就是程序启动后默认的首页。所以修改首页内容如下:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>hello world</title>
    <a href="hello/sayHelloworld">点击</a>
</head>
<body>

</body>
</html>

我们要实现的功能就是首页打开后,点击首页的链接,能够执行链接对应controller的方法,并跳转到方法返回的视图view页面。

我们看到首页链接中,指明路径hello/sayHelloworld,那么我们就分别创建HelloController以及该controller内部的sayHelloworld方法。如下:

package com.ming.controller;

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

@Controller
@RequestMapping("/hello")
public class HelloController {

    @RequestMapping(path="/sayHelloworld")
    public String sayHelloworld(){
        System.out.println("hello world!");
        return "success";
    }
}

我们可以看到 RequestMapping括号中代表链接路径的名字。方法名和controller的名字可以随便起。

在sayHelloworld方法中,最后返回success视图,springmvc会通过视图解析器,去配置文件中配置的文件夹下找success名字后缀为jsp的页面。并返回给请求者。

那么我们就在webapp文件夹下新建pages/success.jsp页面。页面内容随便写了。

以上基本就完成了,最后点击右上角的Edit Configuration,配置tomcatServer。启动程序即可。 

这里要注意@Controller注解与@RestController注解的区别。参见https://www.jdon.com/50892 。

就是说当我们做api开发时,@RestController是首选。如果是开发spirngmvc前后端不分离需要用到modelandview返回具体页面的情况就使用@Controller注解。

原理分析

通过上边的demo,我们把流程梳理一遍。spirngmvc内部是怎么执行的呢?

1、  用户发送请求,因为我们配置了所有请求都要经过DispatcherServlet。

2、  DispatcherServlet收到请求调用HandlerMapping处理器映射器。

3、  处理器映射器找到具体的处理器HelloController(可以根据xml配置、注解进行查找),生成处理器对象及处理器拦截器(如果有则生成)一并返回给DispatcherServlet。

4、  DispatcherServlet调用HandlerAdapter处理器适配器。

5、  HandlerAdapter经过适配调用具体的处理器(HelloController)。

6、  HelloController对应方法执行完成返回ModelAndView。

7、  HandlerAdapter将HelloController执行结果ModelAndView返回给DispatcherServlet。

8、  DispatcherServlet将ModelAndView传给ViewReslover视图解析器。

9、  ViewReslover解析(success)后返回具体View(success.jsp)。

10、DispatcherServlet根据View进行渲染视图(即将模型数据填充至视图中)。

11、 DispatcherServlet响应给用户。

到此整个流程就走完了。

参考代码:DispatcherServlet中的doService方法,以及内部的doDispatch(request, response)方法;

使用Servlet的Api

上边说过,springmvc就是用servlet实现的,所以servlet的api它都可以用。

API对象的说明

    这一部分包含了对Java Servlet API的全部类和接口的详细说明。这个说明与Javadoc API差不多,但是这份文档提供了更多的信息。

API包含了两个软件包,十二个接口和九个类。

软件包:javax.servlet

   所包含的接口:RequestDispatcher;Servlet;ServletConfig;ServletContext;ServletRequest;ServletResponse;SingleThreadModel。

   所包含的类:GenericServlet;ServletInputStream;ServletOutputStream;ServletException;UnavailableException。

软件包:javax.servlet.http

       所包含的接口:HttpServletRequest;HttpServletResponse;HttpSession;HttpSessionBindingListener;HttpSessionContext。

       所包含的类:Cookie;HttpServlet;HttpSessionBindingEvent;HttpUtils。

软件包:javax.servlet

所包含的接口:RequestDispatcher;Servlet;ServletConfig;ServletContext;ServletRequest;ServletResponse;SingleThreadModel。

所包含的类:GenericServlet;ServletInputStream;ServletOutputStream;ServletException;UnavailableException。

结语

springmvc还需要了解常用注解以及返回值类型等这里就不在介绍了。 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值