1.创建maven工程

新建一个空project, 然后再根目录下新建一个空model, 构建工具为maven。 勾选添加样例代码。

a>添加web模块

在main文件夹下创建一个目录(Directory)命名为 webapp 创建完成之后还需要在webapp里加一个web.xml文件, 是WEB工程的入口配置文件, 可以注册servelt, 过滤器, 监听器。 找到File—Project Structure—Modules, 选中Web文件夹, 在Deployment Descriptors中添加web.xml, 注意修改路径。

b>打包方式:war

pom.xml 加一行

...
<version>1.0-SNAPSHOT</version>  // 在这行下加上
<packaging>war</packaging>
c>引入依赖
<dependencies>
    <!-- SpringMVC -->
    <!-- 本身不止一个依赖, 但maven会自动导入依赖的依赖 -->
    <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 -->
    <!-- scope依赖范围设置为provided表示已被提供, 不会被打包进去, 因为高版本tomcat容器自带 -->
    <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>

2. 配置web.xml

注册SpringMVC的前端控制器DispatcherServlet

a>默认配置方式

此配置作用下,SpringMVC的配置文件默认位于WEB-INF下,默认名称为<servlet-name>-servlet.xml,例如,以下配置所对应SpringMVC的配置文件位于WEB-INF下,文件名为springMVC-servlet.xml

<!-- 配置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的初始化时间

注意需要在resource文件夹内创建springMVC.xml(自定义配置文件名)

<!-- 配置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 -->
        <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>
    <url-pattern>/</url-pattern>
</servlet-mapping>

注:

<url-pattern>标签中使用/和/*的区别:

/所匹配的请求可以是/login或.html或.js或.css方式的请求路径,但是/不能匹配.jsp请求路径的请求

因此就可以避免在访问jsp页面时,该请求被DispatcherServlet处理,从而找不到相应的页面

/*则能够匹配所有请求,例如在使用过滤器时,若需要对所有请求进行过滤,就需要使用/*的写法

3、创建请求控制器

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

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

因为SpringMVC的控制器由一个POJO(普通的Java类)担任,因此需要通过@Controller注解将其标识为一个控制层组件,交给Spring的IoC容器管理,此时SpringMVC才能够识别控制器的存在 @conponet 为普通组件 @Controller 为控制层组件 @Service 为业务层组件 @Repository 为持久层组件

@Controller
public class HelloController {
    
}

接下来配置SpringMVC的一个扫描组件 进入之前创建的springMVC.xml文件中, 在beans标签中添加:(package为你HelloController所在的包名)

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

4、配置Thymeleaf视图解析器

直接在springMVC.xml文件中添加这一段即可:

<!-- 配置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>

视图要被解析器解析, 而解析时是在文件名前面加上视图前缀, 在扩展名加上视图后缀

5、测试

在 WEB-INF 中创建文件夹 tamplates 之后再创建一个 index.html 文件。

里面的html标签需加上Thymeleaf命名空间:

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

也可以直接修改idea的html模板, 这样以后创建时就会自动加上, 在 File—settings—Editor—File and Code Templates中。

a>实现对首页的访问

在请求控制器中创建处理请求的方法, 通过Controller将访问/的请求转到访问 /WEB-INF/templates/index.html上。

// @RequestMapping注解:处理请求和控制器方法之间的映射关系
// @RequestMapping注解的value属性可以通过请求地址匹配请求,/表示的当前工程的上下文路径
// localhost:8080/springMVC/
@RequestMapping("/")
public String index() {
    //设置视图名称
    return "index"; // 经过视图解析后得到为 /WEB-INF/templates/index.html
}

然后配置tomcat运行, 在绿色锤子旁边的 Edit Comfigurations(或者在Run里面), 添加tomcat/local, 然后进入Deployment界面, 添加一个Artifacts, 如果没有则需要检查一下pom的打包方式, 是否为war包。IDEA中通常选择exploded。 然后回到Server界面, 调整以下两个选项:

启动tomcat之后第二次点击启动tomcat时所做的事情
On 'update' action: Redeploy
 
当IDEA失去焦点之后所做的事情
On frame deacticvation: Update classes and resources

若出现java: 错误: 不支持发行版本 5问题则需要进入Settings—Build, Execution, Deployment—Compiler—Java Compiler中, 可以发现对应Module中的版本被设置为1.5, 改成你project中的版本即可。

若启动后出现 Failed to read candidate component class 问题, 则可能是你spring版本不支持太高的JDK, 比如

Spring Framework 5.3.x 是发布的第五个大版本,也是最新的正式发布版本(发布于 2020 年 10 月),并将在 JDK 8、JDK 11、JDK 17 上提供长期支持。

就无法在JDK 18中运行, 更改JDK则参考上一个问题。

b>通过超链接跳转到指定页面
<a href="/target">访问target.html</a>

对于/永远都代表绝对路径, 这里则是hostlocal:8080, 显然不能访问到与index.html同级的 target.html, 可以通过添加上下文路径来解决, 即修改为 "/springMVC/target" 这了的springMVC就是在tomact中设置的Application context:。 但这样会导致修改一次tomcat中得修改所有的, 很不优雅, 可以使用Thymeleaf来解决, 首先得确保html加入Thymeleaf的命名空间, 之后替换为:

<a th:href="@{/target}">访问target.html</a>

当检测到中括号中为绝对路径时, 会自动加上上下文路径。

之后在tamplates目录下添加target.html文件。

然后在Controller中添加处理/target请求的方法即可:

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

6、总结

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