0

0

如何在Laravel中配置CORS支持

畫卷琴夢

畫卷琴夢

发布时间:2025-07-11 18:30:03

|

316人浏览过

|

来源于php中文网

原创

laravel中配置cors支持最推荐的方式是使用barryvdh/laravel-cors包。1. 通过composer安装该包:composer require barryvdh/laravel-cors;2. 发布配置文件:php artisan vendor:publish --tag="cors";3. 在kernel.php中注册handlecors中间件,通常添加到api中间件组;4. 精准配置config/cors.php文件中的paths、allowed_methods、allowed_origins、allowed_headers等参数;5. 清除配置缓存:php artisan config:clear。cors错误源于浏览器的同源策略限制,服务器未正确设置access-control-allow-origin等响应头或未妥善处理options预检请求时会触发此问题。精细化控制cors策略应避免使用通配符“*”,而是根据实际需求限定允许的路径、域名、方法和请求头。预检请求(options)由浏览器自动发送,用于确认跨域请求是否安全,laravel通过handlecors中间件自动处理此类请求并返回正确的cors响应头,从而简化开发流程并提升安全性。

如何在Laravel中配置CORS支持

在Laravel中配置CORS支持,最直接且推荐的方式是利用一个专门的中间件来处理跨域请求,确保你的API能够被不同源的前端应用安全地访问。这通常涉及到一个第三方包的引入和简单的配置。

解决方案

要在Laravel项目中启用CORS(跨域资源共享),我通常会选择使用 barryvdh/laravel-cors 这个流行且功能完善的包。它能很好地处理预检请求和响应头设置,省去了很多手动配置的麻烦。

首先,通过Composer安装这个包:

composer require barryvdh/laravel-cors

安装完成后,发布其配置文件到你的项目中。这会生成一个 config/cors.php 文件,你可以在其中定义CORS策略。

php artisan vendor:publish --tag="cors"

接下来,你需要在 app/Http/Kernel.php 中注册CORS中间件。我通常会把它添加到 middlewareGroupsapi 组中,这样它就只对API路由生效,或者直接添加到 middleware 数组中,让它对所有请求生效。对于API项目,放在 api 组里更合理。

// app/Http/Kernel.php

protected $middlewareGroups = [
    'web' => [
        // ...
    ],

    'api' => [
        \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
        'throttle:api',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        \Barryvdh\Cors\HandleCors::class, // 添加这一行
    ],
];

最后,也是最关键的一步,是配置 config/cors.php 文件。这个文件提供了非常灵活的选项来控制哪些源、哪些方法、哪些头可以被允许。

// config/cors.php

return [
    /*
     * 你希望CORS策略应用于哪些路径?
     * 默认是 '/',表示所有路径。
     * 我通常会根据实际情况调整,比如只针对 '/api/*'。
     */
    'paths' => ['api/*', 'sanctum/csrf-cookie'],

    /*
     * 允许的HTTP方法。
     * 如果你只提供GET和POST,那就只列出这两个。
     */
    'allowed_methods' => ['*'], // 或者 ['GET', 'POST', 'PUT', 'DELETE']

    /*
     * 允许的来源(域名)。
     * 这是最重要的安全配置之一。绝不要在生产环境使用 '*',除非你明确知道自己在做什么。
     * 最好列出你的前端应用域名,比如 ['http://localhost:3000', 'https://your-frontend-domain.com']。
     */
    'allowed_origins' => ['*'],

    /*
     * 允许的来源模式。
     * 比如 ['/^http:\/\/localhost:\d{4}$/'],允许本地所有端口的请求。
     */
    'allowed_origins_patterns' => [],

    /*
     * 允许的请求头。
     * 通常包括 'Content-Type', 'Authorization', 'X-Requested-With' 等。
     */
    'allowed_headers' => ['*'], // 或者 ['Content-Type', 'Accept', 'Authorization', 'X-Requested-With']

    /*
     * 响应中暴露给前端的头。
     * 如果前端需要访问自定义的响应头,需要在这里列出。
     */
    'exposed_headers' => [],

    /*
     * 预检请求(OPTIONS)的缓存时间,单位秒。
     * 这可以减少不必要的预检请求,提升性能。
     */
    'max_age' => 0, // 生产环境可以设置为 86400 (24小时)

    /*
     * 是否支持凭证(如Cookies, HTTP认证)。
     * 如果前端请求需要发送cookies或认证头,这里必须设置为 true,
     * 并且 allowed_origins 不能是 '*',必须是具体的域名。
     */
    'supports_credentials' => false,
];

