Flutter水管理插件aquedart的使用

Flutter水管理插件aquedart的使用

<aquedart> 是一个现代的Dart HTTP服务器框架。该框架由处理和路由HTTP请求的库、对象关系映射（ORM）、认证和授权（OAuth 2.0 提供者）以及文档（OpenAPI）组成。这些库用于构建在Dart虚拟机上运行的可扩展REST API。

如果你是第一次接触aquedart，可以查看教程。

入门指南

1. 安装Dart

   // 安装Dart
   

2. 激活aquedart

   // 激活aquedart
   pub global activate aquedart
   

3. 创建新项目

   // 创建新项目
   aquedart create my_project
   

打开项目目录到 IntelliJ IDE、Atom 或 Visual Studio Code。这三个IDE都有Dart插件。对于IntelliJ IDEA用户，有文件和代码模板。

教程、文档和示例

逐步教程对初学者可用 这里。

你可以在这里找到API参考 这里 或在 Dash 中安装它。

你可以在这里找到深入的概念性指南 这里。

不断扩大的aquedart示例库可以在 这里 找到。

如果你正在从aquedart 2.5迁移到aquedart 3.0，请参阅 迁移指南。

示例代码

/*
  这个示例演示了一个使用ORM和ORM支持的OAuth2提供者的HTTP应用程序。

  对于构建和运行非示例应用程序，安装'aquedart'命令行工具。

      pub global activate aquedart
      aquedart create my_app

  更多示例：https://github.com/stablekernel/aquedart_examples
 */

import 'dart:async';
import 'dart:io';
import 'package:aquedart/aquedart.dart';
import 'package:aquedart/managed_auth.dart';
import 'package:safe_yaml/safe_yaml.dart';

Future main() async {
  final app = Application<App>()
    ..options.configurationFilePath = 'config.yaml'
    ..options.port = 8888;

  await app.start(numberOfInstances: 3);
}

class App extends ApplicationChannel {
  ManagedContext? context;
  AuthServer? authServer;

  [@override](/user/override)
  Future prepare() async {
    final config = AppConfiguration.fromFile(File(options!.configurationFilePath!));
    final db = config.database;
    final persistentStore = PostgreSQLPersistentStore.fromConnectionInfo(
        db.username, db.password, db.host, db.port, db.databaseName);
    context = ManagedContext(
        ManagedDataModel.fromCurrentMirrorSystem(), persistentStore);

    authServer = AuthServer(ManagedAuthDelegate(context));
  }

  [@override](/user/override)
  Controller get entryPoint {
    return Router()
      ..route('/auth/token').link(() => AuthController(authServer))
      ..route('/users/[:id]')
          .link(() => Authorizer(authServer))!
          .link(() => UserController(context, authServer));
  }
}

class UserController extends ResourceController {
  UserController(this.context, this.authServer);

  final ManagedContext? context;
  final AuthServer? authServer;

  [@Operation](/user/Operation).get()
  Future<Response> getUsers() async {
    final query = Query<User>(context!);
    return Response.ok(await query.fetch());
  }

  [@Operation](/user/Operation).get('id')
  Future<Response> getUserById(@Bind.path('id') String id) async {
    final q = Query<User>(context!)..where((o) => o.id).equalTo(id);
    final user = await q.fetchOne();

    if (user == null) {
      return Response.notFound();
    }

    return Response.ok(user);
  }

  [@Operation](/user/Operation).post()
  Future<Response> createUser(@Bind.body() User user) async {
    if (user.username == null || user.password == null) {
      return Response.badRequest(
          body: {"error": "username and password required."});
    }

    final salt = AuthUtility.generateRandomSalt();
    final hashedPassword = authServer!.hashPassword(user.password!, salt);

    final query = Query<User>(context!)
      ..values = user
      ..values?.hashedPassword = hashedPassword
      ..values?.salt = salt
      ..values?.email = user.username;

    final u = await query.insert();
    final token = await authServer!.authenticate(
        u.username,
        query.values?.password,
        request!.authorization!.credentials!.username,
        request!.authorization!.credentials!.password);

    return AuthController.tokenResponse(token);
  }
}

class AppConfiguration extends Configuration {
  AppConfiguration.fromFile(File file) : super.fromFile(file);

  DatabaseConfiguration database = DatabaseConfiguration();
}

class User extends ManagedObject<_User>
    implements _User, ManagedAuthResourceOwner<_User> {
  [@Serialize](/user/Serialize)(input: true, output: false)
  String? password;
}

class _User extends ResourceOwnerTableDefinition {
  [@Column](/user/Column)(unique: true)
  String? email;
}