使用注解开发SpringMVC详细配置教程

迷南。 2022-12-02 01:09 164阅读 0赞

### 目录 ###

*  1、使用注解开发SpringMVC
 *   *  1、新建一个普通的maven项目，添加web支持
     *  2、在pom.xml中导入相关依赖
     *  3、配置web.xml
     *  4、编写SpringMVC配置文件
     *   *  1. 自动扫描包
         *  2. 过滤静态资源
         *  3. 支持mvc注解驱动
         *  4. 视图解析器
     *  5、创建controller
     *  6、创建视图层
     *  7、在项目结构中添加lib目录
     *  8、配置Tomcat运行测试
 *  2、控制器Controller
 *   *  1. 实现Controller接口
     *  2. 使用注解@Controller
 *  3、@RequestMapping

# 1、使用注解开发SpringMVC #

--------------------

## 1、新建一个普通的maven项目，添加web支持 ##

![image-20200816220205665][]

## 2、在pom.xml中导入相关依赖 ##

*  SpringMVC相关
    
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.8.RELEASE</version>
        </dependency>
 *  Servlet
    
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>
 *  jsp
    
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2 </version>
        </dependency>

> 为了防止资源导出失败，我们加入以下代码

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes> 
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

## 3、配置web.xml ##

> 注意web.xml的版本要为最新版

**注册DispatcherServlet**

*  需要绑定一个SpringMVC配置文件，下一步我们将创建
 *  设置启动级别为1
 *  设置映射路径为`/`

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

## 4、编写SpringMVC配置文件 ##

> 上述`DispatcherServlet`绑定该配置文件，主要配置以下几个部分：

### 1. 自动扫描包 ###

让指定包下的注解生效，由IOC容器统一管理

<context:component-scan base-package="controller"/>

### 2. 过滤静态资源 ###

它会像一个检查员，对进入`DispatcherServlet`的URL进行筛查，如果发现是静态资源的请求，就将该请求转由**Web应用服务器默认的Servlet**处理，如果不是静态资源的请求，才由`DispatcherServlet`继续处理。

<mvc:default-servlet-handler/>

![image-20200828164212214][]

### 3. 支持mvc注解驱动 ###

> 在Spring中一般用`@RequestMapping`注解来完成映射关系

为了使其生效， 必须向上下文中注册两个实例：

*  DefaultAnnotationHandLerMapping（处理器映射器）
 *  AnnotationMethodHandLerAdapter（处理器适配器）

<mvc:annotation-driven/>

`annotation-driven`配置帮助我们自动完成上述两个实例的注入

### 4. 视图解析器 ###

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
        
        <property name="prefix" value="/WEB-INF/jsp/"/>
        
        <property name="suffix" value=".jsp"/>
    </bean>

**完整代码**：

<?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="controller"/>
        
        <mvc:default-servlet-handler/>
        
        <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>

**SpringMVC必须配置的三大件**

*  `处理器映射器`
 *  `处理器适配器`
 *  `视图解析器`

当我们用注解实现时，只需要手动配置`视图解析器`，另外两个只需要开启`注解驱动`即可，省去了大量xml片段

## 5、创建controller ##

在`src/main/java`目录下新建controller包，在其中新建`HelloController.java`

package controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    @Controller
    public class HelloController { 
        @RequestMapping("/hello")
        public String hello(Model model) { 
            //封装数据
            model.addAttribute("msg", "Hello SpringMVCAnnotation");
            return "hello";//会被视图解析器处理
        }
    }

*  `@Controller`是为了让SpringIOC容器初始化时自动扫描到该类
 *  `@RequestMapping`是为了映射请求路径，直接再其中设置路径名即可，这里为`\hello`
    
     *  ![1][]
     *  可以在类上使用，也可以直接在方法上使用，同时使用时，在类上使用相当于父路径
 *  方法声明中的`Model`参数是用于向视图中封装数据
 *  方法返回的结果是视图的名称，这里为`hello`，加上配置文件中的前后缀变成`WEB-INF/jsp/hello.jsp`

## 6、创建视图层 ##

> 编写要请求的jsp页面，这里显示上述存入视图的参数

在`web/WEB-INF/`下新建jsp包，在其中新建`hello.jsp`

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>Title</title>
    </head>
    <body>
    ${msg}
    </body>
    </html>

## 7、在项目结构中添加lib目录 ##

> 该步骤是为了防止最终出现404错误，这是IDEA自己的问题  
> ![image-20200828083021863][]

**选中所有的包，导入**  
![image-20200828083125538][]

