Servlet 与 Spring MVC

在开始介绍 Spring MVC 之前，我们需要先了解一下什么 Servlet。

Servlet

Servlet 是 Java 的一个规范，其提供了 Java 处理 HTTP 请求的能力，Servlet 是基于 Java 的 Web 开发的基础，通过自定义 Servlet 并继承 HttpServlet 可以处理 HTTP 请求。而在 MVC 的架构中， Servlet 通常可以看成时 Controller 层。

Spring MVC

Spring MVC 是 Spring 框架的一个模块，其提供了一个 MVC 的架构，可以帮助我们更好的开发 Web 应用。 Spring MVC 是基于 Servlet 的，其提供了一个 DispatcherServlet 来处理 HTTP 请求，DispatcherServlet 会根据请求的 URL 找到对应的 Controller 来处理请求，Controller 会返回一个 ModelAndView 对象， ModelAndView 对象包含了 Model 和 View，Model 用于存放数据，View 用于展示数据。但是在 Spring Boot 中 Controller 通常不会返回 ModelAndView 对象，而是直接返回一个对象，Spring Boot 会自动将对象转换为 JSON 格式返回给客户端。

DispatcherServlet

DispatcherServlet 是 Spring MVC 的核心，其继承自 HttpServlet，DispatcherServlet 会根据请求的 URL 找到对应的 Controller 来处理请求，DispatcherServlet 会根据请求的 URL 找到一个 HandlerMapping 对象， HandlerMapping 对象会根据请求的 URL 找到对应的 Controller，Controller 会返回一个 ModelAndView 对象， DispatcherServlet 会根据 ModelAndView 对象找到对应的 View 来展示数据。

不过在现在看来 Spring MVC 已经渐渐的失去了 V 的功能，Spring MVC 通常只用来处理 HTTP 请求，而 View 通常是前端框架来处理的，Spring Boot 通常会直接返回一个对象，Spring Boot 会自动将对象转换为 JSON 格式返回给客户端。

因此在介绍的时候不会完整恩介绍 Spring MVC 而是着重的介绍如何使用一些 Controller 层的注解。

Filters

Filters 是 Servlet 的一个规范，其可以用来处理 HTTP 请求，Filters 通常用来处理 HTTP 请求的 一些预处理和后处理，Filters 通常可以用来处理 HTTP 请求的编码，HTTP 请求的安全等。例如我们可以 Filter 只允许通过 Get 方法访问某个 URL，或者我们可以在 Filter 中对 HTTP 请求的编码进行处理。 同一个 URL 可以有多个 Filter，Filter 会按照 Filter 的 order 属性的值来执行，order 的值 越小越先执行。 Filter 运行在 DispatcherServlet 之前。

请求与多线程

在这里不得不介绍一下 Spring MVC 中处理请求的多线程问题，Spring MVC 是基于 Servlet 的，Servlet 是多线程的，Servlet 会为每一个请求创建一个线程来处理请求，因此在 Spring MVC 中处理请求的方法是多线程的， 而线程池是由 Tomcat (默认的 Web 服务器) 来管理的。

这也就涉及到了老生常谈的问题：Spring 与多线程的问题。Spring 本身对于多线程并没有什么特殊的处理， 且在使用单俐模式创建对象时，Spring 不是线程安全的，而在 Spring 处理请求的过程中，我们知道 Tomcat 会为每一个 HTTP 请求创建一个线程进行处理，因此在 Spring MVC 中处理请求的方法是多线程的，这会引发 线程安全的问题，但是在实际的过程中，大多数情况下不会出现线程安全问题，这又是为什么呢？

在实际处理一个请求的 Controller 类中，我们会发现出现的所有的变量都是局部变量，这样的类也被称为 无状态类，无状态类是线程安全的，因为每一个线程都会有自己的局部变量，不会出现线程安全的问题。但是对于 DAO 层的类，我们往往需要额外考虑线程安全的问题。

使用注解编写 Controller

@Controller

该注解用于标记一个类是 Controller 类，Spring 会自动扫描所有的 Controller 类，并将其注册到 Spring 容器中。

@RequestMapping

该注解用于标记一个方法处理的 URL，@RequestMapping 可以标记在类上，也可以标记在方法上，@RequestMapping 可以接受一个 URL，也可以接受一个 URL 的数组，@RequestMapping 还可以接受一些参数，例如：method、 consumes、produces、headers、params。

method 用于指定请求的方法，consumes 用于指定请求的 Content-Type，produces 用于指定返回的 Content-Type，headers 用于指定请求的头部信息，params 用于指定请求的参数。

但是，一般情况下我们并不直接使用 @RequestMapping 注解，而是使用以下几种衍生注解：

• @GetMapping 用于处理 GET 请求，等价于 @RequestMapping(method = RequestMethod.GET)
• @PostMapping 用于处理 POST 请求，等价于 @RequestMapping(method = RequestMethod.POST)
• @PutMapping 用于处理 PUT 请求，等价于 @RequestMapping(method = RequestMethod.PUT)
• @DeleteMapping 用于处理 DELETE 请求，等价于 @RequestMapping(method = RequestMethod.DELETE)

