Lumen 5.8 CORS 正确开启方法

在 Lumen 5.8 中启用 CORS（跨域资源共享）是一项常见的需求，尤其是在构建前后端分离的应用时。手动配置 CORS 可能会遇到一些问题，本文将分析错误原因，并推荐使用成熟的 CORS 包来简化配置过程。

问题分析：middleware() 方法未定义

错误信息 PHP Fatal error: Uncaught Error: Call to undefined method Illuminate\\Foundation\\Application::middleware() in /bootstrap/app.php 表明你尝试在 Illuminate\Foundation\Application 实例上调用 middleware() 方法，而该方法并不存在于该类中。

这是因为 Illuminate\Foundation\Application 是 Laravel 的 IOC 容器，而 Lumen 使用的是 Laravel\Lumen\Application。只有 Lumen 的 IOC 容器才具有 middleware() 方法。这通常意味着你可能在 Laravel 项目中使用了 Lumen 的配置方式，或者在 Lumen 项目中引入了 Laravel 的核心组件。

解决方法：检查 Lumen 应用实例

确保 $app 变量是 Laravel\Lumen\Application 的实例。检查 bootstrap/app.php 文件中创建应用实例的代码，确认使用的是 Lumen 的应用类。

// bootstrap/app.php

require_once __DIR__.'/../vendor/autoload.php';

$app = new Laravel\Lumen\Application(
    realpath(__DIR__.'/../')
);

// ... 其他配置

确认以上代码片段中 $app 变量确实是由 Laravel\Lumen\Application 类实例化而来。如果不是，则需要修改为正确的 Lumen 应用类。

推荐方案：使用 CORS 包

虽然手动配置 CORS 是可行的，但使用专门的 CORS 包可以简化配置，并提供更稳定、更可靠的解决方案。以下是一些推荐的 Lumen CORS 包：

• fruitcake/laravel-cors: Laravel 7.0 以后默认包含的 CORS 包，也支持 Lumen。
• spatie/laravel-cors: 另一个流行的 CORS 包，也支持 Lumen。虽然该包在 Laravel 包含 CORS 功能后已被归档，但仍然可以用于较旧的版本。

使用 fruitcake/laravel-cors 包的步骤：

1. 安装:

   composer require fruitcake/laravel-cors

2. 注册中间件:

   在 bootstrap/app.php 文件中注册全局中间件：

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

3. 配置:

   在 config 目录下创建 cors.php 文件，并添加以下内容：

   // config/cors.php
   
   return [
   
       /*
       |--------------------------------------------------------------------------
       | Cross-Origin Resource Sharing (CORS) Configuration
       |--------------------------------------------------------------------------
       |
       | Here you may configure your settings for cross-origin resource sharing
       | or "CORS". This determines what cross-origin operations may execute
       | in web browsers. You are free to adjust these settings as needed.
       |
       | To learn more: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
       |
       */
   
       'paths' => ['api/*'],
   
       'allowed_methods' => ['*'],
   
       'allowed_origins' => ['*'],
   
       'allowed_origins_patterns' => [],
   
       'allowed_headers' => ['*'],
   
       'exposed_headers' => [],
   
       'max_age' => 0,
   
       'supports_credentials' => false,
   
   ];

   注意: 在生产环境中，强烈建议不要使用 'allowed_origins' => ['*']，而是指定允许的域名。

   如果 Lumen 项目没有 config 目录，需要手动创建，并且需要在 bootstrap/app.php 中启用配置：

   // bootstrap/app.php
   $app->configure('cors');

使用 spatie/laravel-cors 包的步骤：

1. 安装:

   composer require spatie/laravel-cors

2. 注册中间件:

   在 bootstrap/app.php 文件中注册全局中间件：

   // bootstrap/app.php
   
   $app->middleware([
      Spatie\Cors\Cors::class
   ]);

3. 配置:

   发布配置文件：

   php artisan vendor:publish --provider="Spatie\Cors\CorsServiceProvider"

   修改 config/cors.php 文件，配置 CORS 选项。

注意事项

• 生产环境安全: 在生产环境中，务必配置 allowed_origins 为具体的域名，避免使用通配符 *，以提高安全性。
• 缓存: CORS 配置可能会被浏览器缓存。修改 CORS 配置后，可能需要清除浏览器缓存才能生效。
• 预检请求 (OPTIONS): 对于复杂的 CORS 请求（例如，包含自定义 header 或使用 PUT/DELETE 方法），浏览器会先发送一个 OPTIONS 预检请求。确保你的服务器能够正确处理 OPTIONS 请求。通常 CORS 包会自动处理 OPTIONS 请求。

总结

虽然手动配置 CORS 在 Lumen 中是可行的，但推荐使用成熟的 CORS 包，例如 fruitcake/laravel-cors 或 spatie/laravel-cors。这些包提供了更简单、更可靠的配置方式，并能处理常见的 CORS 问题。使用 CORS 包可以减少出错的可能性，并提高开发效率。务必根据实际需求配置 CORS 选项，并注意生产环境的安全性。