Flutter功能扩展插件katana_functions的使用

Katana Functions

用于服务器集成的适配器插件，例如Firebase Cloud Functions。

在客户端实现了与API的接口，并允许安全地与服务器进行交互。

安装

导入以下包：

flutter pub add katana_functions

如果你使用Firebase Cloud Functions，还需要导入以下包：

flutter pub add katana_functions_firebase

实现

预备工作

始终将FunctionsAdapterScope小部件放在应用程序的根附近。

传递一个FunctionsAdapter，如RuntimeFunctionsAdapter作为适配器参数。

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return FunctionsAdapterScope(
      adapter: const RuntimeFunctionsAdapter(),
      child: MaterialApp(
        home: const FunctionsPage(),
        title: "Flutter Demo",
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
      ),
    );
  }
}

创建函数

创建函数的前提条件如下：

• 服务器端已经实现并部署。
• 服务器端的所有输入/输出都是通过JsonMap (Map<String, dynamic>)完成的。
• 如果通信不成功，则返回Exception。

只要满足上述条件，可以使用任何通信格式，如CloudFunctions、RestAPI、GraphQL、gRPC等。（差异可以通过FunctionsAdapter吸收）

继承抽象类FunctionsAction<TResponse>和FunctionsActionResponse来创建函数。

在FunctionsAction的action中定义函数的操作名称。

根据从服务器返回的值创建响应toResponse(DynamicMap map)。

class TestFunctionsAction extends FunctionsAction<TestFunctionsActionResponse> {
  const TestFunctionsAction({
    required this.responseMessage,
  });

  final String responseMessage;

  [@override](/user/override)
  String get action => "test";

  [@override](/user/override)
  DynamicMap? toMap() {
    return {
      "message": responseMessage,
    };
  }

  [@override](/user/override)
  TestFunctionsActionResponse toResponse(DynamicMap map) {
    return TestFunctionsActionResponse(
      message: map["message"] as String,
    );
  }
}

class TestFunctionsActionResponse extends FunctionsActionResponse {
  const TestFunctionsActionResponse({required this.message});

  final String message;
}

使用函数

创建一个Functions对象，并将要执行的FunctionAction传递给execute方法。

如果执行成功，将在execute的返回值中返回指定的响应。

final functions = Functions();
final response = await functions.execute(
  TestFunctionsAction(responseMessage: "Response"),
);
print(response?.message); // "Response"

FunctionsAdapter

可用的FunctionsAdapter如下：

• RuntimeFunctionsAdapter：不进行服务器处理且不会出错的FunctionsAdapter。可用于存根。
• FirebaseFunctionsAdapter：用于使用FirebaseFunctions的FunctionsAdapter，其中action是函数的名称。

通过继承FunctionsAdapter也可以与自己准备的RestAPI、GraphQL、gRPC连接。

GitHub Sponsors

欢迎赞助。感谢您的支持！

在GitHub Sponsors上赞助@mathrunet

## 示例代码


<p style="font-family: monospace"><b>example/lib/main.dart</b></p>

```dart
// Flutter imports:
import 'package:flutter/material.dart';

// Package imports:
import 'package:katana_functions/katana_functions.dart';

void main() {
  runApp(const MyApp());
}

class TestFunctionsAction extends FunctionsAction<TestFunctionsActionResponse> {
  const TestFunctionsAction({
    required this.responseMessage,
  });

  final String responseMessage;

  [@override](/user/override)
  String get action => "test";

  [@override](/user/override)
  DynamicMap? toMap() {
    return {
      "message": responseMessage,
    };
  }

  [@override](/user/override)
  TestFunctionsActionResponse toResponse(DynamicMap map) {
    return TestFunctionsActionResponse(
      message: map["message"] as String,
    );
  }
}

class TestFunctionsActionResponse extends FunctionsActionResponse {
  const TestFunctionsActionResponse({required this.message});

  final String message;
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return FunctionsAdapterScope(
      adapter: const RuntimeFunctionsAdapter(),
      child: MaterialApp(
        home: const FunctionsPage(),
        title: "Flutter Demo",
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
      ),
    );
  }
}

class FunctionsPage extends StatefulWidget {
  const FunctionsPage({super.key});

  [@override](/user/override)
  State<StatefulWidget> createState() => FunctionsPageState();
}

class FunctionsPageState extends State<FunctionsPage> {
  final functions = Functions();

  [@override](/user/override)
  void initState() {
    super.initState();
    functions.addListener(_handledOnUpdate);
  }

  void _handledOnUpdate() {
    setState(() {});
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
    functions.removeListener(_handledOnUpdate);
    functions.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text("App Demo")),
      body: ListView(
        children: [
          ListTile(
            title: const Text("Test Functions"),
            onTap: () async {
              final response = await functions.execute(
                const TestFunctionsAction(responseMessage: "success"),
              );
              debugPrint(response?.message); // "success"
            },
          )
        ],
      ),
    );
  }
}