Flutter插件kinfolk的使用方法

Flutter插件kinfolk的使用方法

Flutter插件kinfolk简介

kinfolk 是一个用于与基于CUBA平台的后端集成的新Flutter包。

Flutter插件kinfolk特性

• 通过Rest Api进行授权，使用用户名和密码。
• 存储并重用访问令牌。
• 遵守CUBA文档中的REST API规范。（目前部分支持）

Flutter插件kinfolk安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  flutter:
    sdk: flutter
  kinfolk: ^0.0.4

然后运行以下命令来获取包：

flutter packages get

示例

以下是一个完整的示例，展示了如何使用 kinfolk 插件。

import 'package:flutter/material.dart';
import 'package:kinfolk/kinfolk.dart';
import 'package:path_provider/path_provider.dart'; // 用于获取目录路径

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

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late Future<bool> _future;

  // 初始化kinfolk服务
  late Kinfolk kinfolk;

  [@override](/user/override)
  void initState() {
    kinfolk = Kinfolk();
    _future = _setUpKinfolk();
    super.initState();
  }

  Future<bool> _setUpKinfolk() async {
    // 设置服务器URL和安全密钥
    kinfolk.initializeBaseVariables(
      "http://localhost:8080/test", // 服务器地址
      "client", // 客户端标识符
      "secret", // 客户端密钥
      (await getApplicationDocumentsDirectory()).path // 应用程序文档目录
    );
    return true;
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return FutureBuilder<bool>(
      future: _future,
      builder: (context, snapshot) => MaterialApp(
        title: 'Flutter Demo',
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        home: MyHomePage(title: 'Flutter Demo Home Page', kinfolk: kinfolk),
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title, required this.kinfolk}) : super(key: key);

  final String title;
  final Kinfolk kinfolk;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late Future<List<dynamic>> _future;

  [@override](/user/override)
  void initState() {
    _future = loadDataList();
    super.initState();
  }

  Future<List<dynamic>> loadDataList() async {
    // 获取客户端（带有访问令牌的服务）
    oauth2.Client client = await widget.kinfolk.getToken("admin", "admin");

    // 获取单个模型
    ToDoList model = await Kinfolk.getSingleModelRest(
      serviceName: "test_SomeService",
      methodName: "getToDoList",
      type: Types.services,
      fromMap: (Map<String, dynamic> val) => ToDoList.fromMap(val),
    );

    // 获取带请求体的单个模型
    String body = '''
    {
      "monday": "work",
      "sunday": "relax"
    }
    ''';
    ToDoList modelWithBody = await Kinfolk.getSingleModelRest(
      serviceName: "test_SomeService",
      methodName: "getToDoList",
      type: Types.services,
      body: body,
      fromMap: (Map<String, dynamic> val) => ToDoList.fromMap(val),
    );

    // 获取模型列表
    List<dynamic> modelsList = await Kinfolk.getListModelRest(
      serviceName: "test_SomeService",
      methodName: "getToDoList",
      type: Types.services,
      fromMap: (Map<String, dynamic> val) => ToDoList.fromMap(val),
    );

    // 获取带请求体的模型列表
    List<dynamic> modelsListWithBody = await Kinfolk.getListModelRest(
      serviceName: "test_SomeService",
      methodName: "getToDoList",
      type: Types.services,
      body: body,
      fromMap: (Map<String, dynamic> val) => ToDoList.fromMap(val),
    );

    return modelsListWithBody;
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: FutureBuilder<List<dynamic>>(
        future: _future,
        builder: (context, snapshot) {
          if (!snapshot.hasData) {
            return const Center(child: CircularProgressIndicator());
          }
          return ListView.builder(
            itemCount: snapshot.data?.length ?? 0,
            itemBuilder: (context, index) {
              var item = (snapshot.data ?? [])[index];
              return ListTile(
                title: Text(item['id'] ?? ''),
                subtitle: Text(item['name'] ?? ''),
              );
            },
          );
        },
      ),
    );
  }
}