【spring springmvc】springmvc使用注解声明控制器与请求映射

深碍√TFBOYSˉ_ 2023-07-17 09:51 20阅读 0赞

# 概述 #

**注解：** 在Spring中尽管使用XML配置文件可以实现Bean的装配工作，但如果应用中Bean的数量较多，会导致XML配置文件过于臃肿，从而给维护和升级带来一定的困难。  
从JDK 5开始提供了名为`Annotation`（注解）的功能，Spring正是利用这一特性，Spring逐步完善对Annotation注解技术的全面支持，使XML配置文件不再臃肿，向“零配置”迈进。

Spring框架也为表示层提供了一个优秀的Web框架，即`Spring MVC`。由于Spring MVC采用了松耦合可插拔组件结构，比其他MVC框架具有更大的扩展性和灵活性。通过注解，`Spring MVC`使得POJO成为处理用户请求的控制器，无需实现任何接口。

### 文章目录 ###

*  概述
 *  壹：注解说明
 *  贰：实现注解声明控制器与请求映射
 *   *  一：使用controller
     *  二：配置包扫描与视图解析器
     *   *  1、配置包扫描
         *  2、配置试图解析器
     *  三：配置部署描述符
     *   *  1、读取spring-mvc.xml文件
         *  2、配置匹配映射
     *  四：建立html文件
 *  叁：配置tomcat
 *   *  一：配置本地tomcat
     *  二：配置maven内置tomcat
 *  肆：结果及问题
 *   *  一：tomcat启动示意图：
     *  二：结果
     *  三：问题
 *  伍：结构及源码
 *   *  一：目录结构
     *  二：源码
 *  作者有话

# 壹：注解说明 #

Spring中定义了一系列的Annotation注解，如下所示：

<table> 
 <thead> 
  <tr> 
   <th>注解名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Component注解</td> 
   <td>@Component 是一个泛化的概念，仅仅表示一个组件（Bean），可以作用在任何层次。</td> 
  </tr> 
  <tr> 
   <td>@Repository注解</td> 
   <td>@Repository 注解用于将数据访问层（DAO 层）的类标识为Spring的Bean。</td> 
  </tr> 
  <tr> 
   <td>@Service注解</td> 
   <td>@Service 通常作用在业务层，但是目前该功能与@Component相同。</td> 
  </tr> 
  <tr> 
   <td>@Controller注解</td> 
   <td>@Controller标识表示层组件，但是目前该功能与@Component相同</td> 
  </tr> 
  <tr> 
   <td>@Autowired注解</td> 
   <td>用于对Bean的属性变量、属性的set方法及构造函数进行标注，配合对应的注解处理器完成Bean的自动配置工作。@Autowired注解默认按照Bean类型进行装配。@Autowired注解加上@Qualifier注解，可直接指定一个Bean实例名称来进行装配。</td> 
  </tr> 
  <tr> 
   <td>@Resource注解</td> 
   <td>作用相当于@Autowired，配置对应的注解处理器完成Bean的自动配置工作。区别在于：①：@Autowired默认按照Bean类型进行装配，②：@Resource默认按照Bean实例名称进行装配。</td> 
  </tr> 
 </tbody> 
</table>

# 贰：实现注解声明控制器与请求映射 #

## 一：使用controller ##

`org.springframework.stereotype.Controller`注解类型用于指示Spring类的实例是一个控制器，其注解形式为`@Controller`。该注解在使用时不需要再实现Controller接口，只需要将@Controller注解加入到控制器类上，然后通过Spring的扫描机制找到标注了该注解的控制器即可。

@Controller
    public class SpringController { 
        @GetMapping("/helloWorld")
        public String hello(){ 
            System.out.println("hello.....");
            return "hello";
        }
    }

我们常用的rest 风格请求（REST ： 即 `Representational State Transfer` 。(资源)表现层状态转化）：

<table> 
 <thead> 
  <tr> 
   <th>请求</th> 
   <th>说明</th> 
   <th>用于</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@GetMapping</td> 
   <td>匹配GET方式的请求；</td> 
   <td>一般读取数据</td> 
  </tr> 
  <tr> 
   <td>@PostMapping</td> 
   <td>匹配POST方式的请求；</td> 
   <td>一般用于插入数据</td> 
  </tr> 
  <tr> 
   <td>@PutMapping</td> 
   <td>匹配PUT方式的请求；</td> 
   <td>一般用于更新数据</td> 
  </tr> 
  <tr> 
   <td>@DeleteMapping</td> 
   <td>匹配DELETE方式的请求；</td> 
   <td>一般用于删除数据</td> 
  </tr> 
 </tbody> 