以下的几个例子展示了如何指定请求的 Content-Type、Accept、Headers、Params：

1. @GetMapping(path = '/test', consumes = 'application/json')
2. @GetMapping(path = '/test', headers = 'Content-Type=application/json')
3. @GetMapping(path = '/test', produces = 'application/json')
4. @GetMapping(path = '/test', headers = 'Accept=application/json')
5. @GetMapping(path = '/test', headers = 'MyHeader=myValue')
6. @GetMapping(path = '/test', params = 'myParam=myValue')

上述的例子中的第一条于第二条、第三条于第四条等价。也就是说对于 consumes 参数而言，只有当请求头中的 Content-Type 与 consumes 参数的值相同时，才会匹配成功，对于 produces 参数而言，只有当请求头中的 Accept 与 produces 参数的值相同时，才会匹配成功。Spring MVC 官方更加推荐使用 consumes 和 produces 参数来指定请求的 Content-Type 和 Accept。

其他的几个注解可以类似地使用 consumes、produces、headers、params 参数。

NOTE: 如果一个 Controller 的每个方法都需要指定 consumes、produces、headers、params 参数， 那么我们可以在 Controller 类上使用 consumes、produces、headers、params 参数，这样在 Controller 类中的每个方法都会默认使用这些参数，而如果某个方法需要不同的参数，那么可以在方法上覆盖这些参数。

接下来介绍一下 path 参数地模糊匹配规则：

• "?" 匹配一个字符。
• "*" 匹配一个路径下的任意字符。
• "**" 匹配一个或者多个路径下的任意字符。
• "/projects/{project}/versions" 匹配后将 project 的值传递给 @PathVariable 注解的参数。
• "/projects/{project:[a-z]+}/versions" 匹配后将 project 的值传递给 @PathVariable 注解的参数， 且 project 的值必须是小写字母。
• "/{name:[a-z-]+}-{version:\\d\\.\\d\\.\\d}{ext:\\.[a-z]+}" 匹配后将 name 的值传递给 @PathVariable 注解的参数，version 的值传递给 @PathVariable 注解的参数，ext 的值传递给 @PathVariable 注解的参数， name 的值必须是小写字母和 -，version 的值必须是 x.x.x 的格式，ext 的值必须是 . 开头的小写字母。

使用不同的注解获取参数

@RequestParam

对于一些方法，我们需要获取请求参数，而 @RequestParam 注解可以帮助我们从请求中获取参数 (也就是 ? 后面的参数)。@RequestParam 注解可以接受以下参数：

• value 或 name 用于指定参数的名称。
• required 用于指定参数是否必须，默认为 true。
• defaultValue 用于指定参数的默认值。

例如一个方法的参数被 @RequestParma("id") 修饰，而请求中包含 ?id=3 那么这个参数将会被填入 3。

NOTE: 通常对于一个没有任何注解标注的参数，其默认会通过 @RequestParam 注解来获取参数。

NOTE: 当该注解用于一个 Map 类型的参数时，Spring 会将所有的请求参数都填入这个 Map 中。

@RequestHeader

该注解用于获取请求头中的参数，@RequestHeader 注解可以接受以下参数：

• value 或 name 用于指定参数的名称。
• required 用于指定参数是否必须，默认为 true。
• defaultValue 用于指定参数的默认值。

NOTE: 当该注解用于一个 Map 类型的参数时，Spring 会将所有的请求参数都填入这个 Map 中。

@CookieValue

其实该注解也是用于获取请求头中的参数，只不过该注解往往标识获取 coockie 信息能够增加码的可读性。其 使用方法与 @RequestHeader 类似。

@PathVariable

该注解用于获取 URL 中的参数，@PathVariable 注解可以接受以下参数：

• value 用于指定参数的名称。
• required 用于指定参数是否必须，默认为 true。
• defaultValue 用于指定参数的默认值。

例如一个方法被 @GetMapping("/test/{id}") 修饰，其某个参数被 @PathVariable("id") 修饰，而请求中 为 /test/3 那么被修饰的参数将会填上 3。

NOTE: 当该注解用于一个 Map 类型的参数时，Spring 会将所有的请求参数都填入这个 Map 中。

@RequestPart

该注解用于获取请求中的 Multipart 参数，@RequestPart 注解可以接受以下参数：

• value 用于指定参数的名称。
• required 用于指定参数是否必须，默认为 true。

该注解一般用在 MultipartFile 类型的参数上，用于获取上传的文件。

@RequestBody

使用该注解可以获取请求体中的参数，@RequestBody 注解可以接受以下参数：

• required 用于指定参数是否必须，默认为 true。

