第一个注解的 SpringMVC 程序

ch01-hello-springmvc:第一个注解的springmvc项目

所谓 SpringMVC 的注解式开发是指，在代码中通过对类与方法的注解，便可完成处理器

在 springmvc 容器的注册。注解式开发是重点。

需求：用户再页面发起一个请求，请求交给springmvc的控制器对象
并显示请求的处理结果（在结果页面显示一个欢迎语句）

实现步骤：

1. 新建web maven工程
2. 加入依赖
   spring-webmvc依赖，间接把spring的依赖都加入到项目
   jsp,servlet依赖

<dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>

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

      <!--springmvc依赖-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.5.RELEASE</version>
        </dependency>
    </dependencies>

	<build>
      <plugins>
        <!-- 编码和编译和JDK版本 -->
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.1</version>
          <configuration>
            <source>1.8</source>
            <target>1.8</target>
          </configuration>
        </plugin>
      </plugins>

    </build>

3. 重点：在web.xml中注册springmvc框架的核心对象DispatcherServlet
   1)DispatcherServlet叫做*调度器，是一个servlet，它的父类是继承HttpServlet
   2)DispatcherServlet也叫做前端控制器（front controller）
   3)DispatcherServlet负责接收用户提交的请求，调用其他的控制器对象，并把请求的处理结果显示给用户
4. 创建一个发起请求的页面index.jsp
5. 创建控制器类
   1）在类的上面加入@Controller注解，创建对象，并放入到springmvc容器中
   2）在类中的方法上面加入@RequestMapping注解
6. 创建一个作为结果的jsp,显示请求的处理结果。
7. 创建springmvc的配置文件（和spring的配置文件一样）
   1）声明组件扫描器，指定@Controller注解所在的包名
   2）声明视图解析器，帮助处理视图的

<!--声明 springmvc框架中的视图解析器，帮助开发人员设置视图文件的路径-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!--前缀：视图文件的路径-->
        <property name="prefix" value="/WEB-INF/view/"/>
        <!--后缀：视图文件的扩展名-->
        <property name="suffix" value=".jsp"/>
    </bean>

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>org.example</groupId>
    <artifactId>ch01-hello-springmvc</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>


    <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>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>

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

      <!--springmvc依赖-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.5.RELEASE</version>
        </dependency>
    </dependencies>

    <build>
      <plugins>
        <!-- 编码和编译和JDK版本 -->
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.1</version>
          <configuration>
            <source>1.8</source>
            <target>1.8</target>
          </configuration>
        </plugin>
      </plugins>

    </build>
</project>

0. 项目结构：

1. 配置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的核心对象DispatcherServlet
  需要在tomcat服务器启动后，创建DispatcherServlet对象的实例
  为什么要创建DispatcherServlet对象的实例呢？
  因为DispatcherServlet在他的创建过程中，会同时创建springmvc容器对象
  读取springmvc的配置文件，把这个配置文件中的对象都创建好，当用户发起
  请求时，就可以直接使用对象了。

  servlet的初始化会执行init()方法。DispatcherServlet在init()中{
      // 创建容器，读取配置文件
      WebApplicationContext ctx = new ClassPathXmlApplicationContext("springmvc.xml");
      // 把容器对象放入到ServletContext中
      getServletContext().setAttribute(key,ctx);
  }
注册*处理器-->

    <!--启动tomcat报错
     读取这个文件/WEB-INF/springmvc-servlet.xml失败
     springmvc创建容器对象时，读取的配置文件默认是/WEB-INF/《servlet-name》-servlet.xml
     我们可以不使用这种默认的读取文件的方式，自定义springmvc读取的配置文件所在的位置
    -->

  <servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

      <!--自定义springmvc读取的配置文件的位置-->
      <init-param>
          <!--springmvc的配置文件的位置的属性-->
          <param-name>contextConfigLocation</param-name>
          <!--指定自定义文件的位置-->
          <param-value>classpath:springmvc.xml</param-value>
      </init-param>

      <!--在tomcat启动后，创建Servlet对象
        load-on-startup:表示tomcat启动后创建对象的顺序。
        它的值是整数，数值越小，tomcat创建对象的时间越早。
        大于等于0的整数
      -->
      <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
      <!--
            使用框架的时候，url-pattern可以使用两种值
            1. 使用扩展名方式，语法：*.xxx, xxx是自定义的扩展名。常用的方式 *.do、*.action、*.mvc等等
                http://localhost:8080/springmvc/some.do
                http://localhost:8080/springmvc/other.do
            2. 使用斜杠“/”

      -->
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>
</web-app>