配置完成后,清除一下配置缓存:

php artisan config:clear

现在,你的Laravel API应该能够正确响应来自允许域名的跨域请求了。

为什么我的Laravel API会出现CORS错误?

CORS错误,或者说“跨域问题”,是前端开发中一个非常常见也令人头疼的现象。我遇到过无数次,前端同事一头雾水地跑过来问,“我的请求怎么被浏览器拦住了?”这通常是由于浏览器的“同源策略”在作祟。简单来说,同源策略规定,一个网页只能请求和自己域名、协议、端口都相同的资源。如果你的前端应用运行在 http://localhost:3000,而你的Laravel API在 http://localhost:8000,它们就是不同源的,浏览器会默认阻止这种跨域请求,除非服务器明确允许。

当出现CORS错误时,浏览器控制台通常会显示类似“Access to XMLHttpRequest at '...' from origin '...' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.”这样的信息。这意味着:

  1. 服务器没有发送正确的CORS响应头:最常见的就是缺少 Access-Control-Allow-Origin 头,或者它的值与前端请求的 Origin 头不匹配。
  2. 预检请求(OPTIONS)处理不当:对于一些“非简单请求”(比如带有自定义请求头、使用了PUT/DELETE方法、或者Content-Type不是application/x-www-form-urlencoded、multipart/form-data、text/plain),浏览器会先发送一个OPTIONS请求(预检请求)来询问服务器是否允许实际的请求。如果服务器没有正确响应这个OPTIONS请求,或者返回了非200的状态码(比如404、405),那么实际的请求就不会被发送。
  3. 凭证问题:如果你的前端请求需要携带认证信息(如Cookie或Authorization头),并且服务器没有设置 Access-Control-Allow-Credentials: true,同时 Access-Control-Allow-Origin 也不是具体的域名,浏览器同样会阻止请求。

这些问题都指向一个核心:服务器没有明确告知浏览器“我可以接受来自你这个源的请求,并且允许你使用这些方法和头”。Laravel-CORS包正是为了自动化这个“告知”过程而生。

如何精细化控制CORS策略,而不是“全部放行”?

我个人倾向于尽可能地收紧CORS策略,只开放必要的权限。这就像给家里的门窗上锁,而不是敞开大门欢迎所有人。在 config/cors.php 文件中,有几个关键配置项可以帮助你实现精细化控制,避免使用 * 来“全部放行”:

Bing图像创建器
Bing图像创建器

必应出品基于DALL·E的AI绘图工具

下载
  1. paths: 这个选项决定了CORS策略作用于哪些API路径。如果你所有的API都在 /api 前缀下,那么设置为 ['api/*', 'sanctum/csrf-cookie'] 是一个很好的实践。这样,你的网站前端(如果和API在同一个Laravel项目里)就不会被不必要的CORS规则影响。我见过很多项目直接设置为 ['*'],导致一些非API路由也带上了CORS头,虽然无害,但显得不够严谨。

  2. allowed_origins: 这是最重要的安全配置。永远不要在生产环境中使用 ['*']。你应该明确列出所有允许访问你API的前端域名。例如:

    'allowed_origins' => [
        'http://localhost:3000', // 开发环境的前端
        'https://your-production-frontend.com', // 生产环境的前端
        'https://another-allowed-domain.com', // 另一个允许的域名
    ],

    如果你的前端应用有多个子域名,或者在不同的端口运行,你需要把它们都列出来。

  3. allowed_methods: 只允许你的API实际会用到的HTTP方法。如果你的API只提供GET和POST,那么就配置为 ['GET', 'POST']。这能有效防止一些不必要的HTTP方法攻击。

    'allowed_methods' => ['GET', 'POST', 'PUT', 'DELETE'],
  4. allowed_headers: 指定前端请求可以携带的HTTP头。通常,你只需要允许 Content-TypeAcceptAuthorization(如果使用Bearer Token)、X-Requested-With 等。如果你有自定义的请求头,也需要在这里列出。

    'allowed_headers' => ['Content-Type', 'Accept', 'Authorization', 'X-Requested-With'],

    使用 ['*'] 虽然方便,但潜在地允许了任何自定义头,增加了攻击面。

  5. supports_credentials: 当你需要前端请求携带Cookie或HTTP认证信息时,这个选项必须设置为 true。但请注意,一旦设置为 trueallowed_origins 就不能再是 ['*'] 了,必须是具体的域名。这是为了防止凭证被恶意网站窃取。

