Flutter性能监控插件scouter的使用

特性

Scouter 是一个旨在为 Dart 开发者提供类似于 NestJS 体验的包。

• 路由系统通过注解实现
• 模块化设计
• 中间件支持
• 依赖注入（DI）

入门指南

首先，你需要将 scouter 包添加到你的项目中：

dart pub add scouter

使用说明

你可以在 example/scouter_example.dart 文件中找到更完整的示例。以下是启动应用所需的基本步骤。

应用初始化

在 main 函数中调用 runServer 函数，并进行相应的设置：

void main() async {
  final appModule = AppModule(
    modules: [
      TestModule(),
    ],
    middlewares: [
      ExampleMidleware(),
      LoggerMiddleware(),
    ],
    controllers: [
      FeatureController(),
      GameController(),
    ],
  );

  runServer(
    appModule,
    port: 8080,
  );
}

应用模块

AppModule 类是你应用的入口点和主模块，它会接收其他模块，例如中间件、控制器等。

class AppModule extends Module {
  AppModule({
    required this.modules,
    required this.middlewares,
    required this.controllers,
    required this.init,
  });

  final List<Module> modules;
  final List<HttpMiddleware> middlewares;
  final List<RestController> controllers;
  final Future<void> Function() init;

  @override
  List<Module> get childModules => modules;

  @override
  List<HttpMiddleware> get globalMiddlewares => middlewares;

  @override
  List<RestController> get controllersList => controllers;

  @override
  Future<void> Function() get initializer => init;
}

模块

每个模块都是应用业务的一个上下文包装器。每个模块可以有自己的控制器和中间件。

class TestModule extends Module {
  TestModule({super.preffix = "teste"});

  @override
  List<RestController> get controllers => [
        GameController(),
        ProfileController(),
      ];

  @override
  List<HttpMiddleware> get middlewares => [];
}

控制器

每个控制器都有一个前缀，你可以选择显式声明它或让 Scouter 自动处理类名来生成前缀。

@HttpController()
class ProfileController extends RestController {
  @Get("/:id")
  getById(HttpRequest request) {
    return ResponseSample();
  }

  @Get("/")
  get(HttpRequest request) {
    return ResponseSample();
  }
}

class ResponseSample {
  String message = "保存成功！";
  int savedId = 70;
  int httpStatus = 206;
}

路由

你可以通过注解给控制器方法添加所需的 HTTP 动词。

@HttpController()
class ProfileController extends RestController {
  @Get("/")
  get(HttpRequest request) {
    ...
  }

  @Post("/")
  save(HttpRequest request) {
    ...
  }
}

动态路由可以通过在路径中使用变量来实现。

@Get("/:id")
getById(HttpRequest request) {
  final id = request.params!["id"];
  ...
}

请求体解析

你可以自动解析自定义类的请求体。

@Post("/save/user")
saveUser(@Body() User user){
  return user;
}

查询参数

查询参数可以通过注解添加到方法参数中。

@Get("/query/:uuid")
search(String uuid, @QueryParam() Map queryParams) {
  return {
    "name": queryParams["name"],
  };
}

响应解析

响应可以返回 HttpResponse、Map 或自定义类。

class Profile {
  final int id = 1;
  final String name = "Anything";
  final List<String> tags = ["cool guy", "developer"];
  final String url = "https://pub.dev";

  Map<String, dynamic> toMap() => {
    "name": name,
    "tags": tags,
    "url": url,
  };
}

中间件

中间件可以用于整个应用或单个模块。

class ExampleMidleware implements HttpMiddleware {
  const ExampleMidleware();
  @override
  Future<Either<HttpResponse, void>> handle(HttpRequest request) async {
    if (request.path.contains("/game")) {
      return Left(
        HttpResponse(
          status: 400,
          body: {"status": "/game is not available"},
        ),
      );
    }
    return Right(null);
  }
}

依赖注入

Scouter 提供了一个依赖注入系统，可以通过 Injectable 混入来使用。

@HttpController()
class FeatureController extends RestController {
  FeatureController() {
    inject<FakeProvider>(
      SingletonInjection(
        FakeProvider(),
      ),
    );
  }

  @Post("/save")
  HttpResponse save(HttpRequest request) {
    final FakeProvider teste = injected();
    return HttpResponse(
      body: {
        "teste": teste.name,
      },
    );
  }
}

编译与部署

由于 Scouter 依赖于 dart:mirrors，因此不能以 AOT 方式编译。你可以将其编译为 Kernel 模块并运行。

dart compile kernel bin/your_app.dart

对于部署，建议使用 Docker 容器。

FROM dart:stable AS build

WORKDIR /app

COPY pubspec.* ./
RUN dart pub get

COPY . 

RUN dart pub get --offline
RUN dart compile kernel bin/server.dart -o bin/server

EXPOSE 3000
CMD ["dart", "run", "bin/server"]