</table>

## 二：配置包扫描与视图解析器 ##

### 1、配置包扫描 ###

虽然哦我们已经写好了controller，但是直接这样写我们是不能用的，还需要在`spring-mvc.xml`配置文件中，用spring的包扫描将他注入到容器中，我们才能实现调用。

<context:annotation-config/>
        <context:component-scan base-package="com.lomtom.controller"/>
        当然，spring提供了很多种方法，我们是用最简单实现的就可以。

### 2、配置试图解析器 ###

`SpringMVC`中的视图解析器的**主要作用**就是将逻辑视图转换成用户可以看到的物理视图。  
在`spring-mvc.xml`加入试图解析器，其中的前缀就是根据自己的文件存放目录来写，后缀就是你的文件的后缀名，你可以是.jsp、.html等等。

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/"></property>
            <property name="suffix" value=".html"></property>
        </bean>

## 三：配置部署描述符 ##

`Deployment Descriptors`（描述符）是一个xml文件，用来描述如何部署一个模块或者应用（根据描述符中定义的配置和容器选项）。  
在这里简单来说就是我们的`web.xml`。

### 1、读取spring-mvc.xml文件 ###

虽然，我们已经把controller通过`spring-mvc.xml`注入到容器中，相信这时你启动项目时，是访问不了的controller的请求的，也就是说，我们的我没在配置该文件，这时候在你的web.xml中加入。

如果我们不指定SpringMVC配置文件的路径，则会自动到WEB-INF下找 ‘‘`前端控制器名-servlet.xml`’’ 这个文件，如果找不到则会报错。

<init-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>

### 2、配置匹配映射 ###

**servlet：** 它提供静态资源。它处理所有未映射到其他带有servlet映射的servlet（在这里或在您自己的-web.xml文件）。

**servlet-mapping：** 当为静态资源提供服务时，Tomcat将自动生成基于资源文件扩展名的“Content Type”头，基于这些映射。可以在此处添加其他映射（到应用于所有web应用程序），或在您自己的应用程序的web.xml中部署描述符。

<servlet>
       <servlet-name>dispatcherServlet</servlet-name>
       <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
     </servlet>
     
     
     <servlet-mapping>
       <servlet-name>dispatcherServlet</servlet-name>
       <url-pattern>/</url-pattern>
     </servlet-mapping>

## 四：建立html文件 ##

新建两个文件，用于访问测试，一个`index.html`，写一个连接指向`href=“helloWorld”`，写另一个`hello.html`，用于访问成功后，跳转到该页面。

# 叁：配置tomcat #

在这里，作者摸索到了两种配置tomcat的方法，一种就是本地自个的`tomcat`，还有一种就是`maven`提供的tomcat容器。

## 一：配置本地tomcat ##

基本上就是这几步，其中的选择tomcat目录省略了，不是很难，添加服务就可以，找不到入口就算了，请不要打我。如果你配置tomcat也不会，那么，现在放下电脑去打把王者荣耀吧，妲己可能会告诉你。  
![tomcat][]

## 二：配置maven内置tomcat ##

配置maven的tomcat相对会麻烦一点，不过也不是很麻烦，在你的pom.xml文件中加入一下插件依赖。

<plugins>
    	<plugin>
    	    <groupId>org.apache.tomcat.maven</groupId>
    	    <artifactId>tomcat7-maven-plugin</artifactId>
    	    <version>2.2</version>
    	</plugin>
    </plugins>

然后，添加配置，需要注意的是，你需要配置你的maven，在下图的General里面，如果你已经使用了maven，就不用配了，可以查看General下配置是否正确。  
安装与配置maven：[传送门][Link 1]  
![maven-tomcat][]  
接下来你就可以启动你的项目了，祝你能够一步成功，哈哈哈哈。

# 肆：结果及问题 #

## 一：tomcat启动示意图： ##

本地tomcat：  
![20200321130028486.png][]  
maven内置tomcat：  
![20200321130151666.png][]

## 二：结果 ##

首页：![首页][20200321125625621.png]  
死案及后跳转：  
![hello][]

## 三：问题 ##

1、解决SpringMVC不能访问html页面

<servlet-mapping>
    	<servlet-name>default</servlet-name>
    	<url-pattern>*.html</url-pattern>
    </servlet-mapping>

2、使用maven内置tomcat有时能跳转，有时不能跳转，不能跳转的时候他会卡在读取文件这里，这里对不起了，笔者没找到解决方法，如果你找到了，欢迎告诉笔者。

