1 SpringMVC 案例 (新)

相较于旧版使用 JSP 来创建视图,现在更换为 Thymeleaf 来创建视图。

1.1 创建 Maven 工程

首先创建一个 webapp 模块的 Maven 项目,如下:maven-archetype-webapp,打包方式:war。

300

相关依赖:

<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.2 配置 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">
 
	<!-- 配置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>
	    <!--
	        设置springMVC的核心控制器所能处理的请求的请求路径
	        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
	        但是/不能匹配.jsp请求路径的请求
	    -->
	    <url-pattern>/</url-pattern>
	</servlet-mapping>
</web-app>
  • contextConfigLocationDispatcherServlet 继承自 FrameworkServlet,该类有个 contextConfigLocation 属性,代表 Spring MVC 配置文件位置。默认的配置文件为: /WEB-INF/<servlet-name>-servlet.xml,那么 SpringMVC 会自动去 WEB-INF 下面找一个叫 [servlet名字\]-servlet.xml 的文件,不推荐使用这种方式。因此,一般直接初始化设定配置文件位置。
  • load-on-startup:当值为 0 或者大于 0 时,表示容器在应用启动时就加载这个 servlet;当是一个负数时或者没有指定时,则指示容器在该 servlet 被调用时才加载。正数的值越小,启动该 servlet 的优先级越高。当值相同时,容器会自己选择创建顺序。
  • url-pattern:表示拦截哪些请求, “/” 表示拦截所有请求。也可以如“.扩展名”表示拦截所有以扩展名结尾的请求。例如”. Do”
  • 注:

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

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

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

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

1.3 编写 Spring/SpringMVC 配置文件

使用 SpringBoot 后,对于 Thymeleaf 视图就不需要配置那么多了:

#前缀 视图文件存放位置
spring.thymeleaf.prefix=classpath:/templates/
#后缀 视图文件扩展名
spring.thymeleaf.suffix=.html
<!-- 自动扫描包 -->
<context:component-scan base-package="com.atguigu.mvc.controller"/>
 
<!-- 配置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>
 
<!--
   处理静态资源,例如html、js、css、jpg
  若只设置该标签,则只能访问静态资源,其他请求则无法访问
  此时必须设置<mvc:annotation-driven/>解决问题
 -->
<mvc:default-servlet-handler/>
 
<!-- 开启mvc注解驱动 -->
<mvc:annotation-driven>
    <mvc:message-converters>
        <!-- 处理响应中文内容乱码 -->
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="defaultCharset" value="UTF-8" />
            <property name="supportedMediaTypes">
                <list>
                    <value>text/html</value>
                    <value>application/json</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

1.4 创建控制器 + 补充相应方法

@Controller
public class HelloController {
    @RequestMapping("/")
	public String index() {
	    //设置视图名称
	    return "index";
	}
 
	@RequestMapping("/hello")
	public String HelloWorld() {
	    return "target";
	}
}

1.5 编写视图页面

<!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}">HelloWorld</a><br />
  </body>
</html>

配置 HTML 模板内容,将上述的 xmlns:th="http://www.thymeleaf.org" 加入到模板中,避免忘记。

700

1.6 配置 Tomcat 服务器

点击顶部工具栏里的 Edit Configurations,或者点击 Run Edit Configurations.

SpringMVC-1 SpringMVC 的第一个案例-2.png

SpringMVC-1 SpringMVC 的第一个案例-3.png

配置下面的路径:

SpringMVC-1 SpringMVC 的第一个案例-4.png

继续配置 Server:

SpringMVC-1 SpringMVC 的第一个案例-5.png

2 SpringMVC 案例 (旧)

2.1 创建一个 maven 工程

首先创建一个 webapp 模块的 Maven 项目,如下:maven-archetype-webapp

创建后项目的整体目录如下:

image

maven 依赖

<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.2.7.RELEASE</spring.version>
</properties>
<dependencies>
    <!--Spring相关依赖-->
    <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>
    <!--Servlet相关依赖-->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>
    <!--jsp相关依赖-->
    <dependency>
        <groupId>javax.servlet.jsp</groupId>
        <artifactId>jsp-api</artifactId>
        <version>2.0</version>
        <scope>provided</scope>
    </dependency>
	<!-- Spring5和Thymeleaf整合包 -->
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
        <version>3.0.12.RELEASE</version>
    </dependency>
    <!--单元测试的依赖-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.11</version>
        <scope>test</scope>
    </dependency>
</dependencies>
 

2.2 在 web.xml 中配置 DispatcherServlet(中央调度器)

  1. DispatcherServlet 叫做中央调度器,是一个 servlet,它的父类是继承 HttpServlet
  2. DispatcherServlet 页叫做前端控制器(front controller)
  3. DispatcherServlet 负责接收用户提交的请求,调用其它的控制器对象,并把请求的处理结果显示给用户
