前言:

本文内容:使用注解开发SpringMVC、Controller配置总结、RequestMapping说明

推荐免费SpringMVC基础教程视频:【狂神说Java】SpringMVC最新教程IDEA版通俗易懂_哔哩哔哩_bilibili

使用注解开发SpringMVC

使用注解

  1. 新建modulespringmvc-04-annotation,添加web支持

  2. 由于Maven可能存在资源过滤问题,我们将配置完善

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    <build>
    <resources>
    <resource>
    <directory>src/main/java</directory>
    <includes>
    <include>**/*.properties</include>
    <include>**/*.xml</include>
    </includes>
    <filtering>true</filtering>
    </resource>
    <resource>
    <directory>src/main/resources</directory>
    <includes>
    <include>**/*.properties</include>
    <include>**/*.xml</include>
    </includes>
    <filtering>true</filtering>
    </resource>
    </resources>
    </build>
  3. 在pom.xml文件引入相关的依赖

    主要有SpringMVC,servlet,jstl等,我们之前在父类已经引入了

  4. 配置web.xml

    配置注意点:

    • 注意web.xml版本问题,要最新版
    • 注册DispatcherServlet
    • 关联SpringMVC的配置文件
    • 启动级别为1
    • 映射路径为/(使用/*可能会导致报错)
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    <?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">

    <!-- 配置DispatcherServlet-->
    <servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:springmvc-servlet.xml</param-value>
    </init-param>
    <!-- 启动级别 1-->
    <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <url-pattern>/</url-pattern>
    </servlet-mapping>
    </web-app>
  5. 添加Spring-MVC配置文件

    • 让IOC的注解生效
    • 静态资源过滤:HTML,JS,CSS,图片,视频…
    • MVC的注解驱动
    • 配置视图解析器

    在resources目录下添加springmvc-servlet.xml的配置文件,配置的形式与Spring容器配置基本类似,为了支持基于注解的IOC,设置了自动扫描包功能,配置如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    <?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
    http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--自动扫描包,让指定包下的注解生效,由IOC容器统一管理-->
    <context:component-scan base-package="com.jokerdig.controller"/>
    <!--过滤静态资源,让SpringMVC不处理静态资源 .css .js .html等等-->
    <mvc:default-servlet-handler/>

    <!--
    支持mvc注解驱动
    在spring中一般用@RequestMapping注解完成映射关系
    要想使@RequestMapping注解生效
    必须向上下文中注册DefaultAnnotationHandLerMapping(处理器映射器)
    和一个AnnotationMethodHandLerAdapter(处理器适配器)实例
    这两个实例分别在类级别和方法级别处理
    annotation-driven配置帮助我们自动完成上述两个实例的注入
    -->
    <mvc:annotation-driven/>

    <!--视图解析器-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
    <!--前缀-->
    <property name="prefix" value="/WEB-INF/jsp/"/>
    <!--后缀-->
    <property name="suffix" value=".jsp"/>
    </bean>
    </beans>

    在试图解析器中我们把所有的视图都存放在/WEB-INF/目录下,可以保证视图安全,因为这个目录下的文件,客户端不能直接访问

  6. 创建Controller

    编写一个控制类HelloController.java

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    package com.jokerdig.controller;

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

    /**
    * @author Joker大雄
    * @data 2022/6/1 - 11:58
    **/
    @Controller
    @RequestMapping("/HelloController")
    public class HelloController {

    // 真实访问地址 项目名/HelloController/hello
    @RequestMapping("/hello")
    public String hello(Model model){
    // 封装数据
    model.addAttribute("msg","Hello,SpringMVC-Annotation");
    // return 的结果会被视图解析器处理
    return "hello";
    }
    }
  7. 创建hello.jsp页面

    1
    2
    3
    4
    5
    6
    7
    8
    9
    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
    <title>Title</title>
    </head>
    <body>
    ${msg}
    </body>
    </html>
  8. 运行测试

    1
    2
    浏览器显示:
    Hello,SpringMVC-Annotation

小结

实现步骤:

  1. 新建一个web项目
  2. 导入相关依赖
  3. 编写web.xml,注册DispatcherServlet
  4. 编写SpirngMVC配置文件
  5. 创建对应的控制类,controller
  6. 最后完善前端视图和Controller之间的对应
  7. 测试运行

SpringMVC必须配置:

  • 处理器映射器
  • 处理器适配器
  • 视图解析器

通常我们只需要手动配置视图解析器,而处理器映射器和处理器适配器只需要开启注解驱动即可自动配置。

Controller配置总结

控制器Controller

  • 控制器负责提供访问应用程序的行为,通常通过接口定义或注解定义两种方法实现
  • 控制器负责解析用户的请求并将其转换为一个模型(Model)
  • 在SpringMVC中一个控制器类可以包含多个方法
  • 在SpringMVC中,对于Controller的配置方式有很多种

实现Controller接口

Controller是一个接口,在org.springframework.web.servlet.mvc包下,接口中只有一个方法:

1
2
3
4
5
// 实现该接口的类获得控制器功能
public interface Controller {
// 处理请求且返回一个模型与视图对象
ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}

创建项目并分析Controller

  1. 新建Modulespringmvc-05-controller,添加web支持

  2. 配置web.xml

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    <?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">

    <servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:springmvc-servlet.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <url-pattern>/</url-pattern>
    </servlet-mapping>
    </web-app>
  3. 在resources下创建springmvc-servlet.xml并在java下新建controller包

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    <?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
    http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自动扫包-->
    <context:component-scan base-package="com.jokerdig.controller"/>
    <!-- 过滤静态资源-->
    <mvc:default-servlet-handler/>
    <!-- 支持注解驱动-->
    <mvc:annotation-driven/>
    <!-- 视图解析器-->
    <bean id="InternalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <!-- 前缀-->
    <property name="prefix" value="/WEB-INF/jsp/"/>
    <!-- 后缀-->
    <property name="suffix" value=".jsp"/>
    </bean>

    </beans>

第一种,在类中实现Controller接口

  1. 新建Controller类,ControllerTest.java实现Controller

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    package com.jokerdig.controller;

    import org.springframework.web.servlet.ModelAndView;
    import org.springframework.web.servlet.mvc.Controller;

    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;

    /**
    * @author Joker大雄
    * @data 2022/6/1 - 12:35
    **/
    // 只要实现Controller接口的类 就是一个控制器
    public class ControllerTest implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
    ModelAndView mav = new ModelAndView();

    mav.addObject("msg","ControllerTest1");
    mav.setViewName("test");
    return mav;
    }
    }
  2. springmvc-servlet.xml中配置<bean/>

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    <?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
    http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!--&lt;!&ndash; 自动扫包&ndash;&gt;-->
    <!-- <context:component-scan base-package="com.jokerdig.controller"/>-->
    <!--&lt;!&ndash; 过滤静态资源&ndash;&gt;-->
    <!-- <mvc:default-servlet-handler/>-->
    <!--&lt;!&ndash; 支持注解驱动&ndash;&gt;-->
    <!-- <mvc:annotation-driven/>-->
    <!-- 视图解析器-->
    <bean id="InternalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <!-- 前缀-->
    <property name="prefix" value="/WEB-INF/jsp/"/>
    <!-- 后缀-->
    <property name="suffix" value=".jsp"/>
    </bean>

    <!-- 第一种方法实现controller-->
    <bean id="/test" class="com.jokerdig.controller.ControllerTest"/>

    </beans>
  3. 运行测试

    1
    2
    浏览器显示:
    ControllerTest1
  4. 小结

    • 实现Controller是一种较老的办法,尽量不要使用
    • 一个控制器只有一个方法,如果需要多个方法则要创建多个类并实现Controller,较为繁琐