该注解一般用于 POST 方法获取请求体中的参数。需要注意的是，@RequestBody 注解只能用于一个参数上， 其作用是将整个请求体封装到这个参数中。一般而言，对于 JSON 格式的请求体，Spring 会自动将其转换为 Java 对象，当然这得要求请求体中的键值对与 Java 对象的属性名一致。在两者不一致的时候，可以在 Java 对象的属性上使用 @JsonProperty 注解来指定键值对的键名。也可以使用 @JsonAlias 注解来指定多个键名， 但是这个注解必须要依赖于 setter 和 getter。

注意：在 Swagger 中也有一个注解 @RequestBody，其作用是指定请求体的格式，这两个注解是不同的。 在 import 的时候要注意引入正确的注解。

Controller 返回数据

@ResponseBody

该注解用于标记一个方法的返回值会放置到 HTTP 响应体中，Spring 会根据请求头中的 Accept 内容自动 选择合适的 HttpMessageConverter 转换返回值。当声明了 produces="application/json" 时，Spring 会自动选择 MappingJackson2HttpMessageConverter 来转换返回值。

@RestController

该注解是 @Controller 和 @ResponseBody 的组合。标明该类的所有方法都被 @ResponseBody 标注。

跨域问题

在通常的情况下，为了保护用户的数据，浏览器会限制跨域请求，也就是说浏览器不允许一个源向另一个源发送 请求。同一个源指的是协议、域名、端口号都相同。

而对于一个前后端分离的程序而言，其前端永远也不可能和后端在同一个源上，这也意味着：即使前端和后端程序 部署在同一个服务器上，但是由于端口不同，也会被浏览器拦截。

而对于浏览器的拦截策略，其往往有以下过程：

1. 浏览器向服务器发送一个 OPTIONS 请求，询问服务器是否允许跨域请求。
2. 服务器返回信息以说明是否允许跨域请求。
3. 当访问的域名没有被允许时，浏览器会拦截请求。否则，浏览器会发送真正的请求。

也就是说要解决跨域问题，我们只需要在服务端增加能够处理特定 OPTIONS 的请求，在对应的响应体中添加支持 跨域访问的 CORS 的头部信息即可。

Cross-Origin Resource Sharing 介绍了 CORS 是如何工作的，你可以阅读这篇文章以获取更加详细的信息。

在 Spring MVC 中解决跨域问题使容易的，因为 Spring MVC 为跨域问题做了内置的处理: 当收到一个 OPTIONS 请求时，Spring MVC 会寻找用户的跨域配置，如果找到了，那么 Spring MVC 会自动返回一个 CORS 的头部信息。 否则，Spring MVC 会直接拒绝。

使用 @CrossOrigin 解决局部跨域问题

该注解用于标注一个方法支持跨域请求，@CrossOrigin 注解可以接受以下参数：

• origins 用于指定允许跨域的源，可以是一个字符串数组。
• methods 用于指定允许跨域的方法，可以是一个字符串数组。
• allowedHeaders 用于指定允许跨域的头部信息，可以是一个字符串数组。
• exposedHeaders 用于指定允许跨域的头部信息，可以是一个字符串数组。
• allowCredentials 用于指定是否允许携带 cookie，默认为 false。
• maxAge 用于指定 OPTIONS 请求的缓存时间，单位为秒。

默认情况下，@CrossOrigin 注解会允许所有的跨域请求，并且支持所有头部信息，不允许携带 cookie，OPTIONS 请求的缓存时间为 1800 秒。

当然该注解可以标注在类上，用于标识该 Controller 的所有方法默认支持跨域请求。

使用 WebMvcConfigurer 解决全局跨域问题

在 Spring MVC 中可以通过添加一个如下的配置类为全局配置代理：

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/api/**")
            .allowedOrigins("https://domain2.com")
            .allowedMethods("PUT", "DELETE")
            .allowedHeaders("header1", "header2", "header3")
            .exposedHeaders("header1", "header2")
            .allowCredentials(true).maxAge(3600);

        // Add more mappings...
    }
}

使用 Filter 来解决跨域问题

在前面的介绍中我们提到了跨域要允许跨域只需要对特定的 OPTIONS 请求返回 CORS 的头部信息即可，而我们 介绍了 Filter 可以用来处理 HTTP 请求的预处理和后处理，因此我们可以使用 Filter 来处理跨域问题。 而 Spring MVC 中默认提供了一个类型为 CorFilter 的过滤器用于处理跨域问题，我们只需要在 Spring 的 IoC 容器中注册这个过滤器即可：

@Configuration
@EnableWebMvc
public class CorsConfig {
    @Bean
    public CorsFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        CorsConfiguration config = new CorsConfiguration();
        config.setAllowCredentials(true);
        config.addAllowedOrigin("http://localhost:3000");
        config.addAllowedHeader("*");
        config.addAllowedMethod("*");
        source.registerCorsConfiguration("/**", config);
        return new CorsFilter(source);
    }
}

在更改 Spring MVC 的配置的时候需要增加 @EnableWebMvc 注解。

@ResponseStatus @SessionAttributes @ModelAttribute @InitBinder @ExceptionHandler @ControllerAdvice @CrossOrigin