Flutter网络请求插件simple_rest_service的使用

Flutter网络请求插件simple_rest_service的使用

简介

simple_rest_service 是一个封装了REST API接口的Flutter插件，旨在简化应用程序端的REST API集成。该插件基于 Dio 包，并参考了 restbase 包的设计。

入门指南

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 simple_rest_service 依赖：

dependencies:
  simple_rest_service: ^0.1.0

2. 创建Rest API客户端类

你需要为每个API上下文创建一个类，并通过 baseUrl 进行区分。以下是一个示例，展示了如何创建一个名为 TaskRestApi 的类：

import 'package:simple_rest_service/simple_rest_service.dart';

class TaskRestApi extends RestService {
  TaskRestApi() : super('https://your-task-api/api') { 
    // 添加拦截器以在调试控制台中查看事件
    addInterceptor(PrintLogInterceptor()); 
    
    // 可选：添加拦截器以在请求中添加访问令牌
    addInterceptor(AuthInterceptor( 
      getToken: () async => (await FirebaseAuth.instance.currentUser?.getIdToken()) ?? '',
    ));
  }
}

3. 使用Rest API客户端类

创建好 TaskRestApi 类后，你可以调用 getModel, getList, postModel, postList 等方法来与API进行交互。以下是一个示例，展示了如何创建任务：

import 'package:simple_rest_service/simple_rest_service.dart';

class TaskItemModel {
  final String id;
  final String title;
  final String description;

  TaskItemModel({required this.id, required this.title, required this.description});

  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'title': title,
      'description': description,
    };
  }

  factory TaskItemModel.fromMap(Map<String, dynamic> json) {
    return TaskItemModel(
      id: json['id'],
      title: json['title'],
      description: json['description'],
    );
  }
}

Future<TaskItemModel> createTask(TaskItemModel item) async {
  final _taskRest = TaskRestApi();
  
  final result = await _taskRest.postModel<TaskItemModel>(
    '/task', // API的端点路径
    item.toMap(), // 请求体
    (json) => TaskItemModel.fromMap(json!), // 将返回的JSON转换为对象
  );

  if (result.success) {
    return result.data; // 返回TaskItemModel对象
  } else {
    // 抛出自定义异常，这里假设 `GeneralAppFailure` 是你应用中的一个已知异常类
    throw GeneralAppFailure()
      ..message = result.exception?.message
      ..statusCode = result.statusCode;
  }
}

完整示例Demo

以下是一个完整的示例项目，展示了如何在Flutter应用中使用 simple_rest_service 插件：

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

// 定义任务模型
class TaskItemModel {
  final String id;
  final String title;
  final String description;

  TaskItemModel({required this.id, required this.title, required this.description});

  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'title': title,
      'description': description,
    };
  }

  factory TaskItemModel.fromMap(Map<String, dynamic> json) {
    return TaskItemModel(
      id: json['id'],
      title: json['title'],
      description: json['description'],
    );
  }
}

// 定义任务API客户端
class TaskRestApi extends RestService {
  TaskRestApi() : super('https://your-task-api/api') { 
    addInterceptor(PrintLogInterceptor()); 
    addInterceptor(AuthInterceptor( 
      getToken: () async => (await FirebaseAuth.instance.currentUser?.getIdToken()) ?? '',
    ));
  }
}

// 创建任务的方法
Future<TaskItemModel> createTask(TaskItemModel item) async {
  final _taskRest = TaskRestApi();
  
  final result = await _taskRest.postModel<TaskItemModel>(
    '/task',
    item.toMap(),
    (json) => TaskItemModel.fromMap(json!),
  );

  if (result.success) {
    return result.data!;
  } else {
    throw Exception('Failed to create task: ${result.exception?.message}');
  }
}

// 主页面
class HomePage extends StatefulWidget {
  const HomePage({super.key});

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  final TextEditingController _titleController = TextEditingController();
  final TextEditingController _descriptionController = TextEditingController();
  String _statusMessage = '';

  Future<void> _createTask() async {
    try {
      final task = TaskItemModel(
        id: DateTime.now().millisecondsSinceEpoch.toString(),
        title: _titleController.text,
        description: _descriptionController.text,
      );

      await createTask(task);
      setState(() {
        _statusMessage = 'Task created successfully!';
      });
    } catch (e) {
      setState(() {
        _statusMessage = 'Failed to create task: $e';
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Create Task'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _titleController,
              decoration: const InputDecoration(labelText: 'Title'),
            ),
            TextField(
              controller: _descriptionController,
              decoration: const InputDecoration(labelText: 'Description'),
            ),
            const SizedBox(height: 20),
            ElevatedButton(
              onPressed: _createTask,
              child: const Text('Create Task'),
            ),
            const SizedBox(height: 20),
            Text(_statusMessage),
          ],
        ),
      ),
    );
  }
}

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Simple Rest Service Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const HomePage(),
    );
  }
}