Spring Boot实现跨域访问控制的方法

RIOM • 2024-10-26 11:54 • 编程

一、前言

在现代web应用中，跨域访问是很常见的场景，例如前后端分离的项目中，前端使用ajax请求后端RESTful API时，由于请求是从不同的域名下发出的，就会涉及到跨域问题。如果不做特殊处理，很可能会导致请求失败。

Spring Boot是一套快速开发框架，为了方便开发者解决跨域问题，提供了一种简单的解决方案。本文将围绕Spring Boot实现跨域访问控制的方法展开讲解，帮助读者快速解决跨域问题。

二、什么是跨域访问

跨域访问是指在浏览器中，一个网页的脚本试图访问另一个页面中的资源。这里的“跨域”指的是“源”或“域名”，即两个网页使用的域名不同。如果两个域名相同，就不会存在跨域问题。遇到跨域问题，浏览器会抛出一个异常。

在JavaScript中，由于浏览器的同源策略（Same Origin Policy），只有在同一域名、端口和协议下的网页才能相互访问对方的数据。在跨域场景下，这种限制就会被启用，因此只有在目标服务器允许跨域访问时，才能在当前网页中进行资源访问。

三、Spring Boot跨域访问控制方法

为了实现跨域访问，Spring Boot提供了CorsFilter，开发者只需要在Spring Boot的配置文件（application.yml或application.properties）中设置以下属性：

spring:
  cors:
    allowed-origins: "*",    # 允许所有来源访问，如果需要特定的来源访问，可以指定具体的域名。
    allowed-methods: "*",    # 允许所有请求方法访问，如果需要特定的请求方法，可以指定。
    allowed-headers: "*",    # 允许所有请求头访问，如果需要特定的请求头，可以指定。
    allow-credentials: true  # 允许携带cookie访问，需要在ajax中将withCredentials设置为true。

注意，这里需要将配置文件中的属性设置在spring.cors下，表示为跨域访问提供支持。

四、实际代码示例

以下代码演示了如何在Spring Boot中使用CorsFilter解决跨域访问问题。

1、创建一个Spring Boot项目，添加Maven依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

2、在application.yml或application.properties中配置CorsFilter：

spring:
  cors:
    allowed-origins: "*"
    allowed-methods: "*"
    allowed-headers: "*"
    allow-credentials: true

3、创建一个RestController，在其中添加一个返回Json数据的接口：

@RestController
public class DemoController {

    @RequestMapping("/demo")
    public Map demo() {
        Map result = new HashMap();
        result.put("msg", "Hello, world!");
        return result;
    }

}

4、在前端使用ajax请求接口数据：

<script>
    $.ajax({
        url: "http://localhost:8080/demo",
        type: "get",
        dataType: "json",
        xhrFields: {
            withCredentials: true
        },
        success: function(data) {
            alert("请求成功，返回数据：" + JSON.stringify(data));
        },
        error: function() {
            alert("请求失败！");
        }
    });
</script>

使用以上代码，即可在浏览器中发送一个跨域请求，并成功获取到数据。

五、总结

Spring Boot提供了CorsFilter这个方便的跨域访问解决方案。只需要在配置文件中设定相关属性，就能够轻松地应对跨域问题。同时，在前端开发中需要注意使用xhrFields将withCredentials设置为true，以允许携带cookie进行跨站访问。

原创文章，作者：RIOM，如若转载，请注明出处：https://www.506064.com/n/144987.html