Stack CORS 开源项目教程

Stack CORS 开源项目教程

stack-cors Cross-origin resource sharing library and stack middleware. 项目地址: https://gitcode.com/gh_mirrors/st/stack-cors

项目介绍

Stack CORS 是一个用于实现跨域资源共享（Cross-Origin Resource Sharing, CORS）的库及中间件，由 asm89 开发并维护。该库旨在支持基于 HTTP 的应用，在遵循 W3C 推荐的标准下，轻松配置不同来源之间的资源访问权限。它适用于任何构建于 http-foundation 或 kernel 框架之上的应用，尤其是 PHP 环境下的项目。通过灵活的配置选项，开发者可以精确控制哪些请求方法、起源、头信息等被允许跨域访问。

项目快速启动

要快速启动使用 Stack CORS，首先确保你的开发环境已安装了 Composer，PHP 的包管理工具。

安装

打开终端，进入项目目录，然后执行以下命令来添加这个依赖：

composer require asm89/stack-cors

这将自动下载并安装最新版本的 Stack CORS 库到你的项目中。

示例配置

在配置中间件时，你可以选择以库的形式或者作为堆栈中间件来集成。以下是两种方式的基本示例：

作为库使用

use Asm89\Stack\CorsService;

$cors = new CorsService([
    'allowedHeaders'   => ['X-Requested-With', 'Content-Type'],
    'allowedMethods'   => ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],
    'allowedOrigins'   => ['http://example.com'],
    'exposedHeaders'   => false,
    'maxAge'           => 3600,
    'supportsCredentials' => true,
]);

$response = new Response();
$origin = $_SERVER['HTTP_ORIGIN'];

// 添加实际请求的头信息
$cors->addActualRequestHeaders($response, $origin);

// 处理预检请求
$cors->handlePreflightRequest(new Request());

// 检查实际请求是否允许
if ($cors->isActualRequestAllowed(new Request())) {
    // 请求允许，继续处理逻辑...
}

作为中间件使用

use Asm89\Stack\Cors;

$app = new SomeApplication(); // 假设这是你的应用实例
$corsMiddleware = new Cors($app, [
    'allowedHeaders'   => ['X-Requested-With', 'Content-Type'],
    'allowedMethods'   => ['*'], // 允许所有方法
    'allowedOrigins'   => ['*'], // 允许任意起源
    'exposedHeaders'   => false,
    'maxAge'           => 3600,
    'supportsCredentials' => false,
]);
// 将中间件加入到应用的路由处理之前
// 注意具体如何加入取决于你所使用的框架或应用结构

应用案例和最佳实践

在构建 API 服务时，合理配置 CORS 可避免常见的跨域请求失败问题。最佳实践包括：

• 仅开放必需的请求方法和起源，避免不必要的安全风险。
• 当服务需要客户端发送凭据（如 Cookie）时，务必设置 supportsCredentials 为 true，并明确指定哪些头是允许的。
• 使用 maxAge 来缓存预检请求结果，减少服务器负担。
• 在生产环境中仔细测试各种场景以确保安全性与兼容性。

典型生态项目

由于 Stack CORS 针对的是 PHP 生态，它的主要应用在于增强基于 PHP 构建的 Web 服务的交互能力，尤其适用于那些需要与外部前端应用（如 React、Vue 应用）交互的后端服务。虽然没有特定列出典型的生态项目，但可以广泛应用于 Laravel、Symfony 等流行的 PHP 框架中，帮助这些框架的项目轻松实现跨域策略配置，促进前后端分离架构的健壮性。

---

以上就是针对 Stack CORS 开源项目的基本使用教程，希望对你集成和理解跨域资源共享有所帮助。记得在实际部署前进行充分的测试，确保安全性和功能完整性。

stack-cors Cross-origin resource sharing library and stack middleware. 项目地址: https://gitcode.com/gh_mirrors/st/stack-cors