SpringBoot CORS 跨域 @CrossOrigin

Posted 2023-04-30

参考技术A 跨源资源共享(Cross-origin resource sharing, CORS)是由大多数浏览器实现的W3C规范，它允许您以灵活的方式指定哪种跨域请求被授权，而不是使用一些不太安全、功能不太强大的方法，比如IFRAME或JSONP。

从4.2开始，Spring MVC已支持CORS。

在Spring Boot中使用带有@CrossOrigin注释的controller方法CORS配置，不需要任何特定的配置。

@CrossOrigin注解可以在类上使用，也可以在方法上使用，如：

常用的属性有2个，分别是origins和maxAge，下面分别解释下：

如果只在方法上或者类上使用@CrossOrigin注解，则默认该映射接受所有的网站发送过来的请求、接受所有类型的http请求和接受所有的不同内容的头部信息（Header），如：

@CrossOrigin可以同时在类上、方法上同时使用，来控制不同网站访问不同的映射，如：

remove方法可以被所有网站的访问，retrieve方法只接受 http://domain2.com 网站发送的请求。

全局CORS配置可以通过注册一个WebMvcConfigurer bean并使用自定义的addcorsmapping (CorsRegistry)方法来定义，如:

36SpringBoot配置Cors解决跨域请求

CORS（Cross-Origin Resource Sharing）"跨域资源共享"，是一个W3C标准，它允许浏览器向跨域服务器发送Ajax请求，打破了Ajax只能访问本站内的资源限制，CORS在很多地方都有被使用，微信支付的JS支付就是通过JS向微信服务器发送跨域请求。开放Ajax访问可被跨域访问的服务器大大减少了后台开发的工作，前后台工作也可以得到很好的明确以及分工，下面我们就看讲一下如何让SpringBoot项目支持CORS跨域。

1、新建项目sc-cors，对应的pom.xml文件如下

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>spring-cloud</groupId>
    <artifactId>sc-cors</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>sc-cors</name>
    <url>http://maven.apache.org</url>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
    </parent>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

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

2、新建配置类，配置满足什么的条件的可以跨域访问

package sc.cors.config;

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 CorsConfig implements WebMvcConfigurer{

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/cors/**")
        .allowedMethods("*")
        .allowedOrigins("*")
        .allowedHeaders("*");
    }
}

3、新建controller，包含一个可以跨域访问的资源，一个不可以跨域访问的资源

package sc.cors.controller;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import sc.cors.model.User;

@RestController
public class CorsController {

    @RequestMapping("/cors/getUserInfo")
    public Map<String, Object> getUserInfo() {
        Map<String, Object> resp = new HashMap<String, Object>();
        resp.put("code", "success");
        resp.put("message", "success");
        User user = new User();
        user.setId(1);
        user.setPosition("cto");
        user.setUserName("huang jinjin");
        resp.put("body", user);
        return resp;
    }

    @RequestMapping("/nocors/listUserInfo")
    public Map<String, Object> listUserInfo() {
        Map<String, Object> resp = new HashMap<String, Object>();
        resp.put("code", "success");
        resp.put("message", "success");
        List<User> list = new ArrayList<User>();
        User user = new User();
        user.setId(1);
        user.setPosition("cto");
        user.setUserName("huang jinjin");
        list.add(user);
        resp.put("body", list);
        return resp;
    }

}

4、其他项目文件如下图

5、在新建一个项目sc-cors-web，该项目比较简单，包含一个比较重要的html文件

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>cors</title>
<script type="text/javascript" src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
<script type="text/javascript">
    $(function(){
            $("#getUserInfo").click(function(){
                $.ajax({
                    url: "http://127.0.0.1:9088/cors/getUserInfo",
                    success: function(data){
                        console.log(data)
                        alert("getUserInfo");
                    }
                })
            });
    });

    $(function(){
        $("#listUserInfo").click(function(){
            $.ajax({
                url: "http://127.0.0.1:9088/nocors/listUserInfo",
                success: function(data){
                    console.log(data)
                    alert("listUserInfo");
                }
            })
        });
});

</script>
</head>
<body>
    <input type="button" id="getUserInfo" value="CORS跨域请求getUserInfo"/><br><br/>
    <input type="button" id="listUserInfo" value="CORS跨域请求listUserInfo"/>
</body>
</html>

备注：
sc-cors项目对应的端口为9088
sc-cors-web项目对应的端口为9087
6、分别启动项目sc-cors和sc-cors-web
7、验证跨域请求
访问http://127.0.0.1:9087/index.html

点击CORS跨域请求getUserInfo

点击CORS跨域请求listUserInfo