Web on Servlet Stack version 5.3.1 中文翻译

àì夳堔傛蜴生んèń 2022-12-23 11:17 9阅读 0赞

原文地址：https://docs.spring.io/spring-framework/docs/current/reference/html/web.html\#spring-web

### 目录 ###

*   *   *  1.1.11. Multipart Resolver
         *   *  Apache Commons FileUpload
         *  1.3.2. 请求映射
         *   *  方法参数
         *  1.3.3. 处理方法
         *   *  Multipart

### 1.1.11. Multipart Resolver ###

来自 `org.springframework.web.multipart` 包的 `MultipartResolver` 是一种用于解析包括文件上传在内的多部分请求的策略。有一种是基于 `Commons FileUpload` 的实现，另一种是基于Servlet 3.0多部分请求解析的实现。

要启用 `multipart` 处理，您需要在 `DispatcherServlet` Spring配置中声明一个名为 `multipartResolver` 的 `MultipartResolver` bean。`DispatcherServlet` 检测到它并将其应用到传入请求。 当接收到 content-type 为 `multipart/form-data` 的 POST 时，解析器解析内容并将当前 `HttpServletRequest` 包装为 `MultipartHttpServletRequest`，以提供对解析部分的访问，此外还将它们作为请求参数公开。

#### Apache Commons FileUpload ####

要使用 Apache Commons `FileUpload`，可以配置 `CommonsMultipartResolver` 类型的bean，名称为 `multipartResolver`。您还需要将 `commons-fileupload` 作为 classpath 的依赖项。

### 1.3.2. 请求映射 ###

您可以使用 @RequestMapping 注解将请求映射到控制器方法。它有各种属性来匹配URL、HTTP方法、请求参数、头和媒体类型。您可以在类级别使用它来表示共享映射，也可以在方法级别使用它来缩小到特定的端点映射。

也有HTTP方法特有的快捷方式 @RequestMapping:

@GetMapping
    
    @PostMapping
    
    @PutMapping
    
    @DeleteMapping
    
    @PatchMapping

快捷方式是 定制注解，因为与使用 @RequestMapping 相比，大多数控制器方法都应该映射到特定的HTTP方法，而 @RequestMapping 在默认情况下与所有HTTP方法匹配。同时，在类级别上仍然需要 @RequestMapping 来表示共享映射。

下面的示例具有类型级和方法级映射:

@RestController
    @RequestMapping("/persons")
    class PersonController { 
    
        @GetMapping("/{id}")
        public Person getPerson(@PathVariable Long id) { 
            // ...
        }
    
        @PostMapping
        @ResponseStatus(HttpStatus.CREATED)
        public void add(@RequestBody Person person) { 
            // ...
        }
    }

#### 方法参数 ####

下一个表描述了受支持的控制器方法参数。任何参数都不支持响应型类型。

JDK 8 的 `java.util.Optional` 作为一种方法参数被支持与具有 `required` 属性的注解(例如，`@RequestParam`， `@RequestHeader`等)相结合，并且等价于 `required=false`。

<table> 
 <thead> 
  <tr> 
   <th>控制器方法参数</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>WebRequest</code>, <code>NativeWebRequest</code></td> 
   <td>对请求参数和请求和会话属性的通用访问，而不直接使用Servlet API。</td> 
  </tr> 
  <tr> 
   <td><code>javax.servlet.ServletRequest</code>, <code>javax.servlet.ServletResponse</code></td> 
   <td>选择任何特定的请求或响应类型-例如，<code>ServletRequest</code>, <code>HttpServletRequest</code>，或Spring的<code>MultipartRequest</code>, <code>MultipartHttpServletRequest</code>。</td> 
  </tr> 
 </tbody> 
</table>

### 1.3.3. 处理方法 ###

#### Multipart ####

在[启用][Link 1]了 `MultipartResolver` 之后，使用`multipart/form-data` 的 POST 请求的内容将被解析并作为常规请求参数进行访问。下面的例子访问一个常规的表单字段和一个上传的文件:

@Controller
    public class FileUploadController { 
    
        @PostMapping("/form")
        public String handleFormUpload(@RequestParam("name") String name,
                @RequestParam("file") MultipartFile file) { 
    
            if (!file.isEmpty()) { 
                byte[] bytes = file.getBytes();
                // store the bytes somewhere
                return "redirect:uploadSuccess";
            }
            return "redirect:uploadFailure";
        }
    }

将参数类型声明为 `List<MultipartFile>` 允许为相同的参数名解析多个文件。

当 `@RequestParam`注解被声明为 `Map<String, MultipartFile>` 或 `MultiValueMap<String, MultipartFile>`，而没有在注释中指定参数名时，那么映射将为每个给定参数名填充多部分文件。

> 使用Servlet 3.0多部分解析，您还可以声明 `javax.servlet.http.Part` 代替 Spring 的`MultipartFile`，作为方法参数或集合值类型。

您还可以使用多部分内容作为到[命令对象][Link 2]的数据绑定的一部分。例如，前面例子中的表单字段和文件可以是表单对象上的字段，如下面的例子所示:

class MyForm { 
    
        private String name;
    
        private MultipartFile file;
    
        // ...
    }
    
    @Controller
    public class FileUploadController { 
    
        @PostMapping("/form")
        public String handleFormUpload(MyForm form, BindingResult errors) { 
            if (!form.getFile().isEmpty()) { 
                byte[] bytes = form.getFile().getBytes();
                // store the bytes somewhere
                return "redirect:uploadSuccess";
            }
            return "redirect:uploadFailure";
        }
    }

[Link 1]: https://blog.csdn.net/ksdb0468473/article/details/110096022#1111_Multipart_Resolver_2
[Link 2]: https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-modelattrib-method-args