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 版本升级

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

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

功能

处理 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，请将 HandleCors 中间件添加到 app/Http/Kernel.php 类的 $middleware 属性顶部

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 中，只需将 ServiceProvider 手动注册到您的 bootstrap/app.php 文件中

$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。

subham-jobanputra / laravel-cors

维护者

详细信息