README

实现了 https://github.com/fruitcake/php-cors 以供Laravel使用

针对升级到Laravel 9、10或更高版本的用户的说明

由于所有支持的Laravel版本现在都包含核心中的CORS中间件，因此此包已弃用。

从Laravel 9.2开始，此中间件包含在laravel/framework中。您可以使用提供的中间件，它应与此包中提供的中间件和配置兼容。有关更改，请参阅 https://github.com/laravel/laravel/pull/5825/files。

升级步骤

从您的composer.json中删除 "fruitcake/laravel-cors"
在 app/Http/Kernel.php 中将 \Fruitcake\Cors\HandleCors::class, 替换为 \Illuminate\Http\Middleware\HandleCors::class,

有关高级用法，请参阅 https://github.com/fruitcake/php-cors。配置保持不变。

关于

laravel-cors 包允许您通过Laravel中间件配置发送跨源资源共享头。

如果您想了解CORS工作流程的全貌，可以浏览此图片。

从0.x（barryvdh/laravel-cors）升级

从0.x版本升级时，有一些破坏性变更

使用新属性 'paths' 来启用/禁用某些路由上的CORS。默认情况下，它是空的，因此请正确填充它！
不再支持中间件组，请使用全局中间件
供应商名称已更改（请参阅安装/使用说明）
cors.php 中的属性大小写从camelCase更改为snake_case，因此如果您已经有一个 cors.php 文件，您需要更新该文件中的属性以匹配新的大小写。

功能

处理CORS预检OPTIONS请求
向您的响应中添加CORS头
将路由与仅添加CORS到某些请求匹配

安装

在您的 composer.json 中要求 fruitcake/laravel-cors 包，并更新您的依赖关系

composer require fruitcake/laravel-cors

如果您遇到冲突，这可能是由于已安装较旧的barryvdh/laravel-cors或fruitcake/laravel-cors版本。首先删除冲突的包，然后再次尝试安装

composer remove barryvdh/laravel-cors fruitcake/laravel-cors
composer require fruitcake/laravel-cors

全局使用

要允许所有路由的CORS，请在 app/Http/Kernel.php 类的 $middleware 属性顶部添加 HandleCors 中间件

protected $middleware = [
  \Fruitcake\Cors\HandleCors::class,
    // ...
];

现在更新配置，以定义要运行CORS服务的路径（见下文配置）

'paths' => ['api/*'],

配置

默认设置在 config/cors.php 中设置。发布配置以复制文件到您自己的配置

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

注意：当使用自定义头，如 X-Auth-Token 或 X-Requested-With 时，您必须将 allowed_headers 设置为包括这些头。您也可以将其设置为 ['*'] 以允许所有自定义头。

注意：如果您明确列出白名单头，则必须包括 Origin，否则请求将无法被识别为CORS。

选项

allowed_origins、allowed_headers 和 allowed_methods 可以设置为 ['*'] 以接受任何值。

注意：对于 allowed_origins，如果您不使用通配符，则必须包含方案，例如 ['http://example.com', 'https://example.com']。您还必须考虑到在 allowed_origins_patterns 中使用时方案将存在。

注意： 尽可能具体。您可以从宽松的限制开始开发，但尽可能严格为好！

注意： 由于 Laravel 中的 http 方法重写，允许 POST 方法也将使 API 用户能够执行 PUT 和 DELETE 请求。

注意： 有时候需要指定端口号（例如，在您在本地环境中编写应用程序时）。您也可以在这里指定端口号或使用通配符，例如 localhost:3000，localhost:* 或者甚至使用 FQDN app.mydomain.com:8080

Lumen

在 Lumen 中，只需手动在您的 bootstrap/app.php 文件中注册 ServiceProvider

$app->register(Fruitcake\Cors\CorsServiceProvider::class);

还将 cors.php 配置文件复制到 config/cors.php 并投入使用

$app->configure('cors');

Lumen 的全局使用

要允许所有路由的 CORS，将 HandleCors 中间件添加到全局中间件并将配置中的 paths 属性设置为。

$app->middleware([
    // ...
    Fruitcake\Cors\HandleCors::class,
]);

常见问题

错误的配置

确保配置中的 path 选项是正确的，并且实际上与您使用的路由相匹配。记得清除配置缓存。

错误处理，中间件顺序

有时错误/中间件会返回自己的响应，这可能会阻止 CORS 中间件的运行。尝试更改中间件的顺序并确保它是全局中间件中的第一个条目，而不是路由组的一部分。同时检查日志以获取实际的错误，因为没有 CORS，错误将被浏览器吞没，只显示 CORS 错误。还尝试在没有 CORS 的情况下运行以确保它实际上可以工作。

授权头 / 凭据

如果您的请求包含授权头或使用凭据模式，请将配置中的 supports_credentials 值设置为 true。这将设置 Access-Control-Allow-Credentials 头为 true。

Echo/die

如果您在代码中使用 echo()、dd()、die()、exit()、dump() 等，您将破坏中间件流程。当输出在头之前发送时，CORS 无法添加。当脚本在 CORS 中间件完成之前退出时，CORS 头将不会添加。始终返回适当的响应或抛出异常。

为您的 API 禁用 CSRF 保护

如果可能，使用禁用 CSRF 保护的路由组。否则，您可以在 App\Http\Middleware\VerifyCsrfToken 中为某些请求禁用 CSRF。

protected $except = [
    'api/*',
    'sub.domain.zone' => [
      'prefix/*'
    ],
];

重复头

CORS 中间件应该是您添加这些头的唯一地方。如果您还在 .htaccess、nginx 或您的 index.php 文件中添加头，您将得到重复的头和不预期的结果。

无跨站请求

如果您没有进行跨站请求，即如果您没有从 site-b.com 请求 site-a.com/api，则浏览器将不会发送 Origin: https://site-b.com 请求头，CORS 将被“禁用”，因为 Access-Control-Allow-Origin 头也将缺失。这是因为请求是从同一站点发出的，在这种情况下不需要保护。

许可

在 MIT 许可下发布，请参阅 LICENSE。

khamazaspyan / laravel-cors

维护者

详细信息