springboot实现跨域的五种方式总结

更新时间：2024年01月26日 11:31:52 作者：Charo n.

在Spring Boot中实现跨域,可以采用全局跨域和局部跨域两种方式,下面这篇文章主要给大家介绍了关于springboot实现跨域的五种方式,文中通过代码介绍的非常详细,需要的朋友可以参考下

一、为什么会出现跨域问题

出于浏览器的同源策略限制。同源策略（Sameoriginpolicy）是一种约定，它是浏览器最核心也最基本的安全功能，如果缺少了同源策略，则浏览器的正常功能可能都会受到影响。可以说Web是构建在同源策略基础之上的，浏览器只是针对同源策略的一种实现。

同源策略同源策略会阻止一个域的javascript脚本和另外一个域的内容进行交互。所谓同源（即指在同一个域）就是两个页面具有相同的协议（protocol），主机（host）和端口号（port）

二、什么是跨域

当一个请求url的协议、域名、端口三者之间任意一个与当前页面url不同即为跨域

三、非同源限制

【1】无法读取非同源网页的 Cookie、LocalStorage 和 IndexedDB

【2】无法接触非同源网页的 DOM

【3】无法向非同源地址发送 AJAX 请求

四、java 后端实现 CORS 跨域请求的方式

对于 CORS的跨域请求，主要有以下几种方式可供选择：

返回新的CorsFilter
重写 WebMvcConfigurer
使用注解 @CrossOrigin
手动设置响应头 (HttpServletResponse)
自定web filter 实现跨域

注意

CorFilter / WebMvConfigurer / @CrossOrigin 需要 SpringMVC 4.2以上版本才支持，对应springBoot 1.3版本以上
上面前两种方式属于全局 CORS 配置，后两种属于局部 CORS配置。如果使用了局部跨域是会覆盖全局跨域的规则，所以可以通过 @CrossOrigin 注解来进行细粒度更高的跨域资源控制。
其实无论哪种方案，最终目的都是修改响应头，向响应头中添加浏览器所要求的数据，进而实现跨域

1.返回新的 CorsFilter(全局跨域)

在任意配置类，返回一个新的 CorsFIlter Bean ，并添加映射路径和具体的CORS配置路径。

@Configuration
public class GlobalCorsConfig {
    @Bean
    public CorsFilter corsFilter() {
        //1. 添加 CORS配置信息
        CorsConfiguration config = new CorsConfiguration();
        //放行哪些原始域
        config.addAllowedOrigin("*");
        //是否发送 Cookie
        config.setAllowCredentials(true);
        //放行哪些请求方式
        config.addAllowedMethod("*");
        //放行哪些原始请求头部信息
        config.addAllowedHeader("*");
        //暴露哪些头部信息
        config.addExposedHeader("*");
        //2. 添加映射路径
        UrlBasedCorsConfigurationSource corsConfigurationSource = new UrlBasedCorsConfigurationSource();
        corsConfigurationSource.registerCorsConfiguration("/**",config);
        //3. 返回新的CorsFilter
        return new CorsFilter(corsConfigurationSource);
    }
}

2. 重写 WebMvcConfigurer(全局跨域)

@Configuration
public class CorsConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                //是否发送Cookie
                .allowCredentials(true)
                //放行哪些原始域
                .allowedOrigins("*")
                .allowedMethods(new String[]{"GET", "POST", "PUT", "DELETE"})
                .allowedHeaders("*")
                .exposedHeaders("*");
    }
}

3.使用注解 (局部跨域)

在控制器(类上)上使用注解 @CrossOrigin:，表示该类的所有方法允许跨域。

@RestController
@CrossOrigin(origins = "*")
public class HelloController {
    @RequestMapping("/hello")
    public String hello() {
        return "hello world";
    }
}

在方法上使用注解 @CrossOrigin:

@RequestMapping("/hello")
    @CrossOrigin(origins = "*")
     //@CrossOrigin(value = "http://localhost:8081") //指定具体ip允许跨域
    public String hello() {
        return "hello world";
    }

4. 手动设置响应头(局部跨域)

使用 HttpServletResponse 对象添加响应头(Access-Control-Allow-Origin)来授权原始域，这里 Origin的值也可以设置为 “*”,表示全部放行。

@RequestMapping("/index")
public String index(HttpServletResponse response) {
    response.addHeader("Access-Allow-Control-Origin","*");
    return "index";
}

5. 使用自定义filter实现跨域

ssm中的写法首先编写一个过滤器，可以起名字为MyCorsFilter.java

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
@Component
public class MyCorsFilter implements Filter {
  public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
    HttpServletResponse response = (HttpServletResponse) res;
    response.setHeader("Access-Control-Allow-Origin", "*");
    response.setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE");
    response.setHeader("Access-Control-Max-Age", "3600");
    response.setHeader("Access-Control-Allow-Headers", "x-requested-with,content-type");
    chain.doFilter(req, res);
  }
  public void init(FilterConfig filterConfig) {}
  public void destroy() {}
}

在web.xml中配置这个过滤器，使其生效

<!-- 跨域访问 START-->
<filter>
    <filter-name>CorsFilter</filter-name>
    <filter-class>com.mesnac.aop.MyCorsFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>CorsFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<!-- 跨域访问 END  -->

