CORS(Cross-Origin Resource Sharing)是由W3C制定的一种跨域资源共享技术标准,其目的就是为了解决前端的跨域请求。

在Java EE开发中,最常见的前端跨域请求解决方案是JSONP,但是JSONP只支持GET请求,这是一个很大的缺陷,而CORS则支持多种HTTP请求方法。

响应头中有一个Access-Control-Allow-Origin字段,用来记录可以访问该资源的域。当浏览器收到这样的响应头信息之后,提取出Access-Control-Allow-Origin字段中的值,发现该值包含当前页面所在的域,就知道这个跨域是被允许的,因此就不再对前端的跨域请求进行限制。这就是GET请求的整个跨域流程,在这个过程中,前端请求的代码不需要修改,主要是后端进行处理。这个流程主要是针对GET、POST以及HEAD请求,并且没有自定义请求头,如果用户发起一个DELETE请求、PUT请求或者自定义了请求头,流程就会稍微复杂一些。

无论是简单请求还是需要先进行探测的请求,前端的写法都是不变的,额外的处理都是在服务端来完成的。在传统的Java EE开发中,可以通过过滤器统一配置,而Spring Boot中对此则提供了更加简洁的解决方案。在Spring Boot中配置CORS的步骤如下:

创建Spring Boot工程

springboot CORS支持_跨域

首先创建一个Spring Boot工程,添加Web依赖,代码如下:

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

application.properties

server.port=8099

创建控制器

在新创建的Spring Boot工程中,添加一个BookController控制器

package com.shrimpking.controller;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Created by IntelliJ IDEA.
 *
 * @Author : Shrimpking
 * @create 2023/6/4 21:45
 */
@RestController
public class BookController
{
    @PostMapping("/book")
    //@CrossOrigin(value = "http://localhost:8088",maxAge = 1800,allowedHeaders = "*")
    public String addBook(String name)
    {
        return "接收的name值是:" + name;
    }

    @DeleteMapping("/book/{id}")
    //@CrossOrigin(value = "http://localhost:8088",maxAge = 1800,allowedHeaders = "*")
    public String deleteBookById(@PathVariable Long id)
    {
        return String.valueOf(id);
    }
}

BookController中提供了两个接口:一个是添加接口,另一个是删除接口。

 配置跨域

跨域有两个地方可以配置。一个是直接在相应的请求方法上加注解

代码解释:

• @CrossOrigin中的value表示支持的域,这里表示来自http://localhost:8088域的请求是支持跨域的。

• maxAge表示探测请求的有效期,对于DELETE、PUT请求或者有自定义头信息的请求,在执行过程中会先发送探测请求,探测请求不用每次都发送,可以配置一个有效期,有效期过了之后才会发送探测请求。这个属性默认是1800秒,即30分钟。

• allowedHeaders表示允许的请求头,*表示所有的请求头都被允许。这种配置方式是一种细粒度的配置,可以控制到每一个方法上。当然,也可以不在每个方法上添加@CrossOrigin注解,而是采用一种全局配置,代码如下:

MyWebMvcConfig.java

package com.shrimpking.config;

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

/**
 * Created by IntelliJ IDEA.
 *
 * @Author : Shrimpking
 * @create 2023/6/4 21:53
 */
@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer
{
    @Override
    public void addCorsMappings(CorsRegistry registry)
    {
        registry.addMapping("/book/**")
                .allowedHeaders("*")
                .allowedMethods("*")
                .maxAge(1800)
                .allowedOrigins("http://localhost:8088");
    }
}

代码解释:

• 全局配置需要自定义类实现WebMvcConfigurer接口,然后实现接口中的addCorsMappings方法。

• 在addCorsMappings方法中,addMapping表示对哪种格式的请求路径进行跨域处理;allowedHeaders表示允许的请求头,默认允许所有的请求头信息;allowedMethods表示允许的请求方法,默认是GET、POST和HEAD;*表示支持所有的请求方法;maxAge表示探测请求的有效期;allowedOrigins表示支持的域。

在上面的两种配置方式(@CrossOrigin注解配置和全局配置)中,选择其中一种即可,然后启动项目。

测试

新建一个Spring Boot项目,添加Web依赖,然后在resources/static目录下加入jquery.js,再在resources/static目录下创建一个index.html文件,内容如下:

springboot CORS支持_spring_02

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>cors</title>
    <script src="jQuery-3.4.1.js"></script>
</head>
<body>
    <div id="contentDiv"></div>
    <div id="deleteResult"></div>
    <input type="button" value="提交数据" onclick="getData()"><br>
    <input type="button" value="删除数据" onclick="deleteData()"><br>

    <script>
        function deleteData() {
            $.ajax({
                url:'http://localhost:8099/book/88',
                type:'delete',
                success:function (msg) {
                    $("#deleteResult").html(msg);
                }
            })
        }

        function getData() {
            $.ajax({
                url:"http://localhost:8099/book",
                type:'post',
                data:{name:'水浒传'},
                success:function (msg) {
                    $("#contentDiv").html(msg);
                }
            })
        }
    </script>

</body>
</html>

 两个普通的Ajax都发送了一个跨域请求。

然后将项目的端口修改为8088,代码如下:

application.properties

server.port=8088

运行截图

springboot CORS支持_java_03