Flutter集成Nimbus服务插件nimbus4flutter的使用

nimbus4flutter

nimbus4flutter 是一个用于开发与基于 Project Nimbus 构建的 Web 服务器通信的 Flutter 应用程序的库。它包含以下两个主要功能：

• [DataSet]，这是一个动态通用的 DTO（数据传输对象）。
• 服务器 API 的抽象层 [Api]。

开始使用

项目设置

首先，确保您的 Flutter 环境已正确配置，并且可以运行 Flutter 应用程序。

添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  nimbus4flutter: ^1.0.0 # 替换为最新版本号

然后运行以下命令以安装依赖：

flutter pub get

初始化 Nimbus 客户端

在您的 Flutter 项目中初始化 Nimbus 客户端。通常，建议在应用程序启动时进行初始化。

示例代码

import 'package:flutter/material.dart';
import 'package:nimbus4flutter/nimbus4flutter.dart';

void main() {
  // 初始化 Nimbus 客户端
  NimbusClient.initialize(
    baseUrl: "https://your-nimbus-server.com/api", // 替换为您的 Nimbus 服务器地址
    apiKey: "your-api-key", // 替换为您从 Nimbus 后台获取的 API 密钥
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

使用 DataSet 进行数据操作

DataSet 是一个动态的通用数据传输对象，您可以使用它来处理从 Nimbus 服务器获取的数据。

示例代码

import 'package:flutter/material.dart';
import 'package:nimbus4flutter/nimbus4flutter.dart';

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

class _HomeScreenState extends State<HomeScreen> {
  List<dynamic> _dataList = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    fetchData();
  }

  Future<void> fetchData() async {
    try {
      // 获取数据
      DataSet response = await NimbusClient.api.getData();

      // 将数据存储到列表中
      setState(() {
        _dataList = response.data;
      });
    } catch (e) {
      print("Error fetching data: $e");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Nimbus4Flutter 示例"),
      ),
      body: ListView.builder(
        itemCount: _dataList.length,
        itemBuilder: (context, index) {
          return ListTile(
            title: Text(_dataList[index].toString()),
          );
        },
      ),
    );
  }
}

使用 Api 抽象层调用接口

Api 是 Nimbus 服务的抽象层，通过它可以轻松调用服务器上的各种接口。

示例代码

import 'package:flutter/material.dart';
import 'package:nimbus4flutter/nimbus4flutter.dart';

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

class _HomeScreenState extends State<HomeScreen> {
  String _message = "";

  [@override](/user/override)
  void initState() {
    super.initState();
    callApi();
  }

  Future<void> callApi() async {
    try {
      // 调用服务器接口
      dynamic response = await NimbusClient.api.sendMessage({"text": "Hello Nimbus!"});

      // 处理响应
      setState(() {
        _message = response["message"];
      });
    } catch (e) {
      print("Error calling API: $e");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Nimbus4Flutter 示例"),
      ),
      body: Center(
        child: Text(_message),
      ),
    );
  }
}