SpringMVC项目入门案例

浅浅的花香味﹌ 2024-04-01 12:40 9阅读 0赞

因为SpringMVC是一个Web框架，将来是要替换Servlet，所以先来回顾下以前Servlet是如何进行开发的?

1.创建web工程(Maven结构)；

2.设置tomcat服务器，加载web工程(tomcat插件)；

3.导入坐标(Servlet)；

4.定义处理请求的功能类(UserServlet)；

5.设置请求映射(配置映射关系)。

SpringMVC的制作过程和上述流程几乎是一致的，具体的实现流程是什么?

1.创建web工程(Maven结构)；

2.设置tomcat服务器，加载web工程(tomcat插件)；

3.导入坐标(SpringMVC\+Servlet)；

4.定义处理请求的功能类(UserController)；

5.设置请求映射(配置映射关系)；

6.将SpringMVC设定加载到Tomcat容器中。

### 步骤1:创建Maven项目 ###

打开IDEA，创建一个新的web项目。

![在这里插入图片描述][902d638f32e5449c8c591d0eb94e7c78.png_pic_center]

![在这里插入图片描述][453549356c9949aeb22b211594687825.png_pic_center]

![在这里插入图片描述][06db62c6d9594ca2b16f49389842c405.png_pic_center]

![在这里插入图片描述][fd41257d69ab4e4099a6b8af4f47908b.png_pic_center]

### 步骤2:补全目录结构 ###

因为使用骨架创建的项目结构不完整，需要手动补全。

![在这里插入图片描述][d7615e0ba87140e68428b0b4c5019b4c.png_pic_center]

![在这里插入图片描述][7e15196f4c4547dd8024b6f5ada0c45a.png_pic_center]

![在这里插入图片描述][168e8d2b0e0647639ef86fdbdd53c25d.png_pic_center]

### 步骤3:导入jar包 ###

将pom.xml中多余的内容删除掉，再添加SpringMVC需要的依赖。

<?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>com.dcxuexi</groupId>
      <artifactId>springmvc_01_frist</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>org.springframework</groupId>
          <artifactId>spring-webmvc</artifactId>
          <version>5.2.15.RELEASE</version>
        </dependency>
        <dependency>
          <groupId>javax.servlet</groupId>
          <artifactId>javax.servlet-api</artifactId>
          <version>3.1.0</version>
          <scope>provided</scope>
        </dependency>
        <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.11</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
    
      <build>
        <plugins>
          <plugin>
            
            <groupId>org.apache.tomcat.maven</groupId>
            <artifactId>tomcat7-maven-plugin</artifactId>
            <version>2.1</version>
            <configuration>
              <port>80</port>
              <path>springmvc</path>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </project>

\*\*说明:\*\*servlet的坐标为什么需要添加`<scope>provided</scope>`?

*  scope是maven中jar包依赖作用范围的描述；
 *  如果不设置默认是`compile`在在编译、运行、测试时均有效；
 *  如果运行有效的话就会和tomcat中的servlet-api包发生冲突，导致启动报错；
 *  provided代表的是该包只在编译和测试的时候用，运行的时候无效直接使用tomcat中的，就避免冲突。

### 步骤4:创建配置类 ###

//springmvc配置类，本质上还是一个spring配置类
    //加载controller对应的bean
    @Configuration
    @ComponentScan("com.dcxuexi.controller")
    public class SpringMvcConfig {
        
    }

### 步骤5:创建Controller类 ###

// 定义controller
    // 使用 @Controller 定义表现层控制器bean
    @Controller
    public class UserController {
        
    
        //设置映射路径为/select，即外部访问路径
        @GetMapping("/select")
        //设置当前操作返回结果为指定json数据（本质上是一个字符串信息）
        @ResponseBody
        public String select(){
        
            System.out.println("UserController select , runnning ....");
            return "{\"username\":\"xiaochuang\"}";
        }
    }

### 步骤6:使用配置类替换web.xml ###

将web.xml删除，换成ServletContainersInitConfig。

// 定义一个servlet容器启动的配置类，在里面加载spring的配置
    public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
        
        //加载springmvc配置类，产生springmvc容器（本质还是spring容器）
        @Override
        protected WebApplicationContext createServletApplicationContext() {
        
            //初始化WebApplicationContext对象
            AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
            //加载指定配置类
            context.register(SpringMvcConfig.class);
            return context;
        }
    
        //设置由springmvc控制器处理的请求映射路径
        @Override
        protected String[] getServletMappings() {
        
            return new String[]{
        "/"};
        }
    
        //加载spring配置类
        @Override
        protected WebApplicationContext createRootApplicationContext() {
        
            return null;
        }
    }

