Java跨域问题的几种后端解决方式

文章目录

• Java跨域问题解决方式
• • 一、什么是跨域
  • 二、常见跨域举例
  • 三、Java后端解决方式
  • • 1、实现 WebMvcConfigurer
    • 2、实现 HandlerInterceptor
    • 3、使用Filter
    • 4、使用 @CrossOrigin 注解来实现
    • 5、在响应头中添加 Access-Control-Allow-Origin 等字段
    • 6、使用 Nginx 配置
    • 7、配置 Gateway 的路由

Java跨域问题解决方式

一、什么是跨域

跨域指的是：浏览器不能执行其他网站的脚本，从一个域名的网页去请求另一个域名的资源时，域名、端口、协议任一不同，都是跨域。跨域是由浏览器的同源策略造成的，是浏览器施加的安全限制。a页面想获取b页面资源，如果a、b页面的协议、域名、端口、子域名不同，所进行的访问行动都是跨域的。

二、常见跨域举例

三、Java后端解决方式

1、实现 WebMvcConfigurer

@Configuration
public class CorsConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")// 拦截所有的请求
            .allowedOrigins("*")// 可跨域的域名，*为所有
            .allowCredentials(true)
            .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")// 允许跨域的方法，可以单独配置
            .maxAge(3600);
    }
}

2、实现 HandlerInterceptor

创建一个类实现 HandlerInterceptor 接口，并在 preHandle 方法中设置响应头以实现跨域。

@Component
public class CorsInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setHeader("Access-Control-Allow-Origin", "http://example.com");
        response.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");
        response.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        return true;
    }
    // ...
}
```

这将允许来自 http://example.com 的跨域请求访问应用程序中的 API。

3、使用Filter

创建一个类实现 javax.servlet.Filter 接口，并在 doFilter 方法中设置响应头以实现跨域。

@WebFilter
public class CorsFilter implements Filter {
    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
        HttpServletResponse response = (HttpServletResponse) res;
        response.setHeader("Access-Control-Allow-Origin", "http://example.com");
        response.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");
        response.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        chain.doFilter(req, res);
    }
    // ...
}
````

这将允许来自 http://example.com 的跨域请求访问应用程序中的 API。

注意：使用 Filter 实现跨域时，Filter 会拦截所有请求，而不仅仅是跨域请求。因此，在设置响应头时需要谨慎，避免影响其他请求的正常处理。如果需要更细粒度的控制，可以考虑使用 @CrossOrigin 注解或拦截器来实现。

4、使用 @CrossOrigin 注解来实现

在使用 Spring Boot 实现跨域时，可以使用 Spring 提供的 @CrossOrigin 注解来配置跨域访问。具体实现步骤如下：

（1）在需要实现跨域的 Controller 类或方法上添加 @CrossOrigin 注解。例如：

@CrossOrigin(origins = "http://example.com")
@RestController
public class MyController {
    // ...
}
```

这将允许来自 http://example.com 的跨域请求访问 MyController 中的方法。

（2）如果需要允许多个域名访问，可以将 origins 参数设置为包含所有允许访问的域名的数组。例如：

@CrossOrigin(origins = {"http://example1.com", "http://example2.com"})
@RestController
public class MyController {
    // ...
}
```

（3）如果需要允许跨域的 HTTP 方法不止 GET 和 POST，可以使用 methods 参数指定允许的方法列表。例如：

@CrossOrigin(origins = "http://example.com", methods = {RequestMethod.GET, RequestMethod.POST})
@RestController
public class MyController {
    // ...
}
```

（4）如果需要允许跨域的请求头不止 Content-Type，可以使用 allowedHeaders 参数指定允许的请求头列表。例如：

@CrossOrigin(origins = "http://example.com", allowedHeaders = {"Content-Type", "Authorization"})
@RestController
public class MyController {
    // ...
}
```

（5）如果需要允许发送身份验证信息，可以使用 allowCredentials 参数将其设置为 true。例如：

@CrossOrigin(origins = "http://example.com", allowCredentials = "true")
@RestController
public class MyController {
    // ...
}
```

5、在响应头中添加 Access-Control-Allow-Origin 等字段

（1）在响应头中添加 Access-Control-Allow-Origin 字段，允许特定的域名访问。例如，以下代码将允许 http://example.com 的域名访问 API：

response.setHeader("Access-Control-Allow-Origin", "http://example.com");
```
    
如果希望允许所有域名访问 API，可以将值设置为 *：

（2）如果需要允许多个域名访问 API，可以在响应头中添加 Access-Control-Allow-Origin 字段，并将其设置为包含所有允许访问的域名的列表。例如：

response.setHeader("Access-Control-Allow-Origin", "http://example1.com, http://example2.com");
```

（3）如果需要允许跨域的 HTTP 方法不止 GET 和 POST，可以在响应头中添加 Access-Control-Allow-Methods 字段，指定允许的方法列表。例如：

response.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");
```

（4）如果需要允许跨域的请求头不止 Content-Type，可以在响应头中添加 Access-Control-Allow-Headers 字段，指定允许的请求头列表。例如：

response.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
```

（5）如果使用了带有身份验证信息的请求，例如带有 Cookie 的请求，那么需要在响应头中添加 Access-Control-Allow-Credentials 字段，并将其设置为 true，表示允许发送身份验证信息。例如：

response.setHeader("Access-Control-Allow-Credentials", "true");
```

最后，需要将这些响应头添加到每个需要跨域访问的 API 的响应中。

6、使用 Nginx 配置

location / {
   add_header Access-Control-Allow-Origin *;
   add_header Access-Control-Allow-Headers X-Requested-With;
   add_header Access-Control-Allow-Methods GET,POST,PUT,DELETE,OPTIONS;

   if ($request_method = 'OPTIONS') {
     return 204;
   }
}

如果使用了带有身份验证信息的请求，例如带有 Cookie 的请求，那么需要将 Access-Control-Allow-Credentials 字段设置为 true，表示允许发送身份验证信息。例如：

add_header 'Access-Control-Allow-Credentials' 'true';

如果在 Nginx 的 upstream 中使用了负载均衡，需要在负载均衡的服务器块中添加以上配置。如果使用了反向代理，也需要在反向代理的服务器块中添加以上配置。

7、配置 Gateway 的路由

- id: my_route
  uri: http://localhost:8080
  predicates:
    - Path=/api/**
  filters:
    - RewritePath=/api/(?<segment>.*), /$\{segment}
    - AddResponseHeader=Access-Control-Allow-Origin:http://example.com
    - AddResponseHeader=Access-Control-Allow-Methods:GET, POST, PUT, DELETE
    - AddResponseHeader=Access-Control-Allow-Headers:Content-Type, Authorization
    - AddResponseHeader=Access-Control-Allow-Credentials:true
`````

这将允许来自 http://example.com 的跨域请求访问 Gateway 中的 API。

如果使用了带有身份验证信息的请求，例如带有 Cookie 的请求，那么需要将 Access-Control-Allow-Credentials 字段设置为 true，表示允许发送身份验证信息。例如：

- AddResponseHeader=Access-Control-Allow-Credentials:true
`````

最后，需要将这些配置添加到每个需要跨域访问的 API 的路由配置中。

需要注意的是，如果在 Gateway 的路由中使用了负载均衡，需要在负载均衡的路由配置中添加以上配置。如果使用了反向代理，也需要在反向代理的路由配置中添加以上配置。