当前位置：首页 > article >正文

十七：Spring Boot （2）-- spring-boot-starter-web 依赖详解

article 2024/11/16 19:27:41

1. spring-boot-starter-web 简介

1.1 作用与功能：

1.2 引入方式：

1.3 包含的核心依赖：

2. 自动配置原理

3. 内嵌 Servlet 容器

3.1 默认 Tomcat 配置：

3.2 替换容器（Jetty 或 Undertow）：

4. 构建 RESTful Web 服务：

4.1 什么是 RESTful Web 服务

4.2 创建 REST 控制器

5. 自动处理 JSON：

6. 静态资源支持

7. Web 配置定制（通过 WebMvcConfigurer）

7.1 注册拦截器（Interceptor）

7.2 配置静态资源处理

7.2.1 addResourceHandlers(ResourceHandlerRegistry registry) 方法

7.2.2 registry.addResourceHandler("/assets/**")

7.2.3 addResourceLocations("classpath:/static/assets/")

7.3 配置视图解析器（ViewResolver）

7.3.1 pom.xml 加两个引用支持jsp 的

7.3.2 配置视图解析器

7.3.3 创建jsp页面

7.3.4 写controller 一定用@Controller

7.3.4 浏览器访问乱码无所谓只要能请求到就没大问题

7.3.5 工作原理

7.4 CORS 配置（跨域资源共享）

7.4.1 什么是跨域？

7.4.2 为什么会有跨域问题？

7.4.3 同源策略（Same-Origin Policy）

7.4.4 跨域的场景

7.4.5 浏览器的跨域限制

7.4.6 跨域的解决方案

7.4.6.1 CORS（跨域资源共享）

7.4.6.2 JSONP（仅限 GET 请求）

7.4.6.3 服务器端代理（推荐）

7.5 消息转换器（Message Converters）

7.8 定制异常处理（@ExceptionHandler）（不推荐）

8. 支持文件上传与下载

8.1 文件上传

8.1.1 配置文件上传的基本设置

8.1.2 实现文件上传接口

8.1.3 上传目录配置

8.1.4 上传多个文件

8.2 文件下载

8.2.1 实现文件下载接口

8.2.2 设置响应头部以下载文件

1. spring-boot-starter-web 简介
- 1.1 作用与功能：
  - spring-boot-starter-web 是 Spring Boot 的一个启动器（starter），用于构建 Web 应用，它自动配置了多种常见的 Web 组件，尤其适合构建 RESTful Web 服务。
- 1.2 引入方式：
  - Maven：在 pom.xml 中添加：
    - ```
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
```
- Gradle：在 build.gradle 中添加：
  - ```
  implementation 'org.springframework.boot:spring-boot-starter-web'
```
- 1.3 包含的核心依赖：
  - Spring MVC：构建 Web 应用的基础框架，提供了控制器、视图解析等功能。
  - 内嵌 Servlet 容器（Tomcat）：提供一个内嵌的默认 Servlet 容器，简化部署。
  - Jackson：用于 JSON 数据的序列化和反序列化。
  - Spring Boot 自动配置：自动配置 DispatcherServlet，自动配置 Spring MVC 相关的功能。
2. 自动配置原理
- DispatcherServlet 自动配置：
  - Spring Boot 会自动配置 DispatcherServlet，它是 Spring MVC 的核心，用于路由请求到适当的控制器方法。
- Spring MVC 相关的自动配置：
  spring-boot-starter-web 自动配置了 Spring MVC 所需的 MessageConverter、视图解析器等，简化了手动配置。
- Tomcat 自动配置：
  默认情况下，spring-boot-starter-web 使用 Tomcat 作为嵌入式容器，你可以通过配置改变容器（如使用 Jetty 或 Undertow）。
3. 内嵌 Servlet 容器
- 3.1 默认 Tomcat 配置：
  - 默认内嵌容器是 Tomcat，并且默认端口是 8080。
  - 可以通过 application.properties 或 application.yml 修改端口：
    - ```
    server.port=8081
```
- 3.2 替换容器（Jetty 或 Undertow）：
  - 如果你不想使用 Tomcat，可以排除它并使用 Jetty 或 Undertow：
  - 排除 Tomcat：
    - ```
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <scope>provided</scope>
    </dependency>
```
- 添加 Jetty 或 Undertow：
  - ```
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-jetty</artifactId>
  </dependency>
```
4. 构建 RESTful Web 服务：
- 4.1 什么是 RESTful Web 服务
  - REST（Representational State Transfer）是一种通过 HTTP 协议与 Web 服务交互的架构风格。RESTful Web 服务遵循一系列约定，通常使用 HTTP 方法（如 GET、POST、PUT、DELETE）来进行资源的创建、查询、更新和删除操作。每个资源通常由一个 URL 唯一标识，且资源的数据通常以 JSON 返回。
- 4.2 创建 REST 控制器
  - 在 Spring Boot 中，构建 RESTful 服务的核心是 @RestController 注解。@RestController 是一个结合了 @Controller 和 @ResponseBody 注解的注解，表示该类是一个控制器，且返回的内容会自动以 JSON 或 XML 格式返回（根据客户端请求的 Accept 头）。
  - ```
  package com.example.demo.controller;
  
  import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.RequestMapping;
  import org.springframework.web.bind.annotation.RestController;
  
  @RestController
  @RequestMapping("/api")
  public class HelloController {
  
      @GetMapping("/hello")
      public String hello() {
          return "Hello, World!";
      }
  }
```
- @RestController：表示该类是一个 REST 控制器，返回数据会被自动序列化为 JSON 格式。
- @RequestMapping("/api")：为所有请求添加一个基础路径 /api。
- @GetMapping("/hello")：处理 GET 请求，当客户端访问 /api/hello 时，返回 "Hello, World!"。
- @PostMapping：处理 HTTP POST 请求，用于创建新用户。
- @PutMapping：处理 HTTP PUT 请求，用于更新用户信息。
- @DeleteMapping：处理 HTTP DELETE 请求，用于删除用户。
5. 自动处理 JSON：
- spring-boot-starter-web 默认集成了 Jackson 序列化和反序列化，自动将 Java 对象与 JSON 数据进行转换。
- 你可以使用 @RequestBody 注解接收请求体中的 JSON 数据，使用 @ResponseBody 返回 JSON 数据。
6. 静态资源支持
- 默认情况下，Spring Boot 会从 /static、/public、/resources 和 /META-INF/resources 目录提供静态资源。
- 可以将静态文件（如 HTML、CSS、JavaScript、图片等）放入这些目录中，Spring Boot 会自动提供访问。
- 自定义静态资源路径：
  - 可以通过配置文件修改静态资源的根目录
  - ```
  spring.resources.static-locations=classpath:/custom-static/
```

7. Web 配置定制（通过 `WebMvcConfigurer`）

在开发 Spring Web 应用时，WebMvcConfigurer 是一个非常常用的接口，它提供了一种灵活的方式来定制 Spring MVC 的行为。