SpringBoot中封装Cors自动配置方式

 更新时间:2025年03月31日 08:52:51   作者:catoop  
这篇文章主要介绍了SpringBoot中封装Cors自动配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

SpringBoot封装Cors自动配置

在现代 Web 开发中,跨域资源共享(CORS)是一个常见的问题。Spring Boot 提供了灵活的方式来处理 CORS 配置。

本文将介绍如何通过自动配置的方式,在 Spring Boot 应用程序中全局配置 CORS。

背景

当浏览器从一个域名的网页去请求另一个域名的资源时,会发生跨域请求。为了安全起见,默认情况下浏览器会阻止这种请求。因此,我们需要在服务器端进行适当的配置来允许这些跨域请求。

Spring Boot 提供了 CorsRegistryWebMvcConfigurer 接口来进行 CORS 配置。然而,如果我们希望在整个应用程序中统一管理 CORS 设置,可以考虑使用自动配置的方式。

实现步骤

我们将创建两个主要类:

  1. GlobalCorsProperties: 用于存储 CORS 的配置属性。
  2. GlobalCorsAutoConfiguration: 用于根据配置属性自动配置 CORS。

1. 创建 GlobalCorsProperties 类

这个类将负责读取配置文件中的 CORS 属性,并将其暴露给其他组件使用。

/**
 * Cors全局配置
 *
 * @author 单红宇
 * @since 2025/2/18 17:18
 */
@Data
@ConfigurationProperties("spring.web.globalcors")
public class GlobalCorsProperties {

    /**
     * 是否启用 CORS 全局配置
     */
    private boolean enabled = false;

    /**
     * CORS 配置映射
     */
    private final Map<String, CorsConfiguration> corsConfigurations = new LinkedHashMap<>();
}

2. 创建 GlobalCorsAutoConfiguration 类

这个类将在 Spring Boot 启动时根据 GlobalCorsProperties 中的配置来设置 CORS。

/**
 * 全局Cors配置
 *
 * @author 单红宇
 * @since 2025/2/18 17:33
 */
@AutoConfiguration
@Import(GlobalCorsProperties.class)
@ConditionalOnClass(SimpleUrlHandlerMapping.class)
@ConditionalOnProperty(name = "spring.web.globalcors.enabled", havingValue = "true")
public class GlobalCorsAutoConfiguration implements InitializingBean {

    /**
     * RequestMappingHandlerMapping 实例
     */
    @Autowired
    private RequestMappingHandlerMapping requestMappingHandlerMapping;

    @Override
    public void afterPropertiesSet() throws Exception {
        // 获取 GlobalCorsProperties 并设置 CORS 配置
        requestMappingHandlerMapping.setCorsConfigurations(SpringContextHolder.getApplicationContext()
                .getBean(GlobalCorsProperties.class).getCorsConfigurations());
    }
}

3. 配置 application.properties 文件

最后,我们在 application.properties 文件中添加相应的配置项。

spring.web.globalcors.enabled=true
spring.web.globalcors.cors-configurations.[/**].allow-credentials=true
spring.web.globalcors.cors-configurations.[/**].allowed-headers=*
spring.web.globalcors.cors-configurations.[/**].allowed-methods=GET,POST,PUT,DELETE,OPTIONS
spring.web.globalcors.cors-configurations.[/**].allowed-origin-patterns=http://localhost:3000
spring.web.globalcors.cors-configurations.[/**].max-age=1800

如果你把这个自动配置封装到自己的 starter 中,还需要将 GlobalCorsAutoConfiguration 类添加到

META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 

文件中。

总结

通过以上步骤,我们成功地在 Spring Boot 应用程序中实现了 CORS 的自动配置。

这种方式不仅简化了 CORS 的配置过程,还使得我们的代码更加模块化和易于维护。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringBoot ApplicationListener事件监听接口使用问题探究

    SpringBoot ApplicationListener事件监听接口使用问题探究

    这篇文章主要介绍了SpringBoot ApplicationListener事件监听接口使用问题,自定义监听器需要实现ApplicationListener接口,实现对应的方法来完成自己的业务逻辑。SpringBoot Application共支持6种事件监听
    2023-04-04
  • JVM性能调优之运行时参数小结

    JVM性能调优之运行时参数小结

    jvm是java的运行环境,在jvm中有很多的参数可以进行设置,本文主要介绍了JVM性能调优之运行时参数小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-04-04
  • SpringBoot@Profile注解和Spring EL(多环境注入)

    SpringBoot@Profile注解和Spring EL(多环境注入)

    为了方便, Spring还提供了 Profile机制, 使我们可以很方便地实现各个环境之间的切换,在使用DI来依赖注入的时候,能够根据@profile标明的环境,将注入符合当前运行环境的相应的bean,本文通过示例代码介绍SpringBoot@Profile注解和Spring EL,需要的朋友可以参考下
    2024-02-02
  • Java GUI进阶之流式布局管理器FlowLayout专项精讲

    Java GUI进阶之流式布局管理器FlowLayout专项精讲

    FlowLayout-流式布局管理器,按水平方向依次排列放置组件,排满一行,换下一行继续排列。排列方向(左到右 或 右到左)取决于容器的componentOrientation属性
    2022-04-04
  • Spring核心之IOC与bean超详细讲解

    Spring核心之IOC与bean超详细讲解

    IOC-Inversion of Control,即控制反转。它不是什么技术,而是一种设计思想。这篇文章将为大家介绍一下Spring控制反转IOC的原理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-10-10
  • SpringBoot项目运行jar包启动的步骤流程解析

    SpringBoot项目运行jar包启动的步骤流程解析

    这篇文章主要介绍了SpringBoot项目运行jar包启动的步骤流程,本文分步骤通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2020-07-07
  • springboot整合dubbo设置全局唯一ID进行日志追踪的示例代码

    springboot整合dubbo设置全局唯一ID进行日志追踪的示例代码

    这篇文章主要介绍了springboot整合dubbo设置全局唯一ID进行日志追踪,本文通过图文示例相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • Java compareTo用法详解

    Java compareTo用法详解

    在Java编程中,有时候我们需要对对象进行比较和排序,为了实现这一目标,Java提供了一个非常有用的接口叫做Comparable,以及一个重要的方法compareTo,下面我们就来看看compareTo的具体用法吧
    2023-09-09
  • java两个线程同时写一个文件

    java两个线程同时写一个文件

    这篇文章主要为大家详细介绍了java两个线程同时写一个文件,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08
  • Spring Boot和Kotlin的无缝整合与完美交融

    Spring Boot和Kotlin的无缝整合与完美交融

    这篇文章主要给大家介绍了关于Spring Boot和Kotlin的无缝整合与完美交融的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-06-06

最新评论