springboot可以简化

import org.springframework.context.annotation.Configuration;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebFilter(filterName = "CorsFilter ")
@Configuration
public class CorsFilter implements Filter {
    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
        HttpServletResponse response = (HttpServletResponse) res;
        response.setHeader("Access-Control-Allow-Origin","*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        response.setHeader("Access-Control-Allow-Methods", "POST, GET, PATCH, DELETE, PUT");
        response.setHeader("Access-Control-Max-Age", "3600");
        response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
        chain.doFilter(req, res);
    }
}

再提一句，在springboot中配置跨域时，出现

When allowCredentials is true, allowedOrigins cannot contain the special value “*” since that cannot be set on the “Access-Control-Allow-Origin” response header. To allow credentials to a set of origins, list them explicitly or consider using “allowedOriginPatterns” instead.

但该做的跨域配置都做了，还是跨域失败，有可能是这个原因

springboot升级成2.4.0以上时对AllowedOrigin设置发生了改变，不能有”*“

所以在CorsConfig类中修改AllowedOrigin为AllowedOriginPattern

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @ClassName CorsConfig
 * @Description TODO
 * @Author Charon.Wang
 * @Date 2023/1/12 14:14
 * @Version 1.0
 **/

/**
 * 前后端跨域
 * @author Charon.Wang
 */
@Configuration
public class CorsConfig {

    /**
    * 当前跨域请求最大有效时长。这里默认1天
    */
    private static final long MAX_AGE = 24 * 60 * 60;

    @Bean
    public CorsFilter corsFilter() {
        //1. 添加 CORS配置信息
        CorsConfiguration config = new CorsConfiguration();
        //放行哪些原始域
        //config.addAllowedOrigin("*");
        //原本是addAllowedOrigin,改为addAllowedOriginPattern
        config.addAllowedOriginPattern("*"); 
        //是否发送 Cookie
        config.setAllowCredentials(true);
        //放行哪些请求方式
        config.addAllowedMethod("*");
        //放行哪些原始请求头部信息
        config.addAllowedHeader("*");
        //暴露哪些头部信息
        config.addExposedHeader("*");
        //2. 添加映射路径
        UrlBasedCorsConfigurationSource corsConfigurationSource = new UrlBasedCorsConfigurationSource();
        corsConfigurationSource.registerCorsConfiguration("/**",config);
        //3. 返回新的CorsFilter
        return new CorsFilter(corsConfigurationSource);
    }
}

总结

到此这篇关于springboot实现跨域的五种方式的文章就介绍到这了,更多相关springboot实现跨域内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中JWT(JSON Web Token)的运用具体案例
这篇文章主要介绍了Java中JWT(JSON Web Token)的运用具体案例,JWT（JSON Web Token）是一种开放标准,用于在网络应用环境中安全地传递信息,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-11-11
如何获取所有spring管理的bean
这篇文章主要介绍了如何获取所有spring管理的bean，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
详解Java中二分法的基本思路和实现
二分法是一个非常高效的算法，它常常用于计算机的查找过程中。本文将通过示例为大家详细讲讲二分法的基本思路和实现，感兴趣的可以了解一下
2022-08-08
Java设计模式之备忘录模式使用详解
这篇文章主要介绍了Java设计模式中备忘录模式的使用,备忘录设计模式也叫作快照模式,主要用于实现防丢失、撤销、恢复等功能,本文将通过示例为大家讲解备忘录模式的定义与使用,需要的同学可以参考一下
2024-02-02
解决Springboot项目中很多页面出现Whitelabel Error Page(404)的问题
最近在接手的前后端项目中发现其默认路径不是主机+端口（如：http://localhost:3453/）的形式,很多页面的访问是加了一个层级,只要访问页面就会出现Whitelabel Error Page(404),所以本文给大家提供了解决方案,需要的朋友可以参考下
2024-02-02
springboot多节点应用里的雪花算法唯一性详解
雪花算法在单节点下唯一,但在多副本Kubernetes环境中可能重复,通过修改Pod名称生成workId,解决了这个问题,同时避免了第三方组件和网络请求,本文给大家介绍springboot多节点应用里的雪花算法唯一性,感兴趣的朋友一起看看吧
2024-12-12
JSP 开发之hibernate的hql查询多对多查询
这篇文章主要介绍了JSP 开发之hibernate的hql查询多对多查询的相关资料,希望通过本文能帮助到大家，需要的朋友可以参考下
2017-09-09
java对ArrayList排序代码示例
本文通过代码示例给大家介绍java对arraylist排序，代码简洁易懂，感兴趣的朋友一起学习吧
2015-11-11
Java基于深度优先遍历的随机迷宫生成算法
今天小编就为大家分享一篇关于Java基于深度优先遍历的随机迷宫生成算法，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-02-02
SpringCloud服务接口调用OpenFeign及使用详解
这篇文章主要介绍了SpringCloud服务接口调用——OpenFeign,在学习Ribbon时，服务间调用使用的是RestTemplate+Ribbon实现，而Feign在此基础上继续进行了封装，使服务间调用变得更加方便，需要的朋友可以参考下
2023-04-04