三月 21, 2020 1:02:09 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
    信息: Loading XML bean definitions from class path resource [spring-mvc.xml]

该问题追加：

根据评论大佬的解决方法，我重新试了一下，后来发现问题根源，发现项目根本找不到`spring-context.xsd`，导致spring-mvc.xml文件加载出错，并且造成`通配符的匹配很全面, 但无法找到元素 'context:annotation-config' 的声明`的错误，所以项目一直在加载`spring-mvc.xml`文件，这时我就意识到是我的`spring-mvc.xml`中的引入出问题了，经过修改，问题解决了。

修改前：
    https://www.springframework.org/schema/context/spring-context.xsd
    修改后：
    http://www.springframework.org/schema/context/spring-context.xsd

# 伍：结构及源码 #

源码都放出来了，还不是ctrl+c，ctrl+v一顿乱搞。

## 一：目录结构 ##

![目录结构][20200321130523682.png]

## 二：源码 ##

1、controller

package com.lomtom.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.GetMapping;
    
    /** * @Author: LOMTOM * @Date: 2020/3/20 * @Time: 18:40 * @Email: lomtom@qq.com */
    @Controller
    public class SpringController { 
        @GetMapping("/helloWorld")
        public String hello(){ 
            System.out.println("hello.....");
            return "hello";
        }
    }

2、spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mvc="http://www.springframework.org/schema/mvc" 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/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
    
        <mvc:annotation-driven/>
    
        
        <context:annotation-config/>
        <context:component-scan base-package="com.lomtom.controller"/>
    
        
        <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/"></property>
            <property name="suffix" value=".html"></property>
        </bean>
    </beans>

3、web.xml

<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" >
    
    <web-app>
      <display-name>Archetype Created Web Application</display-name>
      <servlet>
        
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    
        
        <init-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
      </servlet>
      
      <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
      </servlet-mapping>
      <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.html</url-pattern>
      </servlet-mapping>
    </web-app>

4、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">
        <parent>
            <artifactId>spring</artifactId>
            <groupId>spring</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>spring-8</artifactId>
        <packaging>war</packaging>
    
        <name>spring-8 Maven Webapp</name>
        
        <url>http://www.example.com</url>
    
        <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>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>4.3.1.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>4.3.1.RELEASE</version>
            </dependency>
        </dependencies>
    
        <build>
            <finalName>spring-8</finalName>
            <pluginManagement>
                <plugins>
                    <plugin>
                        <groupId>org.apache.tomcat.maven</groupId>
                        <artifactId>tomcat7-maven-plugin</artifactId>
                        <version>2.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-clean-plugin</artifactId>
                        <version>3.1.0</version>
                    </plugin>
                    
                    <plugin>
                        <artifactId>maven-resources-plugin</artifactId>
                        <version>3.0.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-compiler-plugin</artifactId>
                        <version>3.8.0</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-surefire-plugin</artifactId>
                        <version>2.22.1</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-war-plugin</artifactId>
                        <version>3.2.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-install-plugin</artifactId>
                        <version>2.5.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-deploy-plugin</artifactId>
                        <version>2.8.2</version>
                    </plugin>
                </plugins>
            </pluginManagement>
        </build>
    </project>

5、html

1、index.html
    <html>
    <body>
    <h2>Hello World!</h2>
    <a href="helloWorld">hello</a>
    </body>
    </html>
    
    
    2、hello.html
    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>hello</title>
    </head>
    <body>
    <h2>你好啊，你成功了</h2>
    </body>
    </html>

# 作者有话 #

这篇文章，作者已经肝了很久了，如果对你有用的话，点个赞再走吧，不说了，作者要交作业去了。

[tomcat]: /images/20230528/d17784236ba74f93851cca8356458332.png
[Link 1]: https://blog.csdn.net/qq_41929184/article/details/104561126
[maven-tomcat]: /images/20230528/873b50038712484d80814cf94945db49.png
[20200321130028486.png]: /images/20230528/9b6a9b5e386e4e0ca571df87ab01d7c1.png
[20200321130151666.png]: /images/20230528/c4a1cf414ace48cd9b8fe66fd0a484fd.png
[20200321125625621.png]: /images/20230528/3fdc169d065345c18399ecc3ddc8bd70.png
[hello]: /images/20230528/9e36a8ec527f47f8b00c1d3ddba6cf01.png
[20200321130523682.png]: /images/20230528/b4ae72567f1046cb95c191106767b993.png