Flutter控制器管理插件controller的使用

Flutter控制器管理插件controller的使用

Controller 插件介绍

Controller 是是一个库，它使您能够使用 Shelf 编写 HTTP 请求处理器。

功能

• 请求映射
• 验证
• 安全性

开始使用

在 pubspec.yaml 中添加 controller 库：

dependencies:
  controller: ^0.1.10+1
  json_annotation: ^4.8.0

dev_dependencies:
  build_runner: ^2.3.3
  controller_generator: ^0.1.8
  json_serializable: ^6.6.1

使用示例

1. 在处理请求的类上添加 @controller 注解。
2. 标注处理方法的 HTTP 动词（如 @Get, @Put, @Delete 等）。
3. 使用 @body 来反序列化 JSON 体到对象。
4. 前缀路径参数时使用冒号。

import 'package:controller/controller.dart';
import 'package:shelf/shelf.dart';

part 'todo_controller.g.dart';

@controller
class TodoController {
  @Post('/todos')
  Future<Response> addTodo(@body Todo todo) {
    // 实现代码
  }

  @Get('/todos/:id')
  Future<Response> getTodo(String id) {
    // 实现代码
  }
}

请求体

1. 将映射到请求体的类标注为 @validatable。
2. 标注字段以添加验证元数据。
3. 添加一个 fromJson() 工厂方法。

import 'package:controller/controller.dart';
import 'package:json_annotation/json_annotation.dart';

part 'todo.g.dart';

@validatable
@JsonSerializable(createToJson: false)
class Todo {
  @notEmpty
  final String id;
  @notEmpty
  final String description;

  Todo({
    required this.id,
    required this.description,
  });

  factory Todo.fromJson(Map<String, dynamic> json) => _$TodoFromJson(json);
}

验证

1. 验证元数据可以添加到请求体和控制器参数上。
2. 内置可用的验证器包括：
   • @Min(value) 和 @Max(value)
   • @Length(min, max)
   • @notEmpty
   • @Regex(pattern, description)
   • @Unique(existsPredicate)

返回响应

1. 您可以返回 Shelf Response 对象。
2. 当返回具有 toJson 方法的对象时，会返回一个带有 JSON 作为主体的 200 OK 响应。

import 'package:controller/controller.dart';
import 'package:shelf/shelf.dart';
import 'package:json_annotation/json_annotation.dart';

part 'todo_controller.g.dart';

@controller
class TodoController {
  @Post('/todos')
  // 返回 Future<void> 将返回一个空的 `200 OK ` 响应。
  Future<void> addTodo(@body Todo todo) {
    // 实现代码
  }

  @Get('/todos/:id')
  // 返回 Future&lt;A&gt; 将调用 A.toJson() 并返回一个带有 JSON 的主体的 ` 200 OK ` 响应。
  Future<Todo> getTodo(String id) {
    // 实现代码
  }
}

@JsonSerializable()
class Todo {
  @notEmpty
  final String id;
  @notEmpty
  final String description;

  Todo({
    required this.id,
    required this.description,
  });

  factory Todo.fromJson(Map<String, dynamic> json) => _$TodoFromJson(json);

  Map<String, dynamic> toJson() => _$TodoToJson(this);
}

安全性

1. 向您想要保护的安全端点添加 @Secured 注解。
2. @Secured 接受一个参数，该参数是请求必须遵守的条件。
3. 您可以使用现成的条件或编写自己的条件。

import 'package:controller/controller.dart';
import 'package:shelf/shelf.dart';

part 'todo_controller.g.dart';

@controller
class TodoController {
  @Post('/todos')
  // 检查用户是否具有“role”声明且值为“todo-editor”
  @Secured(HasClaim('role', 'todo-editor'))
  Future<Response> addTodo(@body Todo todo) {
    // 实现代码
  }

  @Get('/todos/:id')
  // 自定义条件定义如下
  @Secured(IsTodoOwner())
  Future<Response> getTodo(String id) {
    // 实现代码
  }
}

class IsTodoOwner extends SecurityCondition {
  const IsTodoOwner();

  @override
  Future<bool> evaluate(Map<String, dynamic> claims, // 找到在令牌或用户数据库中的声明
      Map<String, String> headers, // 请求头和参数
      ) async {
    final userId = claims['userId'];
    // 当 true 时，用户允许访问端点
    return userId != null && headers['id'].startsWith(userId);
  }
}

设置服务器

运行 dart run build_runner build 生成分发器构建者和验证器。

创建请求分发器并将其与 Shelf 连接起来：

import 'package:controller/controller.dart';
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'todo/todo_controller.dart';

void main() async {
  final todoController = TodoController();

  // 只有当您有安全控制器时才需要此参数
  final security = JwtSecurity(
    issuerUri: Uri.parse('https://issuer.uri.goes.here'),
    clientId: 'your-applications-client-id',
  );

  final dispatcher = createRequestDispatcher([
    // 只有带有 @Secured 方法的控制器才会接受安全参数
    TodoController$DispatcherBuilder(todoController, security),
  ]);
  final handler = Pipeline().addHandler(dispatcher);
  final server = await serve(handler, '0.0.0.0', 8080);
}