第二种,使用注解实现

@Controller注解类型用于声明Spring类的实例是一个控制器

Spirng可以使用扫描机制来找到应用程序中所有基于注解的控制器类

  1. 在Spring配置文件中定义自动扫描包,过滤静态资源,支持注解驱动

    1
    2
    3
    4
    5
    6
    <!--    自动扫包 所有注解类交给IOC容器管理-->
    <context:component-scan base-package="com.jokerdig.controller"/>
    <!-- 过滤静态资源-->
    <mvc:default-servlet-handler/>
    <!-- 支持注解驱动-->
    <mvc:annotation-driven/>
  2. 新建ControllerTest2类,使用注解实现

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    package com.jokerdig.controller;

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

    /**
    * @author Joker大雄
    * @data 2022/6/1 - 13:55
    **/
    // Spring接管
    @Controller
    public class ControllerTest2 {

    @RequestMapping("/t2")
    public String test2(Model model){
    model.addAttribute("msg","ControllerTest2");

    return "test"; // 我们要访问的页面名
    }
    @RequestMapping("/t3")
    public String test3(Model model){
    model.addAttribute("msg","ControllerTest3");

    return "test"; // 也可以多个方法访问一个页面
    }
    }
  3. 运行测试

    1
    2
    3
    4
    浏览器显示:
    ControllerTest2
    输入/t3显示
    ControllerTest3

RequestMapping说明

@RequestMapping

  • @RequestMapping注解用于映射url到控制器类或一个特定的处理程序方法,可用于类或方法上。用于类,表示类中所有的响应请求的方法都是以该地址作为父路径

  • 简单测试,新建ControllerTest3

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    package com.jokerdig.controller;

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

    /**
    * @author Joker大雄
    * @data 2022/6/1 - 14:11
    **/
    @Controller
    public class ControllerTest3 {
    @RequestMapping("/t1")
    public String test1(Model model){
    model.addAttribute("msg","RequestMapping");
    return "test";
    }
    }

    访问地址为:http://localhost:8080/项目名/t1

  • 当我们添加注解类的方法

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    package com.jokerdig.controller;

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

    /**
    * @author Joker大雄
    * @data 2022/6/1 - 14:11
    **/
    @Controller
    @RequestMapping("/admin")
    public class ControllerTest3 {
    @RequestMapping("/t1")
    public String test1(Model model){
    model.addAttribute("msg","RequestMapping");
    return "test";
    }
    }

    访问地址为:http://localhost:8080/项目名/admin/t1