Spring Boot 中解决跨域的多种方式

默语

发布于 2024-11-20 15:53:12

14700

代码可运行

文章被收录于专栏：JAVAJAVA

运行总次数：0

代码可运行

《踏过跨域障碍：Spring Boot 中解决跨域的多种方式》

摘要

在开发Web应用时，经常会遇到跨域问题，这给开发者带来了不少困扰。在本文中，我将探讨Spring Boot中解决跨域问题的几种常见方式，包括使用@CrossOrigin注解、自定义WebMvcConfigurer以及使用Filter进行跨域配置。通过深入了解这些方法，我们能够更好地解决跨域问题，保证应用的稳定性和安全性。

引言

跨域问题是指在Web开发中，当一个域（domain）的JavaScript代码去请求另一个域的资源时，浏览器会出于安全考虑阻止这种跨域的行为。在开发过程中，经常会遇到前端与后端不在同一个域的情况，因此跨域问题就显得尤为重要。

正文

何为跨域

跨域是指在浏览器中，一个域下的JavaScript代码试图访问另一个域下的资源时所遇到的限制。这种限制是由同源策略（Same-Origin Policy）所引起的。同源策略要求浏览器只能在同一个域中加载页面和执行脚本，而不能跨域进行操作。

跨域问题出现特征

跨域问题通常表现为浏览器的跨域安全限制，导致前端页面无法获取或操作来自其他域的资源。这可能导致页面功能无法正常工作，或者出现安全漏洞。

方式一：使用 @CrossOrigin 注解

在Spring Boot中，可以通过在Controller类或方法上添加@CrossOrigin注解来解决跨域问题。这个注解可以指定允许跨域访问的域名、方法、头部信息等。

@CrossOrigin(origins = "*")//允许所有来源的请求跨域
@RestController
public class MyController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

这种方式解决跨域需要在每个控制器上加注解，属于重复劳动对于不需要精确控制的场景属于重复劳动。可以看下下面方式

方式二：自定义 WebMvcConfigurer

另一种解决跨域问题的方式是通过自定义WebMvcConfigurer来配置跨域策略。这种方式更加灵活，可以针对不同的路径进行不同的跨域配置。

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

/**
 * 跨域配置类。
 * 允许所有路径的跨域请求。
 * 配置允许的源地址、请求方法和请求头。
 * 
 * @author mijiupro
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    /**
     * 配置跨域映射。
     * 
     * @param registry 跨域注册表
     */
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**") // 对所有路径生效
                .allowedOrigins("*") // 允许所有源地址
                // .allowedOrigins("https://mijiupro.com","https://mijiu.com ") // 允许的源地址（数组）
                .allowedMethods("GET", "POST", "PUT", "DELETE") // 允许的请求方法
                .allowedHeaders("*"); // 允许的请求头
    }
}

这种方式实现了全局的配置，但是无法细腻到控制某个方法

方式三：使用 Filter 进行跨域配置

除了以上两种方式外，还可以通过自定义Filter来处理跨域请求。这种方式可以更加灵活地控制跨域策略，适用于更复杂的跨域场景。

import jakarta.servlet.*;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;

import java.io.IOException;

/**
 * 跨域过滤器。
 * 用于处理跨域请求。
 * 
 * @author mijiupro
 */
@Component
public class CorsFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 将 ServletResponse 转换为 HttpServletResponse
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        // 设置允许跨域请求的源地址
        httpResponse.setHeader("Access-Control-Allow-Origin", "https://mijiupro.com");

        // 设置允许的请求方法
        httpResponse.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");

        // 设置允许的请求头
        httpResponse.setHeader("Access-Control-Allow-Headers", "*");

        // 继续执行 Filter 链
        chain.doFilter(request, response);
    }
}