### 步骤7:配置Tomcat环境 ###

![在这里插入图片描述][e6c76cf7192e4f46828a6005e6e46f1f.png_pic_center]  
![在这里插入图片描述][c8427132564546d495caeeecf7af6015.png_pic_center]

### 步骤8:启动运行项目 ###

![在这里插入图片描述][d6966b82ba5c4ddba486cbf47afb8e7c.png_pic_center]

### 步骤9:浏览器访问 ###

浏览器输入`http://localhost/springmvc/select`进行访问，就能看到返回的结果数据：

![在这里插入图片描述][69562c76554449348918daf804b53614.png_pic_center]

至此SpringMVC的入门案例就已经完成。

**注意事项**

*  SpringMVC是基于Spring的，在pom.xml只导入了`spring-webmvc`jar包的原因是它会自动依赖spring相关坐标；
 *  AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类；
 *  AbstractDispatcherServletInitializer提供了三个接口方法供用户实现；
    
     *  createServletApplicationContext方法，创建Servlet容器时，加载SpringMVC对应的bean并放入WebApplicationContext对象范围中，而WebApplicationContext的作用范围为ServletContext范围，即整个web容器范围；
     *  getServletMappings方法，设定SpringMVC对应的请求映射路径，即SpringMVC拦截哪些请求；
     *  createRootApplicationContext方法，如果创建Servlet容器时需要加载非SpringMVC对应的bean,使用当前方法进行，使用方式和createServletApplicationContext相同。
     *  createServletApplicationContext用来加载SpringMVC环境；
     *  createRootApplicationContext用来加载Spring环境。

### 知识点1：@Controller ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@Controller</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设定SpringMVC的核心控制器bean</td> 
  </tr> 
 </tbody> 
</table>

### 知识点2：@RequestMapping ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@RequestMapping</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解或方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器类或方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前控制器方法请求访问路径</td> 
  </tr> 
  <tr> 
   <td>相关属性</td> 
   <td>value(默认)，请求访问路径</td> 
  </tr> 
 </tbody> 
</table>

### 知识点3：@ResponseBody ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@ResponseBody</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解或方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器类或方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前控制器方法响应内容为当前返回值，无需解析</td> 
  </tr> 
 </tbody> 
</table>

### 入门案例总结 ###

*  一次性工作
    
     *  创建工程，设置服务器，加载工程；
     *  导入坐标；
     *  创建web容器启动类，加载SpringMVC配置，并设置SpringMVC请求拦截路径；
     *  SpringMVC核心配置类（设置配置类，扫描controller包，加载Controller控制器bean）；
 *  多次工作
    
     *  定义处理请求的控制器类；
     *  定义处理请求的控制器方法，并配置映射路径（@RequestMapping）与返回json数据（@ResponseBody）；

### 项目代码 ###

*  [gitee 代码下载][gitee]
 *  [github 代码下载][github]

[902d638f32e5449c8c591d0eb94e7c78.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/debf638a49ac4d89b17f8059cb248b57.png
[453549356c9949aeb22b211594687825.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/9fa4bcdb6d3844d9860ee6cb5a4e926f.png
[06db62c6d9594ca2b16f49389842c405.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/256ca892f4e14c7ca362fa46ea0aa1b8.png
[fd41257d69ab4e4099a6b8af4f47908b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/86672f2e16374a178f34a7f198da27e7.png
[d7615e0ba87140e68428b0b4c5019b4c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/19c9d70c67884d19bf03d30cd514c1aa.png
[7e15196f4c4547dd8024b6f5ada0c45a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/a17d9397c6554b159829260a4ad43e64.png
[168e8d2b0e0647639ef86fdbdd53c25d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/9418fcda6f8e4324b891759f5a2268f6.png
[e6c76cf7192e4f46828a6005e6e46f1f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/af97edb652104b1a9b01c0697a8bacb0.png
[c8427132564546d495caeeecf7af6015.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/54f80057b3ec4682b650ea65a12f19a0.png
[d6966b82ba5c4ddba486cbf47afb8e7c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/74d95668849d43dab8f54ce55d722640.png
[69562c76554449348918daf804b53614.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/1fe27f4a7a704bfb98ba2cfa77dd6427.png
[gitee]: https://gitee.com/DchuangDB/SpringMVCProject
[github]: https://github.com/dcbut/SpringMVCProject