Flutter API集成插件apex_api的使用

Flutter API集成插件apex_api的使用

简介

apex_api 是一个用于集成 ApexTeam 服务器 API 的 Flutter 插件。通过该插件，开发者可以方便地与 ApexTeam 服务器进行通信，并处理各种请求。

使用示例

首先，确保在 pubspec.yaml 文件中添加 apex_api 依赖项：

dependencies:
  apex_api: ^版本号

然后运行 flutter pub get 来安装依赖项。

接下来，我们将展示如何使用 apex_api 插件来实现一个简单的 Flutter 应用程序。

主要代码示例

import 'package:apex_api/apex_api.dart';
import 'package:apex_api/cipher/models/key_pair.dart';
import 'package:flutter/material.dart';

// 创建一个全局导航键
GlobalKey<NavigatorState> navKey = GlobalKey<NavigatorState>();

void main() {
  // 初始化 ApexApi
  ApexApi.init();

  runApp(
    const RootRestorationScope(
      restorationId: 'root',
      child: MyApp(),
    ),
  );
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: navKey,
      builder: (context, child) {
        return ApiWrapper(
          config: const ApiConfig(
            'https://api.apexteam.net/k/faam/handler.php',
            languageCode: 'FA',
            privateVersion: 2,
            publicVersion: 2,
            useMocks: false,
            webKey: KeyPair(
                "jsGqL9HsDxGhtpFPpMSayS+Y2eGupAvncNVphSqdGbk=", """-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAwcTpqcXvQcPaq2JiWh2C
PvSc5aLdtdI2riqLnlFrmD0W0xEcDMTLkahUVyIecEjiR22wLa2F7chz6pNJqSdR
F7ImCgkibAVvPnXkRg2ghaiRHmoSGXFv+veWd/w9iQA+oqiM7CGYkGTyHC6MfI5E
ivVtXDkk7ftGZaFEUi3tJ34dE3ODxbuSQkHrJGg1OuqRiStfYQwBHkO0q8qCsG2v
505fL52FDLrFr1uvkVNvheZxL3ASVr9+Om+Y1OFrWIQl3bv2kVJPEyqG2AJHrIQ7
1K+K8Wrkpf1LRhwHk7G71jZ5L5HGgQ6ntNDFm6EnKf35HDWaRJ4o6OhWQClhHm+i
52Toi3+jL6QTstA5Sqj0u+WAuXMHncViblYecWNQI9WplFvpjlbUPPQ398l96Kzj
UU2ONZDJstfXyNAVxiSmkf58aI1ZIkB5e9a0mCDa/0eDFm0bHEFHU9XbyZ8qjyphe
vWMb7vQAQbcYzZTP9V5BXD29o5GXWIrxqDQhovkCAwEAAQ==
-----END PUBLIC KEY-----"""),
          ),
          navKey: navKey,
          loginStepHandler: print,
          messageHandler: (request, v) {
            showDialog(
              context: navKey.currentContext!,
              useRootNavigator: true,
              builder: (context) => AlertDialog(
                  title: Text(request.action.toString()),
                  content: Text('${v.success.toString()} ${request.isPrivate}')),
            );
          },
          child: child!,
        );
      },
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () async {
          final res = await context.http.post(
            SimpleRequest(5, isPublic: true),
            response: FetchProvinces.fromJson,
          );
        },
        child: const Icon(Icons.add),
      ),
    );
  }
}

代码解释

1. 初始化：

   ApexApi.init();
   

   在应用启动时调用 ApexApi.init() 方法进行初始化。

2. 配置 ApiWrapper：

   ApiWrapper(
     config: const ApiConfig(
       'https://api.apexteam.net/k/faam/handler.php',
       languageCode: 'FA',
       privateVersion: 2,
       publicVersion: 2,
       useMocks: false,
       webKey: KeyPair(...),
     ),
     navKey: navKey,
     loginStepHandler: print,
     messageHandler: (request, v) {
       showDialog(
         context: navKey.currentContext!,
         useRootNavigator: true,
         builder: (context) => AlertDialog(
           title: Text(request.action.toString()),
           content: Text('${v.success.toString()} ${request.isPrivate}'),
         ),
       );
     },
     child: child!,
   )
   

   配置 ApiWrapper 并设置相应的参数，包括 API 地址、语言代码、密钥等。

3. HTTP 请求：

   final res = await context.http.post(
     SimpleRequest(5, isPublic: true),
     response: FetchProvinces.fromJson,
   );