SpringMVC - 01 - Maven工程入门案例

来一瓶82年的拉菲就好

已于 2023-02-21 21:26:29 修改

阅读量164

点赞数

分类专栏： SpringMCV 文章标签： maven spring java

于 2023-02-19 23:38:59 首次发布

本文链接：https://blog.csdn.net/qq_39413850/article/details/129114737

版权

SpringMCV 专栏收录该内容

14 篇文章 1 订阅

订阅专栏

文章目录

项目结构：在这里插入图片描述

1.新建一个工程

在这里插入图片描述

2.在pom.xml文件中配置打包方式为war包

Maven工程有三种打包方式，默认打包方式为jar包，如果要将当前工程转化为web工程，需要将打包方式修改为war包并添加web模块（即webapp）

在这里插入图片描述

3.在pom.xml中添加依赖

<dependencies>
    <!-- SpringMVC -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.1</version>
    </dependency>

    <!-- 日志 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>

    <!-- ServletAPI -->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>

    <!-- Spring5和Thymeleaf整合包 -->
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
        <version>3.0.12.RELEASE</version>
    </dependency>
</dependencies>

备注1：ServletAPI这个依赖的依赖范围是provided，“已被提供”，即当前服务器中已经提供了这个jar包，当把这个web工程打包成war包之后，这个jar包不会存在于当前war包的webapp/WEB-INF/lib中，它由服务器提供。
备注2：Thymeleaf通过视图技术控制页面中所显示的内容，如果需要被其解析，需要通过“th:”来控制某个属性或者所显示的文本

4.在当前Maven工程中添加web模块

在这里插入图片描述

5. 查看项目结构

所创建的web模块需要web.xml，它是web工程的入口配置文件，配置文件中可以注册servlet、过滤器、监听器等。
SpringMVC注解版的配置方式可以通过配置类的方式代替web.xml，甚至可以代替SpringMCV的配置文件，以及Spring的配置文件。

在这里插入图片描述

需要注意，web.xml放入的路径需要核对是否正确：

6. 配置web.xml

SpringMCV基于原生的Servlet，提供了封装处理请求过程的前端控制器DispatcherServlet，所以项目中的请求没有必要被自己创建的Servlet处理，统一由前端控制器进行处理。

为什么要配置web.xml？
答：浏览器所发送的请求需要交给前端控制器DispatcherServlet进行处理，前端控制器是一个Servlet，要想通过Servlet处理请求，必须在web.xml中进行注册。

为什么要进行注册呢？
答：由于浏览器不能直接访问项目中的类，所以如果要访问到Servlet，需要设置一个匹配路径，每当访问路径符合当前所设置的匹配路径，当前的请求就会被Servlet处理。

注册SpringMVC的前端控制器DispatcherServlet，有两种配置方式，一般用第二种：

a>默认配置方式
此配置作用下，SpringMVC的配置文件默认位于WEB-INF下，默认名称为<servlet-name>-servlet.xml，例如，以下配置所对应SpringMVC的配置文件位于WEB-INF下，文件名为springMVC-servlet.xml。主要Maven工程中配置文件统一要放在resource目录下，需要使用第二种配置方式。

<!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
<servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <!--
        设置springMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求
    -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

需要注意：在这里插入图片描述

b>扩展配置方式(一般用这种方式)

可通过init-param标签自定义SpringMVC配置文件的位置和名称，通过load-on-startup标签设置SpringMVC前端控制器DispatcherServlet的初始化时间

<!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
<servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 通过初始化参数指定SpringMVC配置文件的位置和名称 -->
    <init-param>
        <!-- contextConfigLocation为固定值（上下文配置路径） -->
        <param-name>contextConfigLocation</param-name>
        <!-- 使用classpath:表示从类路径查找配置文件，例如maven工程中的src/main/resources，
        如果下面所写的springMCV.xml报错，是因为还没有在resource下创建这个配置文件 -->
        <param-value>classpath:springMVC.xml</param-value>
    </init-param>
    <!-- 
 		作为框架的核心组件，在启动过程中有大量的初始化操作要做
		而这些操作放在第一次请求时才执行会严重影响访问速度
		因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时
	-->
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <!--
        设置springMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求
    -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