<?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">
 
    <!-- 配置编码过滤器,防止乱码 -->
    <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <!--支持异步处理-->
        <async-supported>true</async-supported>
        <!-- 配置encoding,告诉指定的编码格式,这里设置为UTF-8 -->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <!-- 解决请求乱码 -->
        <init-param>
            <param-name>forceRequestEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
        <!-- 解决响应乱码 -->
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
 
    <!-- 配置SpringMVC中央调度器 -->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 配置DispatcherServlet的初始化参数:读取springmvc.xml -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
        <!-- servlet启动时加载 -->
        <load-on-startup>1</load-on-startup>
        <!--支持异步处理-->
        <async-supported>true</async-supported>
    </servlet>
 
    <servlet-mapping>
		<!--将不同的url匹配到不同的servlet执行-->
        <servlet-name>springmvc</servlet-name>
        <!--
        /* 匹配所有资源(永远不要这样写)
        /  匹配所有请求(推荐)
        *.扩展名  匹配所有请求(推荐),例如*.do
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>
 
 
  • contextConfigLocationDispatcherServlet 继承自 FrameworkServlet,该类有个 contextConfigLocation 属性,代表 Spring MVC 配置文件位置。默认的配置文件为: /WEB-INF/<servlet-name>-servlet.xml,那么 SpringMVC 会自动去 WEB-INF 下面找一个叫 [servlet名字\]-servlet.xml 的文件,不推荐使用这种方式。因此,一般直接初始化设定配置文件位置。
  • load-on-startup:当值为 0 或者大于 0 时,表示容器在应用启动时就加载这个 servlet;当是一个负数时或者没有指定时,则指示容器在该 servlet 被调用时才加载。正数的值越小,启动该 servlet 的优先级越高。当值相同时,容器会自己选择创建顺序。
  • url-pattern:表示拦截哪些请求, “/” 表示拦截所有请求。也可以如“.扩展名”表示拦截所有以扩展名结尾的请求。例如”. Do”
  • 注:

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

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

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

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

2.3 创建 Spring MVC 配置文件(声明组件扫描器,注册视图解析器)

Spring MVC 配置文件在 web.xml 中设置为 spring-mvc.xml。在 resources 下创建配置文件。

视图解析包含两种地址:

  • 物理视图:“/WEB-INF/pages/xxx/xxx.jsp`
  • 逻辑视图:在 spring-mvc. Xml 中配置物理地址的前缀和后缀,处理器中只需要补充中间字段,该中间字段就是逻辑地址。视图解析器会自动将字符串进行拼接。
<?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
       http://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="com.thr.controller"/>
 
    <!-- 配置注解驱动,它的主要的作用是:注册映射器HandlerMapping和适配器HandlerAdapter 两个类型的Bean -->
    <!--HandlerMapping的实现为实现类RequestMappingHandlerMapping,它会处理 @RequestMapping 注解,并将其注册到请求映射表中-->
    <!--HandlerAdapter的实现为实现类RequestMappingHandlerAdapter,它是处理请求的适配器,确定调用哪个类的哪个方法,并且构造方法参数,返回值 -->
    <!--在使用SpringMVC是一般都会加上该配置 -->
    <mvc:annotation-driven/>
 
    <!-- 注册视图解析器 -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 配置前缀 -->
        <property name="prefix" value="/WEB-INF/pages/"/>
        <!-- 配置后缀 -->
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>
 
  • InternalResourceViewResolver 解析器可以解析该资源。其主要职责是:根据处理器的返回值找到资源页面,然后装配页面数据,最后返回给前台。
  • prefixsuffix 属性可以指定资源页面的前缀和后缀,可以直接把资源位置定位到项目的 /WEB-INF 下面。

2.4 创建 Controller 类(处理器)

  • @Controller:将该 Bean 注册到 Spring 的容器中
  • @RequestMapping:该注解可以用在类和方法上,它是用来映射请求的 URL。
    • 用在类上: 表示初步的请求映射信息,所有响应请求都是以该地址作为父路径。
    • 用在方法上: 表示在父路径的基础上进一步细分映射信息。
    • 类定义处未标注 @RequestMapping:则映射的请求 URL 从方法处开始。
@Controller //声明 Bean 对象,为一个控制器组件
public class HelloController {
    @RequestMapping("/hello")
    public String sayHello(){
        System.out.println("Hello SpringMVC");
        return "success";
    }
}

2.5 编写视图文件

在 webapp 下编写index.jsp文件,项目启动后会默认访问该页面。

注意:在第一行中需要加入这个参数isELIgnored="false",否则到时候可能访问不到页面。

<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" isELIgnored="false" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Insert title here</title>
  </head>
  <body>
    <a href="${pageContext.request.contextPath}/hello"
      >第一个 Spring MVC 程序</a
    >
  </body>
</html>

创建目标页面(success.jsp),在/WEB-INF/pages/下创建success.jsp,注:WEB-INF 下的文件是不能直接通过浏览器访问的,只能通过请求进行访问。

<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Hello</title>
  </head>
  <body>
    <h1>成功访问!!!</h1>
  </body>
</html>

2.6 启动 Tomcat 服务器测试

启动 Tomcat 服务器,打开主页访问:

image

点击超链接,成功跳转到相应页面,说明我们的第一个 SpringMVC 程序创建成功了。

image

补充:新版 IDEA(我的是 2020.3)注意这里:

image

出处: https://www.cnblogs.com/tanghaorong