通过这些精细的配置,你可以确保你的API只对信任的客户端开放,并且只允许必要的交互方式,大大提升了安全性。

CORS预检请求(OPTIONS)是如何工作的,以及它在Laravel中扮演的角色?

一开始我对这个OPTIONS请求也挺困惑的,觉得多此一举。但后来明白了,这是浏览器为了安全,提前跟服务器打个招呼,问清楚“我能不能这么干?”。

CORS预检请求的工作原理:

当浏览器发现一个跨域请求是“非简单请求”时(例如:使用了PUT/DELETE等HTTP方法、发送了自定义HTTP头、或者Content-Type不是application/x-www-form-urlencodedmultipart/form-datatext/plain),它不会直接发送实际的请求。相反,它会先发送一个HTTP OPTIONS请求到目标服务器。这个OPTIONS请求被称为“预检请求”(Preflight Request)。

预检请求中会包含一些特殊的HTTP头,比如:

  • Access-Control-Request-Method: 告诉服务器实际请求将使用什么HTTP方法(例如:PUT)。
  • Access-Control-Request-Headers: 告诉服务器实际请求将携带哪些非标准HTTP头(例如:X-Custom-Header)。
  • Origin: 告诉服务器请求的来源域名。

服务器收到这个OPTIONS请求后,会根据自身的CORS策略来判断是否允许这个跨域操作。如果允许,服务器会响应一个状态码为200或204的响应,并在响应头中包含一系列CORS相关的头,比如:

  • Access-Control-Allow-Origin: 允许的来源。
  • Access-Control-Allow-Methods: 允许的HTTP方法。
  • Access-Control-Allow-Headers: 允许的请求头。
  • Access-Control-Max-Age: 预检请求的结果可以缓存多久(秒)。

浏览器收到服务器的预检响应后,会检查这些头信息。如果服务器明确允许了这次跨域操作,浏览器才会继续发送实际的HTTP请求(GET、POST、PUT等)。如果预检请求失败(例如服务器返回了4xx/5xx错误,或者响应头中没有包含必要的CORS信息),浏览器就会阻止实际请求的发送,并在控制台报错。

预检请求在Laravel中的角色:

在Laravel中,特别是当你使用了像 barryvdh/laravel-cors 这样的包时,预检请求的处理变得非常自动化和透明。

  1. 中间件拦截HandleCors 中间件被注册后,它会优先拦截所有进来的请求,特别是OPTIONS请求。
  2. 自动响应:当它检测到一个OPTIONS请求时,它不会将请求传递给你的路由处理器。相反,它会根据你在 config/cors.php 中定义的规则,直接构造并发送一个204 No Content(或200 OK)的响应,并附带所有必要的 Access-Control-* 头。
  3. 路由无关性:这意味着你不需要为每个API路由手动定义一个OPTIONS方法来处理预检请求。这个中间件已经帮你搞定了。如果没有这个中间件,你可能需要为每个可能被预检的路由手动添加一个OPTIONS路由,并确保它们返回正确的CORS头,这显然是重复且容易出错的。

通过 max_age 配置项,你还可以控制预检请求的缓存时间。如果设置为一个较大的值(比如一天,即86400秒),浏览器在一段时间内就不需要重复发送预检请求,直接发送实际请求即可,这对于减少网络延迟和提高API性能非常有帮助。理解预检请求的机制,对于调试和优化跨域问题至关重要。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2602

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1626

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1510

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1417

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1447

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

40

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号