1. 全限定性类名
该*调度器为一个 Servlet，名称为 DispatcherServlet。*调度器的全限定性类名在
导入的 Jar 文件 spring-webmvc-5.2.5.RELEASE.jar 的第一个包 org.springframework.web.servlet
下可找到。


2. <load-on-startup/>:
在<servlet/>中添加<load-on-startup/>的作用是，标记是否在Web服务器（这里是Tomcat）
启动时会创建这个 Servlet 实例，即是否在 Web 服务器启动时调用执行该 Servlet 的 init()方
法，而不是在真正访问时才创建。
它的值必须是一个整数。 
➢ 当值大于等于 0 时，表示容器在启动时就加载并初始化这个 servlet，数值越小，该 Servlet
的优先级就越高，其被创建的也就越早；
➢ 当值小于 0 或者没有指定时，则表示该 Servlet 在真正被使用时才会去创建。 
➢ 当值相同时，容器会自己选择创建顺序。

3. <url-pattern/>
对于<url-pattern/>，可以写为 / ，建议写为*.do 的形式。


4. 配置文件位置与名称
注册完毕后，可直接在服务器上发布运行。此时，访问浏览器页面，控制台均会抛出
FileNotFoundException 异常。即默认要从项目根下的 WEB-INF 目录下找名称为 Servlet 名称
-servlet.xml 的配置文件。这里的“Servlet 名称”指的是注册*调度器<servlet-name/>标签
中指定的 Servlet 的 name 值。本例配置文件名为 springmvc-servlet.xml。

而一般情况下，配置文件是放在类路径下，即 resources 目录下。所以，在注册*调
度器时，还需要为*调度器设置查找 SpringMVC 配置文件路径，及文件名。

2. MyController.java文件：

@Controller
	 创建处理器对象，对象放在springmvc容器中
	 使用位置：在类的上面
和Spring中讲的@Service、@Component一样能处理请求的都是控制器（处理器）：
MyController能够处理请求，叫做后端控制器（back controller）

@RequestMapping:请求映射，作用时把一个请求地址和一个方法绑定在一起
              一个请求指定一个方法处理
      属性：
         	 1.value是一个String，表示请求的uri地址的（some.do），
         	 value的值必须是唯一的，不能重复。在使用时推荐地址以“/”开头
      使用的位置：
		     1.在方法的上面，常用的
		     2.在类的上面
		       说明：使用@RequestMapping修饰的方法叫做处理器方法或者控制器方法
		                使用@RequestMapping修饰的方法是可以处理请求的，类似Servlet中
		                的doGet()、doPost()。
		                若有多个请求路径均可匹配该处理器方法的执行，则@RequestMapping 
		                的 value 属性中可以写上一个数组。

ModelAndView 类中的 addObject()方法用于向其 Model 中添加数据。Model 的底层为一个 HashMap。
Model 中的数据存储在 request 作用域中，SringMVC 默认采用转发的方式跳转到视图，本次请求结束，模型中的数据被销毁。

package com.zep.controller;

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

/**
 * @Controller 创建处理起对象，对象放在springmvc容器中
 * 使用位置：在类的上面
 * 和Spring中讲的@Service、@Component一样
 * 能处理请求的都是控制器（处理器）：MyController能够处理请求，
 *                              叫做后端控制器（back controller）
 */
