Java实战：Spring Boot中实现跨域

本文将详细介绍在Spring Boot中实现跨域的方法，包括使用Spring Boot的@CrossOrigin注解、配置WebMvcConfigurer、使用过滤器、使用全局异常处理以及使用第三方库。通过本文，我们将了解到跨域的基本概念，并能够将这些知识应用到实际项目中。

一、引言

在现代Web应用中，经常需要实现前后端分离的开发模式。在这种模式下，前端和后端分别部署在不同的域上，这就导致了跨域请求的问题。跨域请求是指从一个域下的页面请求另一个域下的资源。在Spring Boot中，我们可以通过多种方式来解决跨域问题。

二、跨域的基本概念

1. 什么是跨域？
跨域是指从一个域下的页面请求另一个域下的资源。由于浏览器的同源策略，默认情况下，Web应用只能访问与当前页面同源的资源。因此，跨域请求在浏览器中默认是被禁止的。
2. 跨域的常见场景

• 前端和后端分离的开发模式：前端通常部署在不同的域下，后端也部署在不同的域下。
• 前后端不使用同一套接口：前端和后端分别使用不同的接口，可能部署在不同的域下。
• 第三方服务调用：在实际应用中，我们可能需要调用第三方服务，这些服务可能部署在不同的域下。

三、Spring Boot实现跨域的五种方式

1. 使用@CrossOrigin注解
在Spring Boot中，我们可以使用@CrossOrigin注解来标记一个控制器或方法，使其允许跨域请求。下面是一个示例代码：

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
    @CrossOrigin(origins = "http://localhost:8080")
    @GetMapping("/hello")
    public String hello() {
        return "Hello, world!";
    }
}

2. 配置WebMvcConfigurer
除了使用@CrossOrigin注解，我们还可以通过实现WebMvcConfigurer接口来全局配置跨域。下面是一个示例代码：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/hello").allowedOrigins("http://localhost:8080");
    }
}

3. 使用过滤器
我们还可以通过实现OncePerRequestFilter接口来创建一个过滤器，用于处理跨域请求。下面是一个示例代码：

import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.FilterChain;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class CorsFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        response.setHeader("Access-Control-Allow-Origin", "http://localhost:8080");
        filterChain.doFilter(request, response);
    }
}

4. 使用全局异常处理
我们还可以通过实现Advice接口来创建一个全局异常处理类，用于处理跨域请求。下面是一个示例代码：

import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import javax.servlet.http.HttpServletRequest;
public class CorsExceptionHandler extends ResponseEntityExceptionHandler {
    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        request.getRequestURI();
        return new ResponseEntity<>("Invalid request", HttpStatus.BAD_REQUEST);
    }
}

5. 使用第三方库
除了使用Spring Boot内置的跨域处理方式，我们还可以使用第三方库来实现跨域请求。例如，我们可以使用cors-filter这个库来实现跨域。首先，我们需要在项目的pom.xml文件中添加cors-filter的依赖：

<dependency>
    <groupId>com.thetransactioncompany</groupId>
    <artifactId>cors-filter</artifactId>
    <version>9.0.0</version>
</dependency>

然后，我们可以在Spring Boot的配置类中添加CorsFilter的Bean：

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;
@Configuration
public class WebConfig {
    @Bean
    public CorsFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        CorsConfiguration config = new CorsConfiguration();
        config.setAllowCredentials(true);
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        config.addAllowedMethod("*");
        source.registerCorsConfiguration("/**", config);
        return new CorsFilter(source);
    }
}

四、总结

通过本文的介绍，我们了解了在Spring Boot中实现跨域的方法。方法分别是：使用@CrossOrigin注解、配置WebMvcConfigurer、使用过滤器、使用全局异常处理以及使用第三方库。每种方法都有其优缺点，我们可以根据实际项目的需求来选择合适的方法来实现跨域。
需要注意的是，实际项目中可能需要根据具体业务需求进行调整。在实际开发过程中，我们需要考虑安全性、性能和兼容性等因素，以确保跨域请求的正确处理。