当前位置:首页 > 技术分析 > 正文内容

深入剖析 Spring Boot 3 解决跨域问题的实用方案

ruisui884个月前 (03-07)技术分析12

在当今互联网大厂的软件开发流程中,Spring Boot 3 作为一款广泛应用的开发框架,其解决跨域问题的能力对于保障项目的顺利推进至关重要。随着前后端分离架构的普及,跨域请求已成为开发过程中频繁遭遇的挑战。本文将深入探讨 Spring Boot 3 解决跨域问题的多种实用方案,帮助广大互联网大厂开发人员更好地应对这一难题。

跨域问题的本质与产生原因

跨域问题源于浏览器的同源策略。所谓同源,即两个页面的协议、主机和端口号完全一致。一旦这三者中的任何一个不同,就会触发跨域问题。例如,当前端页面部署在
http://app.example.com:8080,而后端服务运行在
https://api.example.com:8443时,浏览器会阻止前端页面直接向该后端服务发起请求,因为协议、端口号以及可能存在的主机名差异均不符合同源要求。

同源策略的存在是为了保护用户的信息安全,防止恶意网站通过脚本获取其他网站的敏感数据。然而,在实际开发中,尤其是在微服务架构盛行的今天,不同服务往往部署在不同的域名、端口甚至协议下,这就不可避免地导致了跨域请求的需求。

Spring Boot 3 解决跨域问题的常见方法

使用@CrossOrigin注解

@CrossOrigin注解是 Spring 框架提供的一种便捷方式来处理跨域请求。它可以直接应用于 Controller 类或具体的请求处理方法上。

当将@CrossOrigin注解应用于 Controller 类时,该 Controller 下的所有请求处理方法都将支持跨域请求。例如:

@RestController
@RequestMapping("/user")
@CrossOrigin(origins = "*")
public class UserController {
    // 具体业务逻辑方法
}

上述代码中,@CrossOrigin(origins = "*")表示允许来自任何源的跨域请求。在实际应用中,为了安全性考虑,建议将origins属性设置为具体的允许来源,如@CrossOrigin(origins = "http://allowed-origin.com")。

若将@CrossOrigin注解应用于单个请求处理方法,则只有该方法支持跨域请求,示例如下:

@RestController
@RequestMapping("/user")
public class UserController {
    @GetMapping("/{id}")
    @CrossOrigin(origins = "http://specific-origin.com")
    public User getUserById(@PathVariable Long id) {
        // 获取用户信息逻辑
    }
}

全局配置 CORS

通过创建一个配置类实现WebMvcConfigurer接口,并覆盖addCorsMappings方法,可以进行全局的 CORS(Cross-Origin Resource Sharing)配置。

以下是一个典型的全局 CORS 配置示例:

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class CorsConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
               .allowedOrigins("*")
               .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
               .allowedHeaders("*")
               .allowCredentials(true)
               .maxAge(3600);
    }
}

在上述配置中:

  • addMapping("/**")表示对所有请求路径都进行跨域配置。
  • allowedOrigins("*")允许所有来源的请求,实际应用中应替换为具体的允许来源。
  • allowedMethods指定了允许的 HTTP 请求方法。
  • allowedHeaders允许所有请求头,同样在实际应用中可根据需求进行限制。
  • allowCredentials(true)表示允许携带凭证(如 Cookie)。
  • maxAge(3600)设置预检请求的有效期为 3600 秒。

使用 Filter 实现 CORS

通过自定义 Filter 也可以实现对跨域请求的处理。首先创建一个实现Filter接口的类,然后在该类中编写跨域处理逻辑。

示例代码如下:

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class CorsFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletResponse httpResponse = (HttpServletResponse) response;
        httpResponse.setHeader("Access-Control-Allow-Origin", "*");
        httpResponse.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS");
        httpResponse.setHeader("Access-Control-Allow-Headers", "*");
        httpResponse.setHeader("Access-Control-Max-Age", "3600");
        chain.doFilter(request, response);
    }
}

上述代码中,在doFilter方法中设置了跨域相关的响应头。需要注意的是,在实际应用中,同样应将
Access-Control-Allow-Origin设置为具体的允许来源,以提高安全性。

接下来,需要将该 Filter 注册到 Spring 容器中,可通过配置类实现:

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterRegistrationConfig {
    @Bean
    public FilterRegistrationBean corsFilterRegistrationBean() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new CorsFilter());
        registrationBean.addUrlPatterns("/*");
        return registrationBean;
    }
}

不同方法的适用场景与优缺点

@CrossOrigin注解