## 8、配置Tomcat运行测试 ##

运行测试，访问`http://localhost:8080/hello`，成功访问  
![image-20200828141613019][]

--------------------

# 2、控制器Controller #

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

## 1. 实现Controller接口 ##

> Controller是一个接口，在`org.springframework.web.servlet.mvc`包下，接口中只有一个方法；  
> ![image-20200828170055510][]

接下来的操作代码基于上一篇博客[第一个SpringMVC程序][SpringMVC]

我们删除`springmvc-servlet`配置文件中`处理映射器`和`处理适配器`的配置，只留下一个`视图解析器`

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    
        
        <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
            
            <property name="prefix" value="/WEB-INF/jsp/"/>
            
            <property name="suffix" value=".jsp"/>
        </bean>
    
        
        <bean id="/hello" class="controller.HelloController"/>
    </beans>

然后配置`Tomcat`运行测试，同样访问`http://localhost:8080/hello`  
![image-20200828170550886][]  
发现也可以成功运行，我们先前之所以写上`处理映射器`和`处理适配器`的配置，是为了了解其执行原理，显示调用，真实开发中，不需要配置，SpringMVC已经帮我们配置好了的

**缺点：**

*  一个控制器中只有一个方法，如果要多个方法则需要定义多个Controller，比较麻烦；

--------------------

## 2. 使用注解@Controller ##

> @Controller注解类型用于声明Spring类的实例是一个`控制器`，这是我们最长使用的方式

*  Spring可以使用**扫描机制**来找到应用程序中所有基于注解的控制器类，为了保证Spring能找到你的控制器，需要在配置文件中声明组件扫描。

<context:component-scan base-package="controller"/>

**例如上述类**：

被这个注解的类中的所有方法，如果返间值是`String`，并且有具体页面可以跳转，那么就会被视图解析器解折

例如我们在其中增加一个方法，同样返回`hello`视图

@Controller
    public class HelloController { 
        @RequestMapping("/hello")
        public String hello(Model model) { 
            //封装数据
            model.addAttribute("msg", "Hello SpringMVCAnnotation");
            return "hello";//会被视图解析器处理
        }
    
        @RequestMapping("/hello2")
        public String hello2(Model model) { 
            model.addAttribute("msg","This is the second request");
            return "hello";
        }
    }

再次配置Tomcat运行测试，首先访问`http://localhost:8080/hello`

![image-20200828172221267][]

再访问`http://localhost:8080/hello2`

![image-20200828172311034][]

可以发现，我们的两个请求都可以指向一个视图，但是页面结果的结果是不一样的，从这里可以看出**视图是被复用**的，而控制器与视图之间是**弱偶合关系**。

# 3、@RequestMapping #

`@RequestMapping`注解用于映射url到控制器或一个特定的处理程序方法，可用于类或方法上

*  用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径

我们修改上述方法，在类上增加该注解

@Controller
    @RequestMapping("/h")
    public class HelloController { 
        @RequestMapping("/hello")
        public String hello(Model model) { 
            //封装数据
            model.addAttribute("msg", "Hello SpringMVCAnnotation");
            return "hello";//会被视图解析器处理
        }
    
        @RequestMapping("/hello2")
        public String hello2(Model model) { 
            model.addAttribute("msg","This is the second request");
            return "hello";
        }
    }

然后配置Tomcat运行测试，我们再输入`http://localhost:8080/hello`，

![image-20200828203220334][]

直接**404**找不到报错了，这是因为我们在类上添加该注解，相当于一个父路径

再次访问`http://localhost:8080/h/hello`，成功！

![image-20200828203314750][]

[image-20200816220205665]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200816220205665.png
[image-20200828164212214]: /images/20221123/c6f05acaf8cf41eca1804b639f106712.png
[1]: /images/20221123/5b6dfd71145d42babd6f3307eaef3ed1.png
[image-20200828083021863]: /images/20221123/978621e6b2a5494e9ab4beeef3bde142.png
[image-20200828083125538]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200828083125538.png
[image-20200828141613019]: /images/20221123/d276583d699149c99906478e1286d372.png
[image-20200828170055510]: /images/20221123/3f721b2ab2554876917aec98bfd277a4.png
[SpringMVC]: https://blog.csdn.net/qq_45173404/article/details/108181787
[image-20200828170550886]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200828170550886.png
[image-20200828172221267]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200828172221267.png
[image-20200828172311034]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200828172311034.png
[image-20200828203220334]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200828203220334.png
[image-20200828203314750]: https://gitee.com/zhong_siru/images/raw/master//img/image-20200828203314750.png