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 的配置过程,还使得我们的代码更加模块化和易于维护。

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

相关文章

  • Java 反射机制的实例详解

    Java 反射机制的实例详解

    这篇文章主要介绍了Java 反射机制的实例详解的相关资料,希望通过本文能帮助到大家,让大家理解掌握反射机制,需要的朋友可以参考下
    2017-10-10
  • Java后台实现微信支付和微信退款

    Java后台实现微信支付和微信退款

    这篇文章主要介绍了Java后台实现微信支付和微信退款,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • 通过Java 程序获取Word中指定图片的坐标位置

    通过Java 程序获取Word中指定图片的坐标位置

    本文介绍通过Java程序获取Word文档中指定图片的坐标位置,程序运行环境是jdk1.8开发环境idea,通过java程序代码给大家介绍的非常详细,需要的朋友参考下吧
    2021-05-05
  • 浅谈@mapper引入不到引入的是@MapperScan的问题

    浅谈@mapper引入不到引入的是@MapperScan的问题

    这篇文章主要介绍了浅谈@mapper引入不到引入的是@MapperScan的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • Java常用数字工具类 数字转汉字(1)

    Java常用数字工具类 数字转汉字(1)

    这篇文章主要为大家详细介绍了Java常用数字工具类,数字转汉字,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • Spring Boot Security认证之Redis缓存用户信息详解

    Spring Boot Security认证之Redis缓存用户信息详解

    本文介绍了如何使用Spring Boot Security进行认证,并通过Redis缓存用户信息以提高系统性能,通过配置RedisUserDetailsManager,我们成功地将用户信息存储到了Redis中,并在Spring Security中进行了集成,需要的朋友可以参考下
    2024-01-01
  • Spring和SpringMVC扫描注解类冲突的解决方案

    Spring和SpringMVC扫描注解类冲突的解决方案

    这篇文章主要介绍了Spring和SpringMVC扫描注解类冲突的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • springboot整合mybatis-plus逆向工程的实现

    springboot整合mybatis-plus逆向工程的实现

    这篇文章主要介绍了springboot整合mybatis-plus逆向工程的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • RestClient 通过拦截器实现请求加密的示例

    RestClient 通过拦截器实现请求加密的示例

    本文介绍了如何通过拦截器实现请求加密,并通过RestClient优化了加密过程,传统的加密方法依赖对象转换和序列化处理,容易导致加密不一致或难以调试的问题,通过引入拦截器,可以直接操作请求体,避免了不必要的转换步骤,确保加密过程与请求体完全一致,感兴趣的朋友一起看看吧
    2025-02-02
  • SpringBoot项目application.yml文件数据库配置密码加密的方法

    SpringBoot项目application.yml文件数据库配置密码加密的方法

    这篇文章主要介绍了SpringBoot项目application.yml文件数据库配置密码加密的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03

最新评论