SpringBoot轻松解决CORS跨域难题

使用 Spring Boot 处理 CORS 跨域请求

简介

在现代网络应用中，跨域资源共享 (CORS) 是至关重要的。它允许来自不同域的客户端与服务器端资源进行通信，这在诸如基于 AJAX 的 Web 应用和跨域服务调用等场景中尤为常见。Spring Boot 为处理 CORS 跨域请求提供了多种方式，本文将深入探讨这些方法并提供实用的解决方案。

方法一：使用注解

注解是 Spring Boot 中处理 CORS 的最便捷方式。只需在需要处理跨域请求的控制器方法上添加 @CrossOrigin 注解即可。以下是一个示例：

@CrossOrigin
@GetMapping("/api/users")
public List<User> getAllUsers() {
    return userRepository.findAll();
}

添加了 @CrossOrigin 注解后，该控制器方法将允许来自任何域的跨域请求。

方法二：使用 Web 过滤器

另一种方法是使用 Web 过滤器。需要在 web.xml 文件中配置过滤器，如下所示：

<filter>
    <filter-name>CorsFilter</filter-name>
    <filter-class>org.springframework.web.filter.CorsFilter</filter-class>
    <init-param>
        <param-name>allowedOrigins</param-name>
        <param-value>*</param-value>
    </init-param>
    <init-param>
        <param-name>allowedMethods</param-name>
        <param-value>GET, POST, PUT, DELETE</param-value>
    </init-param>
    <init-param>
        <param-name>allowedHeaders</param-name>
        <param-value>Content-Type, Accept, X-Requested-With, Authorization</param-value>
    </init-param>
    <init-param>
        <param-name>exposedHeaders</param-name>
        <param-value>Content-Type, Accept, X-Requested-With, Authorization</param-value>
    </init-param>
</filter>

<filter-mapping>
    <filter-name>CorsFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

配置好过滤器后，所有请求的 CORS 问题都将得到处理。

方法三：在代码中显式设置 HTTP 头

最后一种方法需要在代码中显式设置 HTTP 头。以下是一个示例：

@PostMapping("/api/users")
public User createUser(@RequestBody User user) {
    User savedUser = userRepository.save(user);

    // 设置 HTTP 头
    HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getResponse();
    response.setHeader("Access-Control-Allow-Origin", "*");
    response.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");
    response.setHeader("Access-Control-Allow-Headers", "Content-Type, Accept, X-Requested-With, Authorization");
    response.setHeader("Access-Control-Expose-Headers", "Content-Type, Accept, X-Requested-With, Authorization");

    return savedUser;
}

设置好 HTTP 头后，该请求的跨域问题将得到解决。

常见的 CORS 错误处理

在使用 Spring Boot 处理 CORS 跨域请求时，可能会遇到以下几种错误：

• 403 Forbidden： 服务器拒绝请求，可能是因为请求的资源没有授权。
• 404 Not Found： 请求的资源不存在，可能是因为请求的路径不正确。
• 500 Internal Server Error： 服务器内部错误，可能是因为服务器发生了错误。

解决这些错误的步骤包括：

1. 检查请求的路径是否正确。
2. 检查请求的方法是否正确。
3. 检查请求的 HTTP 头是否正确。
4. 检查服务器是否正常运行。
5. 检查服务器的防火墙是否允许请求通过。

常见问题解答

• 为什么跨域请求被阻止？
  跨域请求被阻止是为了防止恶意脚本和攻击访问敏感数据。CORS 机制通过限制不同域之间的资源共享来确保安全性。

• 如何确定请求是否跨域？
  当请求的源域与目标域不同时，请求被认为是跨域的。

• 哪些 HTTP 头与 CORS 相关？
  重要的 CORS 相关的 HTTP 头包括：

  • Access-Control-Allow-Origin：指定允许访问资源的域。
  • Access-Control-Allow-Methods：指定允许用于访问资源的 HTTP 方法。
  • Access-Control-Allow-Headers：指定允许在请求中发送的 HTTP 头。
  • Access-Control-Expose-Headers：指定允许在响应中公开的 HTTP 头。

• 如何启用 preflight 请求？
  对于复杂请求（例如 POST、PUT、DELETE），浏览器会先发送一个 preflight 请求来获取服务器的 CORS 政策。可以通过使用 @CrossOrigin 注解或在代码中设置 HTTP 头来启用 preflight 请求。

• 如何处理 CORS 错误？
  CORS 错误可以通过检查请求是否有效、服务器是否正常运行以及防火墙是否允许请求通过来处理。