适用场景:适用于对个别 Controller 或方法进行跨域设置,尤其是在项目初期,对跨域需求不太明确,需要逐步调整的情况下。

优点:使用简单,灵活度高,可以针对不同的 Controller 或方法进行细粒度的跨域配置。

缺点:如果项目中有大量的 Controller 和方法需要进行跨域配置,使用该注解会导致代码冗余。同时,由于注解分散在各个 Controller 类中,不利于统一管理和维护。

全局配置 CORS

适用场景:适用于整个项目对跨域请求的规则较为统一的情况,例如前后端分离的项目,前端域名固定,后端所有接口都需要支持从该前端域名发起的跨域请求。

优点:配置集中,易于管理和维护。通过一次配置,即可对整个项目的跨域请求进行统一处理,避免了代码冗余。

缺点:灵活性相对较低,对于某些特殊的 Controller 或方法,如果需要单独设置不同的跨域规则,可能无法满足需求。

使用 Filter 实现 CORS

适用场景:适用于对跨域请求的处理逻辑有特殊需求,需要在 Filter 中进行一些额外处理的情况,例如在处理跨域请求的同时,记录请求日志等。

优点:可以在 Filter 中编写自定义的处理逻辑,满足特定的业务需求。同时,Filter 的注册和配置相对简单。

缺点:如果项目中已经存在大量的 Filter,可能会导致 Filter 链过长,影响性能。此外,由于 Filter 是基于 Servlet 规范的,与 Spring 框架的集成度不如前两种方法高。

总结

跨域问题是互联网大厂开发人员在使用 Spring Boot 3 进行开发时不可避免会遇到的挑战。通过本文介绍的@CrossOrigin注解、全局配置 CORS 以及使用 Filter 实现 CORS 等多种方法,开发人员可以根据项目的实际需求和特点,选择合适的解决方案。同时,在实际应用中,应注意安全性、性能优化和兼容性等问题,以确保项目的稳定运行。希望本文能够为广大开发人员在解决 Spring Boot 3 跨域问题时提供有益的参考和帮助。

扫描二维码推送至手机访问。

版权声明:本文由ruisui88发布,如需转载请注明出处。

本文链接:http://www.ruisui88.com/post/2567.html

分享给朋友:

“深入剖析 Spring Boot 3 解决跨域问题的实用方案” 的相关文章

Lindroid开源应用:在安卓手机 / 平板上安装 Linux发行版

IT之家 6 月 19 日消息,Erfan Abdi 本月发布了 Lindroid 开源应用程序,让用户可以在安卓手机上安装 GNU / Linux 发行版,在完全支持手机硬件的情况下可以运行 Linux 应用程序。Lindroid 开源应用程序就是将 Linux 放入容器中,使用 Halium 等...

BuildKit 镜像构建工具

#暑期创作大赛#快速开始 对于 Kubernetes 部署,请参阅examples/kubernetes。BuildKit 由buildkitd守护进程和buildctl客户端组成。虽然buildctl客户端可用于 Linux、macOS 和 Windows,但buildkitd守护程序目前仅适用于...

全新斯柯达柯珞克Karoq深度评测:大众替代品

“斯柯达柯珞克是一款出色的全能家庭 SUV,具有许多有用的功能”价格36,605 英镑- 49,190 英镑优点方便的 VarioFlex 后排座椅非常适合家庭入住驾驶乐趣缺点保修期短保守的内饰性格比Yeti少结论——斯柯达柯珞克是一辆好车吗?斯柯达柯珞克是在辉煌的七座 斯柯达柯迪亚克之后推出的,因...

VUE-router

七.Vue-router1、什么是vue-routervue-router是vue.js官方路由管理器。vue的单页应用是基于路由和组件的,路由用于设定访问路径,并将路径和组件映射起来。传统页面切换是用超链接a标签进行切换。但vue里是用路由,因为我们用Vue做的都是单页应用,就相当于只有一个主的i...

前端路由简介以及vue-router实现原理

作者:muwoo 来源:https://zhuanlan.zhihu.com/p/37730038后端路由简介路由这个概念最先是后端出现的。在以前用模板引擎开发页面时,经常会看到这样http://www.xxx.com/login 大致流程可以看成这样:浏览器发出请求服务器监听到80 端口(或443...

vue.js 双向绑定如何理解,有什么好处!#云南小程序开发

Vue.js 的双向数据绑定是借助于 JavaScript 的一些特性,如对象的属性 getter 和 setter 以及 Vue 的依赖追踪系统实现的。简单来说,双向数据绑定就是数据与视图间的双向通信,也就是说数据的改变会马上反映到视图中,视图的改变也会立刻改变数据。具体来说,当你改变了数据时,视...