Flutter核心功能扩展插件gazelle_core的使用

Flutter核心功能扩展插件gazelle_core的使用

Gazelle简介

Gazelle 是一个轻量级且灵活的Dart HTTP服务器框架，旨在简化Web应用程序的开发。通过Gazelle，您可以快速设置强大的API、Web服务器和微服务，所有这些都具有最小的配置和最高的效率。

主要特性

• 易于使用：Gazelle 以简单性为核心设计理念。无论您是经验丰富的开发者还是初学者，Gazelle 的直观API和清晰的文档都能让您快速上手。
• 插件系统：通过自定义插件扩展Gazelle的功能。无缝集成身份验证、日志记录等常见功能到您的应用中。
• 中间件支持：Gazelle 支持中间件函数，允许您轻松自定义请求处理。只需几行代码即可为路由添加身份验证、速率限制等功能。
• HTTP/HTTPS支持：Gazelle 完全支持HTTP和HTTPS协议，确保应用程序的安全通信。轻松配置SSL证书以增强安全性。

快速开始

安装

要在Dart项目中使用Gazelle，请在pubspec.yaml文件中添加以下依赖项：

dependencies:
  gazelle_core: <latest-version>

然后，运行dart pub get或flutter pub get来安装该包。

示例用法

以下是一个创建简单Gazelle服务器的示例：

import 'package:gazelle_core/gazelle_core.dart';

// 定义一个处理函数，返回HTTP响应
GazelleResponse<String> handler(
  GazelleContext context,
  GazelleRequest request,
) =>
    GazelleResponse(
      statusCode: GazelleHttpStatusCode.success.ok_200, // 设置状态码为200
      body: "Hello, Gazelle!", // 设置响应体
    );

Future<void> main() async {
  try {
    // 创建一个Gazelle应用实例，并定义路由
    final app = GazelleApp(
      routes: [
        GazelleRoute(
          name: "hello_gazelle", // 路由名称
        ).get(handler), // 为GET请求绑定处理函数
      ],
    );

    // 启动服务器
    await app.start();
    print("Gazelle listening at ${app.serverAddress}"); // 打印服务器地址
  } catch (e) {
    print("Failed to start the server: $e"); // 捕获并打印启动失败的错误信息
  }
}

在这个示例中，我们创建了一个简单的Gazelle服务器，它会响应任何对根路径的GET请求，并返回“Hello, Gazelle!”作为响应。

完整示例Demo

为了更全面地展示如何使用gazelle_core，下面是一个完整的示例，包括多个路由、中间件和插件的使用。

pubspec.yaml配置

dependencies:
  gazelle_core: <latest-version>

main.dart完整示例

import 'package:gazelle_core/gazelle_core.dart';

// 定义一个简单的处理器，返回HTTP响应
GazelleResponse<String> helloHandler(
  GazelleContext context,
  GazelleRequest request,
) =>
    GazelleResponse(
      statusCode: GazelleHttpStatusCode.success.ok_200,
      body: "Hello, Gazelle!",
    );

// 定义一个带有参数的处理器
GazelleResponse<String> echoHandler(
  GazelleContext context,
  GazelleRequest request,
) {
  final message = request.queryParameters['message'] ?? 'No message';
  return GazelleResponse(
    statusCode: GazelleHttpStatusCode.success.ok_200,
    body: "Echo: $message",
  );
}

// 定义一个中间件，用于记录请求日志
GazelleMiddleware logMiddleware(GazelleContext context, GazelleRequest request, GazelleNext next) {
  print("Request received: ${request.method} ${request.path}");
  return next(); // 继续处理下一个中间件或路由
}

// 定义一个插件，用于添加全局头部信息
class HeaderPlugin extends GazellePlugin {
  [@override](/user/override)
  void onInit(GazelleApp app) {
    app.use((context, request, next) async {
      final response = await next();
      response.headers.add('X-Powered-By', 'Gazelle');
      return response;
    });
  }
}

Future<void> main() async {
  try {
    // 创建一个Gazelle应用实例，启用日志中间件和自定义插件
    final app = GazelleApp(
      middleware: [logMiddleware],
      plugins: [HeaderPlugin()],
      routes: [
        GazelleRoute(
          name: "hello_gazelle",
        ).get(helloHandler),
        GazelleRoute(
          name: "echo_message",
        ).get(echoHandler),
      ],
    );

    // 启动服务器
    await app.start();
    print("Gazelle listening at ${app.serverAddress}");
  } catch (e) {
    print("Failed to start the server: $e");
  }
}