注：<url-pattern>标签中使用/和/*的区别：
/所匹配的请求可以是/login或.html或.js或.css方式的请求路径，但是/不能匹配.jsp请求路径的请求因此就可以避免在访问jsp页面时，该请求被DispatcherServlet处理，从而找不到相应的页面
/*则能够匹配所有请求，例如在使用过滤器时，若需要对所有请求进行过滤，就需要使用/*的写法

7. 在resource下创建名为springMCV的配置文件

在这里插入图片描述

8. 创建请求控制器

由于前端控制器对浏览器发送的请求进行了统一的处理，但是具体的请求有不同的处理过程，因此需要创建处理具体请求的类，即请求控制器

请求控制器中每一个处理请求的方法成为控制器方法

因为SpringMVC的控制器由一个POJO（普通的Java类）担任，因此需要通过@Controller注解将其标识为一个控制层组件，交给Spring的IoC容器管理，此时SpringMVC才能够识别控制器的存在
在这里插入图片描述

package com.rqs.mvc.controller;

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

@Controller //通过注解+扫描（扫描需要在其他地方进行操作）的方式 将这个类作为Spring IOC里的一个组件 使其变为控制器，这里已经进行了注解，后续第10步中进行了扫描
public class HelloController {
}

9.创建首页

在WEB-INF下创建templates目录，在该目录下创建index.html，后续跳转到该页面
在这里插入图片描述
另外，为了便于使用thymeleaf，可以在如下设置中为html文件设置模板，将xmlns:th="http://www.thymeleaf.org"写入模板

index.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">

<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
<h1>首页</h1>
</body>
</html>

10.创建springMVC的配置文件（已在7中创建）

在这里插入图片描述

每当需要进行页面跳转，如果视图名称符合条件，就会被视图解析器所解析，找到相应页面进行跳转
例如，想要跳转到index.html，不能直接跳转，因为WEB-INF下的内容，浏览器不能直接访问，重定向也不能直接访问，只能通过转发来进行访问。就算是放到webapp下也不能直接访问，因为使用了thymeleaf，页面中可能有thymeleaf语法，需要被thymeleaf解析，必须通过当前所配置的视图解析器来解析当前的视图，而当前所配置的视图解析器提供了视图前缀和视图后缀，所以最终的视图名称就是index，而不是/WEB-INF/templates/index.html

<?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="com.rqs.mvc.controller"></context:component-scan>

    <!-- 配置Thymeleaf视图解析器  -->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/><!--视图解析器可以配置多个 可设置优先级-->
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!-- 视图前缀 -->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!-- 视图后缀 -->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8" />
                    </bean>
                </property>
            </bean>
        </property>
    </bean>


</beans>

11.配置tomcat

在这里插入图片描述

11.测试HelloWorld

a>实现对首页的访问

在请求控制器中创建处理请求的方法

package com.rqs.mvc.controller;

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

@Controller //通过注解+扫描（扫描需要在其他地方进行操作）的方式 将这个类作为Spring IOC里的一个组件 使其变为控制器
public class HelloController {
    //视图前缀  "/WEB-INF/templates/"
    //视图后缀  ".html"
    /* “/”指的是上下文路径，   -->  /WEB-INF/templates/index.html  */
    /*
    *     // index()方法对应的请求映射注解的value值是上下文路径，也就是说通过
    * 上下文路径访问的是解析后的视图前缀+视图名称+视图后缀，
    * 即/WEB-INF/templates/index.html，即访问的是首页，如果改成target，
    * 则访问的是 /WEB-INF/templates/target.html
    */
    // @RequestMapping注解：处理请求和控制器方法之间的映射关系
    // @RequestMapping注解的value属性可以通过请求地址匹配请求，/表示的当前工程的上下文路径
    // localhost:8080/springMVC/
    @RequestMapping(value = "/")
    public String index() {
        //返回视图名称  【通过视图前缀+视图名称+视图后缀进行解析】
        return "index";
    }

    @RequestMapping("/hello")
    public String HelloWorld() {
        return "target";
    }
}

b>通过超链接跳转到指定页面

新建target.html页面

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>目标页面</h1>
</body>
</html>

在主页index.html中设置超链接

超链接中的路径有浏览器解析，以“/”开头的路径是绝对路径，代表localhost：8080，不包含上下文路径，即“/”不代表“http://localhost:8080/springMCV/”，虽然上下文路径可以直接加，但是上下文路径如果修改，页面中的代码也要跟着修改，所以不方便写死。注意到，/hello在thymeleaf中，如果发现@{/hello}中使用的是绝对路径的时候，会自动添加上下文路径，问题便得到了解决。

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
<h1>首页</h1>
<a th:href="@{/hello}">点击跳转到目标页面</a><br/>
</body>
</html>

在请求控制器中创建处理请求的方法

/hello 与页面中请求的地址保持一致

@RequestMapping("/hello")
public String HelloWorld() {
    return "target";
}

总结

浏览器发送请求，若请求地址符合前端控制器的url-pattern，该请求就会被前端控制器DispatcherServlet处理。前端控制器会读取SpringMVC的核心配置文件，通过扫描组件找到控制器，将请求地址和控制器中@RequestMapping注解的value属性值进行匹配，若匹配成功，该注解所标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称，该视图名称会被视图解析器解析，加上前缀和后缀组成视图的路径，通过Thymeleaf对视图进行渲染，最终转发到视图所对应页面

从浏览器发送的请求，会被@RequestMapping注解进行匹配，如果匹配成功，该注解所标识的控制器方法就会处理请求，在之前必须在web.xml中注册前端控制器，浏览器发送过来的请求都要被前端控制器处理，之后又执行了相对应的控制器方法。请求和@RequestMapping匹配，再找到控制器方法的过程，由前端控制器DispatcherServlet完成。DispatcherServlet封装了很多数据，当调用控制器方法的时候，会根据控制器方法的参数，为当前方法注入参数。
上面一段话的总结：发送的请求被前端控制器DispatcherServlet拦截，解析其中包含的参数内容，封装进DispatcherServlet中，DispatcherServlet再去匹配对应的方法，根据控制器方法的参数为当前方法注入参数。
在这里插入图片描述