使用Springboot处理跨域的方式

 更新时间:2024年09月05日 08:39:33   作者:码农研究僧  
这篇文章主要介绍了使用Springboot处理跨域的方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

1. 基本知识

跨域指的是在一个域下的网页试图访问另一个域下的资源

由于浏览器的同源策略,默认情况下,JavaScript 只能在相同的域中进行请求

跨域通常涉及以下概念:

  • Origin: 包括协议、域名和端口号
    比如 http://example.com:80
  • Same-Origin Policy: 浏览器的安全策略,限制一个源的文档或脚本如何能与另一个源的资源进行交互
  • CORS: 允许跨域请求的机制
    服务器通过设置特定的响应头来告知浏览器哪些源是允许访问的

在 Spring Boot 中,处理跨域的方式有几种,以下是主要的几种方式:

  • 使用 @CrossOrigin 注解: 这种方式较为简单,适用于控制器层
  • 配置全局跨域设置: 这种方式适用于全局配置,可以在 Web 配置类中设置
  • 自定义 CorsConfiguration: 适用于更复杂的跨域配置需求,可以在配置类中自定义

以下为Demo示例

2. @CrossOrigin

可以在控制器类或方法上添加 @CrossOrigin 注解

注解的参数可以配置允许的源(origins)、允许的请求方法(methods)、允许的请求头(allowedHeaders)、是否允许凭证(allowCredentials)等

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyController {

    @CrossOrigin(origins = "http://example.com")
    @GetMapping("/data")
    public String getData() {
        return "Data from server";
    }
}

如果不使用 @CrossOrigin 注解,浏览器会阻止跨域请求,因为默认的同源策略不允许不同源之间的请求

3. 全局跨域设置

配置 WebMvcConfigurer 来全局设置跨域

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

/**
 * 配置类,用于全局设置 CORS(跨域资源共享)配置
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    /**
     * 配置跨域请求的映射规则
     * 
     * @param registry 用于注册 CORS 配置的注册表
     */
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        // 添加跨域映射规则
        registry.addMapping("/**")  // 允许所有路径的跨域请求
                .allowedOrigins("http://example.com")  // 允许来自 http://example.com 的跨域请求
                .allowedMethods("GET", "POST", "PUT", "DELETE")  // 允许的请求方法
                .allowedHeaders("*")  // 允许所有请求头
                .allowCredentials(true);  // 允许携带凭证(如 Cookies)
    }
}

4. 自定义 CorsConfiguration

import org.springframework.context.annotation.Bean;
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 CustomCorsConfig implements WebMvcConfigurer {

    @Bean
    public CorsConfigurationSource corsConfigurationSource() {
        CorsConfiguration configuration = new CorsConfiguration();
        configuration.setAllowedOrigins(Arrays.asList("http://example.com"));
        configuration.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "DELETE"));
        configuration.setAllowedHeaders(Arrays.asList("*"));
        configuration.setAllowCredentials(true);

        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", configuration);

        return source;
    }
}

5. 实战

以下展示项目中的跨域

用 @AutoConfiguration 进行自动配置

实现WebMvcConfigurer 接口,并通过 FilterRegistrationBean 注册自定义的跨域过滤器 CorsFilter 和其他过滤器

import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.CorsFilter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;

@Configuration
@AutoConfiguration
@EnableConfigurationProperties(WebProperties.class)
public class WebAutoConfiguration implements WebMvcConfigurer {

    /**
     * 创建一个 CorsFilter 过滤器的 Bean,配置跨域设置
     *
     * @return 配置了跨域设置的 FilterRegistrationBean
     */
    @Bean
    public FilterRegistrationBean<CorsFilter> corsFilterBean() {
        // 创建 CorsConfiguration 对象
        CorsConfiguration config = new CorsConfiguration();
        config.setAllowCredentials(true);  // 允许携带凭证(如 Cookies)
        config.addAllowedOriginPattern("*"); // 允许所有来源的请求(注意:生产环境中通常不建议使用 *,应具体配置允许的域)
        config.addAllowedHeader("*"); // 允许所有请求头
        config.addAllowedMethod("*"); // 允许所有 HTTP 方法(GET, POST, PUT, DELETE 等)

        // 创建 UrlBasedCorsConfigurationSource 对象
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", config); // 对所有路径配置跨域设置

        // 创建并返回一个 FilterRegistrationBean 实例,注册 CorsFilter
        return createFilterBean(new CorsFilter(source), Integer.MIN_VALUE);
    }

