Flutter数据仓库管理插件repository的使用

Flutter数据仓库管理插件repository的使用

Repository

这是一个用于通过REST API获取远程数据的一体化解决方案，利用缓存和自动刷新的强大功能。

警告 ⚠️

此包目前正处于开发阶段，尚未准备好用于生产环境。我们的开发团队正在积极工作，并不断添加新功能和进行改进。

虽然我们正在努力使这个包尽可能稳定和可靠，但在添加新代码或修改现有代码时可能会出现错误或问题。我们鼓励您在此开发过程中报告遇到的任何问题，我们会尽快解决它们。

在继续开发此包的过程中，我们可能会对API或其他方面进行重大更改。我们将尽最大努力记录此类更改，并提供如何相应更新代码的指导。

感谢您的耐心和支持，因为我们致力于将此包成熟化。我们致力于交付高质量、可靠的包，以满足用户的需求，我们相信通过您的反馈和支持，我们可以实现这一目标。

安装 💻

❗ 为了开始使用Repository，您必须在机器上安装Dart SDK。

将repository添加到您的pubspec.yaml文件中：

dependencies:
  repository: ^3.0.0

安装它：

dart pub get

持续集成 🤖

Repository附带一个内置的GitHub Actions工作流，由Very Good Workflows驱动，但您也可以添加您首选的CI/CD解决方案。

开箱即用，在每次拉取请求和推送时，CI都会格式化、检查和测试代码。这确保了代码在您添加功能或进行更改时保持一致并正确运行。项目使用Very Good Analysis来进行严格的分析选项集，由我们的团队使用。代码覆盖率通过Very Good Workflows强制执行。

运行测试 🧪

要运行所有单元测试：

dart pub global activate coverage 1.2.0
dart test --coverage=coverage
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info

要查看生成的覆盖率报告，您可以使用lcov。

# 生成覆盖率报告
genhtml coverage/lcov.info -o coverage/

# 打开覆盖率报告
open coverage/index.html

完整示例Demo

以下是一个完整的Flutter应用示例，演示如何使用repository插件来管理数据仓库。

1. 添加依赖项

首先，在pubspec.yaml中添加repository依赖项：

dependencies:
  flutter:
    sdk: flutter
  repository: ^3.0.0
  http: ^0.13.3 # 用于HTTP请求

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

2. 创建数据模型

创建一个简单的数据模型类，例如User：

class User {
  final int id;
  final String name;

  User({required this.id, required this.name});

  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      id: json['id'],
      name: json['name'],
    );
  }
}

3. 创建Repository

创建一个UserRepository类来处理数据获取和缓存：

import 'package:repository/repository.dart';
import 'package:http/http.dart' as http;
import 'dart:convert';
import 'user.dart';

class UserRepository extends Repository<User> {
  [@override](/user/override)
  Future<List<User>> fetch() async {
    final response = await http.get(Uri.parse('https://jsonplaceholder.typicode.com/users'));
    if (response.statusCode == 200) {
      // 解析JSON数据
      List<dynamic> body = json.decode(response.body);
      List<User> users = body.map((dynamic item) => User.fromJson(item)).toList();
      return users;
    } else {
      throw Exception('Failed to load users');
    }
  }

  [@override](/user/override)
  String getId(User user) {
    return user.id.toString(); // 返回用户的唯一标识符
  }
}

4. 使用Repository

在Flutter应用中使用UserRepository来获取和显示用户数据：

import 'package:flutter/material.dart';
import 'user_repository.dart'; // 导入UserRepository
import 'user.dart'; // 导入User模型

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: UserListScreen(),
    );
  }
}

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

class _UserListScreenState extends State<UserListScreen> {
  late final UserRepository _userRepository;

  [@override](/user/override)
  void initState() {
    super.initState();
    _userRepository = UserRepository(); // 初始化UserRepository
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Users'),
      ),
      body: FutureBuilder<List<User>>(
        future: _userRepository.fetch(), // 获取用户数据
        builder: (context, snapshot) {
          if (snapshot.connectionState == ConnectionState.waiting) {
            return Center(child: CircularProgressIndicator());
          } else if (snapshot.hasError) {
            return Center(child: Text('Error: ${snapshot.error}'));
          } else if (!snapshot.hasData || snapshot.data!.isEmpty) {
            return Center(child: Text('No Users Found'));
          } else {
            final users = snapshot.data!;
            return ListView.builder(
              itemCount: users.length,
              itemBuilder: (context, index) {
                final user = users[index];
                return ListTile(
                  title: Text(user.name),
                  subtitle: Text('ID: ${user.id}'),
                );
              },
            );
          }
        },
      ),
    );
  }
}