Flutter路由宏定义插件shelf_router_macro的使用

Flutter路由宏定义插件shelf_router_macro的使用

🚧 实验性支持 用于 shelf_router 的宏定义。

🌟 特点

• ✨ 路由声明
• ✨ 路由参数
• ✨ 异步路由
• ✨ 轻量级 - 无需额外依赖，只需 shelf_router
• 🖊️ 开发中 直观 - 自定义返回类型
• 🖊️ 开发中 简洁 - 无需指定 Request/Response，直接返回响应体

🧑‍💻 示例

import 'package:data_class_macro/data_class_macro.dart';

[@Controller](/user/Controller)()
class GreetingController {
  [@Get](/user/Get)('/wave')
  Future<String> wave() async {
    await Future.delayed(const Duration(seconds: 1));
    return '_o/';
  }
}

import 'package:json/json.dart';
import 'package:data_class_macro/data_class_macro.dart';

@JsonCodable()
class Pong {
  Pong({required this.uid});

  final String uid;
}

[@Controller](/user/Controller)()
class PingController {
  [@Get](/user/Get)('/ping/<uid>')
  Future<Pong> ping(String uid) async {
    return Pong(uid: uid);
  }
}

🚀 快速开始

1. 下载 Dart 来自 `dev` 或 `master` 渠道 - [Dart SDK 归档](https://dart.dev/get-dart/archive#dev-channel) - [dvm: Dart 版本管理器](https://github.com/cbracken/dvm) - 或者，您可以简单地切换到 flutter master 渠道： ```sh $ flutter channel master ```

1. 在你的 <code>pubspec.yaml</code> 中添加 <code>package:shelf_router_macro</code>

   $ dart pub add shelf_router_macro
   

2. 在 <code>analysis_options.yaml</code> 中启用实验性宏

   analyzer:
     enable-experiment:
       - macros
   

3. 使用此库提供的注解（见上述示例）。

4. 运行它

   $ dart --enable-experiment=macros run lib/main.dart
   

🙌 手把手指南

定义路由

所有路由应作为带有 <code>[@Controller](/user/Controller)()</code> 注解的类的一部分进行声明：

[@Controller](/user/Controller)()
class SomeController {
  [@Get](/user/Get)('/')
  String health() => 'ok';
}

自定义响应

返回 shelf 的 <a href="https://pub.dev/documentation/shelf/latest/shelf/Response-class.html">Response</a>：

[@Get](/user/Get)('/')
String health() => Response.ok(
      'ok',
      headers: {'X-Test': 'test'},
    );

访问请求详情

在方法签名中包含 shelf 的 <a href="https://pub.dev/documentation/shelf/latest/shelf/Request-class.html">Request</a>：

[@Get](/user/Get)('/')
String test(Request r) => 'Headers: ${r.headers}';

示例代码

import 'dart:async';
import 'dart:convert';
import 'dart:io';

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

[@Controller](/user/Controller)()
class GreetingController {
  [@Get](/user/Get)('/')
  Response greeting(Request request) {
    return Response.ok('Hello, world!');
  }

  [@Get](/user/Get)('/<name>')
  String greetingByName(String name) {
    return 'Hello, $name!';
  }

  [@Get](/user/Get)('/wave')
  Future<String> asyncWave() async {
    await Future.delayed(const Duration(seconds: 1));
    return '_o/';
  }
}

const host = 'localhost';
const port = 8080;

void main() async {
  final controller = GreetingController();
  unawaited(
    serve(controller.router, host, port),
  );

  print('🔍 Testing...\n');
  await HttpClient().get(host, port, '/').sendAndLog();
  await HttpClient().get(host, port, '/eeqk').sendAndLog();
  await HttpClient().get(host, port, '/wave').sendAndLog();

  print('\n');
  print('✅ Server is running at http://$host:$port/');
}

extension SendRequestExt on Future<HttpClientRequest> {
  Future<void> sendAndLog() async {
    final request = await this;
    final response = await request.close();

    print('📡 Request: ${request.method} ${request.uri}');
    print('${response.statusCode} ${response.reasonPhrase}');
    print(await response.transform(utf8.decoder).join());
  }
}