    /**
     * 创建 DemoFilter Bean,演示模式
     * 
     * @return 配置了 DemoFilter 的 FilterRegistrationBean
     */
    @Bean
    @ConditionalOnProperty(value = "demo", havingValue = "true")
    public FilterRegistrationBean<DemoFilter> demoFilter() {
        // 创建并返回一个 FilterRegistrationBean 实例,注册 DemoFilter
        return createFilterBean(new DemoFilter(), Integer.MIN_VALUE);
    }

    /**
     * 创建 FilterRegistrationBean 实例的通用方法
     * 
     * @param filter 需要注册的过滤器实例
     * @param order  过滤器的执行顺序
     * @return 配置了过滤器的 FilterRegistrationBean 实例
     */
    public static <T extends Filter> FilterRegistrationBean<T> createFilterBean(T filter, Integer order) {
        FilterRegistrationBean<T> bean = new FilterRegistrationBean<>(filter);
        bean.setOrder(order);  // 设置过滤器的顺序
        return bean;
    }
}

总结

处理方式适用场景配置位置灵活性配置难度
@CrossOrigin 注解单个控制器或方法控制器层
全局配置(WebMvcConfigurer)全局设置配置类(WebConfig)
自定义 CorsConfiguration复杂跨域需求配置类(CustomCorsConfig)

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

相关文章

  • 简单了解Java关键字throw和throws的区别

    简单了解Java关键字throw和throws的区别

    这篇文章主要介绍了简单了解Java关键字throw和throws的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 本地MinIO存储服务Java远程调用上传文件的操作过程

    本地MinIO存储服务Java远程调用上传文件的操作过程

    MinIO是一款高性能、分布式的对象存储系统,它可以100%的运行在标准硬件上,即X86等低成本机器也能够很好的运行MinIO,这篇文章主要介绍了本地MinIO存储服务Java远程调用上传文件的操作过程,需要的朋友可以参考下
    2023-11-11
  • Springboot实现根据用户ID切换动态数据源

    Springboot实现根据用户ID切换动态数据源

    在很多具体应用场景中,我们需要用到动态数据源的情况,比如多租户的场景,系统登录时需要根据用户信息切换到用户对应的数据库。这篇文章主要介绍了SpringBoot根据用户ID实现切换动态数据源的示例代码,感兴趣的可以了解一下
    2021-12-12
  • SpringAop源码及调用过程概述

    SpringAop源码及调用过程概述

    这篇文章主要介绍了SpringAop源码及调用过程概述,Spring AOP(面向切面编程)是Spring框架的一个重要特性,它提供了一种在程序运行期间动态地将额外的行为织入到代码中的方式,需要的朋友可以参考下
    2023-10-10
  • Mybatis实现分页的注意点

    Mybatis实现分页的注意点

    Mybatis提供了强大的分页拦截实现,可以完美的实现分功能。下面小编给大家分享小编在使用拦截器给mybatis进行分页所遇到的问题及注意点,需要的朋友一起看看吧
    2017-07-07
  • JavaWeb中Servlet的深入理解

    JavaWeb中Servlet的深入理解

    Java Servlet 是运行在 Web 服务器或应用服务器上的程序,它是作为来自 Web 浏览器或其他 HTTP 客户端的请求和 HTTP 服务器上的数据库或应用程序之间的中间层
    2021-10-10
  • java实现建造者模式(Builder Pattern)

    java实现建造者模式(Builder Pattern)

    这篇文章主要为大家详细介绍了java实现建造者模式Builder Pattern,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-10-10
  • SpringBoot监听事件和处理事件程序示例详解

    SpringBoot监听事件和处理事件程序示例详解

    这篇文章主要介绍了SpringBoot监听事件和处理事件程序示例,监听和处理事件是一种常用的模式,用于在应用程序的不同部分之间传递信息,Spring 的事件发布/订阅模型允许我们创建自定义事件,并在这些事件发生时由注册的监听器进行处理,需要的朋友可以参考下
    2022-06-06
  • java正则表达式表单验证类工具类(验证邮箱、手机号码、qq号码等)

    java正则表达式表单验证类工具类(验证邮箱、手机号码、qq号码等)

    这篇文章主要介绍了java使用正则表达式进行表单验证工具类,可以验证邮箱、手机号码、qq号码等方法,需要的朋友可以参考下
    2014-04-04
  • JavaCV实现多个MP4视频的合并

    JavaCV实现多个MP4视频的合并

    这篇文章主要为大家详细介绍了如何使用javacv和ffmpeg框架实现简单快速的合并mp4文件的视频和音频,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-10-10

最新评论