搜索插件、代码仓与 APP 分类

插件详情v0.1.5

shelf_cors_headers

Shelf 的 CORS 请求头中间件。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
4.2万
喜欢数
41
Pub 分数
140

安装插件

flutter pub add shelf_cors_headers

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Shelf CORS Headers 是一个用于 Shelf 框架的中间件包,可简化在 HTTP 响应中添加跨域资源共享(CORS)头的过程。它通过配置允许的源、方法、头和凭据,使基于 Shelf 构建的服务器端应用程序能够安全地处理跨域请求。该包可无缝集成到现有的 Shelf 服务器中,为跨平台 Web 服务提供轻量且可配置的 CORS 策略管理解决方案。

适合场景

  • 在基于 Shelf 的 API 中启用跨域请求
  • 使用受控访问策略保护Web服务
  • 支持托管在不同域名上的前端应用
  • 将 CORS 集成到 Flutter Web 后端
  • 自动处理预检请求

主要特点

  • 可配置的允许来源
  • 支持自定义标头和方法
  • 自动处理 OPTIONS 预检请求
  • 与 Shelf 路由器轻松集成
  • 灵活的凭据和最大年龄配置

适合对象

  • 使用 Shelf 进行后端逻辑的开发人员
  • Flutter 开发人员构建 Web API
  • 实施安全 RESTful 服务的团队
  • 需要细粒度 CORS 控制的应用程序
  • 面向多个平台的服务器端 Dart 项目

使用建议

  • 需要对CORS标准有基本了解
  • 不适用于独立的客户端使用
  • 配置在生产环境中必须仔细管理
  • 不包括超出 CORS 的请求验证
  • 仅限基于货架的服务器环境

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

CORS headers middleware for Shelf

A Shelf middleware to add CORS headers to shelf responses.

Features

  • Handles preflight requests.
  • Allows override of default headers.
  • Allows user to provide their own origin checker function.

Usage

A simple usage example:

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

void main() async {
  var handler = const Pipeline()
      // Just add corsHeaders() middleware.
      .addMiddleware(corsHeaders())
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}
Override Headers
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    ACCESS_CONTROL_ALLOW_ORIGIN: 'example.com',
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your header overrides.
      .addMiddleware(corsHeaders(headers: overrideHeaders))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}
Custom origin checker

Your origin checker function should consume a string as a parameter(the value of ORIGIN header) and return a boolean value indicating if this middleware should process the request from that origin.

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

// define our origin checker
bool dontCheckCNNRequests(String origin) {
  if (origin.contains('cnn.com')) return false;
  return true;
}

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your origin checker
      .addMiddleware(corsHeaders(headers: overrideHeaders, originChecker: dontCheckCNNRequests))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}

You can also use the inbuilt originOneOf which takes a list of origins to check:

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

// define our origin checker
final listChecker = originOneOf(['https://cnn.com', 'https://dart.dev'])

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your origin checker
      .addMiddleware(corsHeaders(headers: overrideHeaders, originChecker: listChecker))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}

所属分类

依赖

依赖清单 1 项

源码仓库

使用此插件的项目