Flutter插件ivybaby_api的使用方法详解

Flutter插件ivybaby_api的使用方法详解

在本教程中，我们将详细介绍如何使用ivybaby_api插件。该插件可以帮助开发者快速生成API接口代码，并支持多种配置选项。

步骤1：添加依赖

在项目的pubspec.yaml文件中添加以下依赖项：

dependencies:
  ivybaby_api:
    git:
      url: 'https://github.com/johnshazhu/flutter_api_gen'
  json_annotation: ^3.1.1
  analyzer: ^0.40.6
  source_gen: ^0.9.8
  mustache: ^1.1.1
  dio: ^3.0.9
  crypto: ^2.0.6

dev_dependencies:
  json_serializable: ^3.5.0
  build_runner: ^1.10.6

flutter:
  assets:
    - assets/config.json

完成后，运行flutter pub get以安装依赖项。

步骤2：配置config.json

在项目中创建assets/config.json文件，并添加以下内容：

{
  "base": "https://www.test1.com",
  "mallBase": "https://www.test2.com",
  "tokenUrl": "/ouser-services/token/thirdLogin",
  "proxy": "",
  "signStr": ""
}

步骤3：定义API接口

创建一个类并使用@Api注解来定义API接口。例如：

import 'package:ivybaby_api/api/base/api_base.dart';
import 'package:ivybaby_api/api/config/api_config.dart';

@Api('${ApiConfig.mallBase}', mergeByBaseUrl: false)
abstract class CmsApi {
  @Api('/cms/page/module/queryModulePromotion.do', data: {
    'itemsPerPage': 10,
    'companyId': '@C_AppConfig.COMPANY_ID',
    'lang': 'zh_CN',
    'platformId': '@C_AppConfig.PLATFORM_ID'
  }, method: Api.GET)
  Future<QueryModuleRsp> queryModuleData(int moduleId);
}

注解说明：

  • @Api：用于修饰类或抽象方法。
    • url：定义接口的baseUrl。
    • target：指定生成的实现类名称。
    • mergeByBaseUrl：是否按baseUrl分类合并生成的文件。

步骤4：配置生成规则

使用@ApiExtension注解来定义生成的接口文件信息：

@ApiExtension(className: 'ApiImpls')
class ExtensionApi {}

@ApiExtension(className: 'MallApiImpls', key: '${ApiConfig.mallBase}')
class MallApis {}

注解说明：

  • @ApiExtension：用于修饰类。
    • className：生成文件的类名。
    • key：配合@Api中的mergeByBaseUrl使用。
    • on：指定生成的文件名（默认为ApiUtils）。

步骤5：生成代码

运行以下命令以生成代码：

flutter packages pub run build_runner build

步骤6：使用生成的API

在main.dart中使用生成的API：

import 'package:flutter/material.dart';
import 'package:ivybaby_api/api/base/api_base.dart';
import 'package:ivybaby_api/api/config/api_config.dart';
import 'package:ivybaby_api/api/config/global_data.dart';
import 'package:ivybaby_api_example/util/extension.api.impls.dart';

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

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    GlobalData.appDevice.deviceNo = 'B4:F1:DA:B3:48:39';
    GlobalData.appDevice.uuid = '19d430e3-08dd-4a38-9dc9-e829f87bb28f';
    GlobalData.appDevice.loginType = '5';
    ApiConfig.inst.init();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Example app'),
        ),
        body: Center(
          child: GestureDetector(
            onTap: () {
              ApiUtils.inst.identityAuth('', '');
            },
            child: Text('Flutter api gen'),
          ),
        ),
      ),
    );
  }
}

关键点：

  • GlobalData：全局设备信息。
  • ApiConfig：API配置管理。
  • ApiUtils：生成的API工具类。

完整示例

以下是完整的代码结构：

config.json

{
  "base": "https://www.test1.com",
  "mallBase": "https://www.test2.com",
  "tokenUrl": "/ouser-services/token/thirdLogin",
  "proxy": "",
  "signStr": ""
}

CmsApi.dart

import 'package:ivybaby_api/api/base/api_base.dart';
import 'package:ivybaby_api/api/config/api_config.dart';

@Api('${ApiConfig.mallBase}', mergeByBaseUrl: false)
abstract class CmsApi {
  @Api('/cms/page/module/queryModulePromotion.do', data: {
    'itemsPerPage': 10,
    'companyId': '@C_AppConfig.COMPANY_ID',
    'lang': 'zh_CN',
    'platformId': '@C_AppConfig.PLATFORM_ID'
  }, method: Api.GET)
  Future<QueryModuleRsp> queryModuleData(int moduleId);
}

extension.api.impls.dart

@ApiExtension(className: 'ApiImpls')
class ExtensionApi {}

@ApiExtension(className: 'MallApiImpls', key: '${ApiConfig.mallBase}')
class MallApis {}

main.dart

import 'package:flutter/material.dart';
import 'package:ivybaby_api/api/base/api_base.dart';
import 'package:ivybaby_api/api/config/api_config.dart';
import 'package:ivybaby_api/api/config/global_data.dart';
import 'package:ivybaby_api_example/util/extension.api.impls.dart';

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

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    GlobalData.appDevice.deviceNo = 'B4:F1:DA:B3:48:39';
    GlobalData.appDevice.uuid = '19d430e3-08dd-4a38-9dc9-e829f87bb28f';
    GlobalData.appDevice.loginType = '5';
    ApiConfig.inst.init();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Example app'),
        ),
        body: Center(
          child: GestureDetector(
            onTap: () {
              ApiUtils.inst.identityAuth('', '');
            },
            child: Text('Flutter api gen'),
          ),
        ),
      ),
    );
  }
}

更多关于Flutter插件ivybaby_api的使用方法详解的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter插件ivybaby_api的使用方法详解的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


ivybaby_api 是一个未知的 Flutter 插件，可能是一个内部或第三方开发的插件，用于特定的功能或服务。由于它不是 Flutter 官方或广泛使用的插件，因此无法提供具体的使用文档或示例代码。以下是一些通用的步骤和建议，帮助你了解和使用未知的 Flutter 插件。

1. 查找插件的文档

首先，尝试查找 ivybaby_api 的官方文档或 README 文件。通常，插件的文档会包含以下内容：

  • 插件的功能描述
  • 安装方法
  • 使用示例
  • API 参考
  • 常见问题解答

你可以在以下地方查找文档：

  • 插件的 GitHub 仓库
  • pub.dev 上的插件页面
  • 插件的官方网站或开发者提供的文档链接

2. 安装插件

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

dependencies:
  ivybaby_api: ^版本号

然后运行 flutter pub get 来安装插件。

3. 导入插件

在你的 Dart 文件中导入插件：

import 'package:ivybaby_api/ivybaby_api.dart';

4. 初始化插件

根据插件的文档，可能需要在 main.dart 或某个初始化函数中初始化插件。例如：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await IvyBabyApi.initialize(); // 假设插件有 initialize 方法
  runApp(MyApp());
}

5. 使用插件的功能

根据插件的功能，调用相应的方法或使用提供的组件。以下是一个假设的示例：

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('IvyBaby API Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              var result = await IvyBabyApi.someMethod(); // 假设插件有 someMethod 方法
              print(result);
            },
            child: Text('Call API'),
          ),
        ),
      ),
    );
  }
}
回到顶部