开发者

Springboot处理跨域的实现方式(附Demo)

目录
  • Springboot处理跨域的方式
    • 1. 基本知识
    • 2. @CrossOrigin
    • 3. 全局跨域设置
    • 4. 自定义 CorsConfiguration
    • 5. 实战
  • 总结

    Springboot处理跨域的方式

    1. 基本知识

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

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

    跨域通常涉及以下概念:

    • Origin: 包括协议、域名和端口号

      比如 http://example.com:80

    • Same-Origin Policy: 浏览器的安全策略,限制一个源的文档或脚本如何能与另一个源的资源进行交互
    • CORS: 允许跨域请求的机制

      服务器通过设置特定的响应头来告知浏览器哪些源是允许访问的

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

    1. 使用 @CrossOrigin 注解: 这种方式较为简单,适用于控制器层
    2. 配置全局跨域设置: 这种方式适用于全局配置,可以在 Web 配置类中设置
    3. 自定义 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.annotawww.devze.comtion.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 = newjavascript UrlBasedCorsConfigurationSource();
            source.registerCorsConfiguration("/**", configuration);
    
            return source;
        }
    }

    5. 实战

    以下展示项目中的跨域

    用 @AutoConfiguration 进行自动配置

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

    import org.springframework.boot.autoconfigure.AutoConfiguration;
    imwww.devze.comport 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(WebProperti编程客栈es.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); // 对所有路径配置跨域设置
    
            // 创建并返回一个 FilterR编程客栈egistrationBean 实例,注册 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)

    以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程客栈(www.devze.com)。

    0

    上一篇:

    下一篇:

    精彩评论

    暂无评论...
    验证码 换一张
    取 消

    最新开发

    开发排行榜