@Controller
public class MyController {
    /**
     * 处理用户提交的请求：springmvc中是使用方法来处理的。
     * 方法是自定义的，可以有多种返回值，多种参数，方法名称自定义
     * 准备使用doSome方法处理some.do请求
     * @RequestMapping:请求映射，作用时把一个请求地址和一个方法绑定在一起,一个请求指定一个方法处理
     *              属性：
     *                  1.value是一个String，表示请求的uri地址的（some.do）,value的值必须是唯一的，不能重复。在使用时推荐地址以“/”开头
     *              使用的位置：
     *                  1.在方法的上面，常用的
     *                  2.在类的上面
     *              说明：使用@RequestMapping修饰的方法叫做处理器方法或者控制器方法
     *                      使用@RequestMapping修饰的方法是可以处理请求的，类似Servlet中的doGet()、doPost()
     *              返回值：ModelAndView
     *                  Model:数据，请求处理完成后，要显示给用户的数据
     *                  View:视图，比如jsp等待
     */
    @RequestMapping(value = "/some.do")
    public ModelAndView doSome() {  // doGet()--service请求处理
        // 可以处理some.do请求了，相当于service调用处理完成了
        ModelAndView mv = new ModelAndView();
        // 添加数据,框架在请求的最后部分把数据放入到request作用域
        // 相当于是执行了request.setAttribute("msg","欢迎使用springmvc做web开发")
        mv.addObject("msg","欢迎使用springmvc做web开发");
        mv.addObject("fun","执行的是doSome方法");
        // 指定视图,指定视图的完整路径
        // 框架对视图执行的是forward操作，类似于request.getRequestDispatcher("/show.jsp").forward(request,response);
//        mv.setViewName("/show.jsp");
//        mv.setViewName("/WEB-INF/view/show.jsp");
//        mv.setViewName("/WEB-INF/view/other.jsp");

        // 当配置了视图解析器后，可以使用逻辑名称（文件名），指定视图
        // 框架会使用视图解析器的前缀 + 逻辑名称 + 后缀 组成完整路径，这里就是字符串拼接操作
        // /WEB-INF/view/ + show + .jsp
        mv.setViewName("show");

        // 返回mv
        return mv;
    }
}

3. 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"
       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.zep.controller"/>
</beans>

4. 修改视图解析器的注册
SpringMVC 框架为了避免对于请求资源路径与扩展名上的冗余，在视图解析器
InternalResouceViewResolver 中引入了请求的前辍与后辍。而 ModelAndView 中只需给出要跳转页面的文件名即可，对于具体的文件路径与文件扩展名，视图解析器会自动完成拼接。

index.jsp：

<%--
  Created by IntelliJ IDEA.
  User: Zep
  Date: 2020/12/2
  Time: 0:52
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>index</title>
</head>
<body>

    <p>第一个springmvc项目</p>
    <p><a href="some.do">发起some.do的请求</a></p>

</body>
</html>

show.jsp:

<%--
  Created by IntelliJ IDEA.
  User: Zep
  Date: 2020/12/2
  Time: 1:14
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>show</title>
</head>
<body>
    <h3>show.jsp从request作用域获取数据</h3>
    <h3>msg数据：${msg}</h3>
    <h3>fun数据：${fun}</h3>

</body>
</html>

运行结果：

点击 发起some.do的请求

总结：

*SpringMVC请求的处理流程：
1）访问index.jsp页面，点击超链接，发起some.do请求
2）tomcat(读取web.xml文件——通过url-pattern知道 .do 的请求 是给 DispatcherServlet)
3) DispatcherServlet (根据springmvc.xml配置文件 知道some.do请求对应到doSome()方法上)
4）DispatcherServlet把 some.do 转发给 MyController.doSome()方法
5）框架执行doSome()把得到的ModelAndView进行处理，转发到show.jsp

上面的过程简化的方式：
some.do ——> DispatcherServlet ——> MyController

本文地址：https://blog.csdn.net/weixin_44827418/article/details/110458390