Flutter网络操作插件net_kit的使用

net_kit 是一个用于Flutter应用的网络操作插件，提供了多种功能来简化网络请求和处理。本文将详细介绍如何使用 net_kit 插件进行网络操作。

目录

• 特性
• 赞助商
• 开始使用
  • 初始化
  • 扩展模型
  • 日志集成
• 发送请求
  • 请求单个模型
  • 请求模型列表
  • 发送空请求
• 认证方法
  • 凭据登录
  • 注册
  • 社交账号登录
  • 设置令牌
  • 用户登出
• 刷新令牌
  • 刷新令牌初始化
  • 刷新令牌示例
  • 刷新令牌的工作原理
• 计划增强
• 贡献
• 许可证

特性

• 自动刷新令牌
• 使用 INetKitModel 解析响应为模型或模型列表
• 可配置的开发和生产基础URL
• 国际化错误消息支持
• 认证支持（登录、注册、社交登录）

开始使用

初始化

首先，需要初始化 NetKitManager：

import 'package:net_kit/net_kit.dart';

final netKitManager = NetKitManager(
  baseUrl: 'https://api.<URL>.com',
  devBaseUrl: 'https://dev.<URL>.com',
  // 其他参数
);

扩展模型

请求如 requestModel 和 requestList 需要模型扩展 INetKitModel 并实现 fromJson 和 toJson 方法：

class TodoModel extends INetKitModel {
  int? id;
  String? title;
  bool? completed;

  TodoModel({this.id, this.title, this.completed});

  [@override](/user/override)
  TodoModel fromJson(Map<String, dynamic> json) {
    return TodoModel(
      id: json['id'],
      title: json['title'],
      completed: json['completed'],
    );
  }

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'title': title,
      'completed': completed,
    };
  }
}

日志集成

可以创建一个类实现 INetKitLogger 接口来进行自定义日志记录：

final netKitManager = NetKitManager(
  baseUrl: 'https://api.<URL>.com',
  logger: NetworkLogger(),
  // 其他参数
);

发送请求

请求单个模型

Future<TodoModel> getTodo(int id) async {
  try {
    final result = await netKitManager.requestModel<TodoModel>(
      path: '/todos/$id',
      method: RequestMethod.get,
      model: TodoModel(),
    );
    return result;
  } on ApiException catch (e) {
    throw Exception(e.message);
  }
}

请求模型列表

Future<List<TodoModel>> getTodoList() async {
  try {
    final result = await netKitManager.requestList<TodoModel>(
      path: '/todos',
      method: RequestMethod.get,
      model: TodoModel(),
    );
    return result;
  } on ApiException catch (e) {
    throw Exception(e.message);
  }
}

发送空请求

Future<void> deleteTodoById(int id) async {
  try {
    await netKitManager.requestVoid(
      path: '/todos/$id',
      method: RequestMethod.delete,
    );
  } on ApiException catch (e) {
    throw Exception(e.message);
  }
}

认证方法

凭据登录

Future<UserModel> loginWithCredentials(SignInRequestModel signInRequest) async {
  try {
    final result = await netKitManager.authenticate<UserModel>(
      path: '/auth/signin',
      method: RequestMethod.post,
      model: UserModel(),
      body: signInRequest.toJson(),
    );

    final user = result.$1;
    final authToken = result.$2;

    print('User signed in: ${user.name}');
    print('Access token: ${authToken.accessToken}');

    return user;
  } catch (e) {
    throw Exception('Login failed: $e');
  }
}

注册

Future<UserModel> signUpUser(SignUpRequestModel signUpRequest) async {
  try {
    final result = await netKitManager.authenticate<UserModel>(
      path: '/auth/signup',
      method: RequestMethod.post,
      model: UserModel(),
      body: signUpRequest.toJson(),
    );

    final user = result.$1;
    final authToken = result.$2;

    print('User signed up: ${user.name}');
    print('Access token: ${authToken.accessToken}');

    return user;
  } catch (e) {
    throw Exception('Sign up failed: $e');
  }
}

社交账号登录

Future<UserModel> loginWithGoogle(String googleAccessToken) async {
  try {
    final result = await netKitManager.authenticate<UserModel>(
      path: '/auth/social-login',
      method: RequestMethod.post,
      model: UserModel(),
      socialAccessToken: googleAccessToken,
    );

    final user = result.$1;
    final authToken = result.$2;

    print('User signed in with Google: ${user.name}');
    print('Access token: ${authToken.accessToken}');

    return user;
  } catch (e) {
    throw Exception('Google login failed: $e');
  }
}

设置令牌

void setTokens(String accessToken, String refreshToken) {
  netKitManager.setAccessToken(accessToken);
  netKitManager.setRefreshToken(refreshToken);
}

用户登出

void logoutUser() {
  netKitManager.removeAccessToken();
  netKitManager.removeRefreshToken();
}

刷新令牌

刷新令牌初始化

final netKitManager = NetKitManager(
  baseUrl: 'https://api.<URL>.com',
  devBaseUrl: 'https://dev.<URL>.com',
  loggerEnabled: true,
  testMode: true,
  refreshTokenPath: '/auth/refresh-token',
  onTokenRefreshed: (authToken) async {
    /// Save the new access token to the storage
  },
  // 其他参数
);

刷新令牌示例

请参考上述代码段中的 refreshTokenPath 和 onTokenRefreshed 参数。

刷新令牌的工作原理

当访问令牌过期时，NetKitManager 会自动检测并刷新令牌，确保无缝且不间断的API请求。

示例 Demo

以下是一个完整的示例Demo，展示了如何使用 net_kit 进行基本的CRUD操作：

import 'package:net_kit/net_kit.dart';
import 'core/logger/network_logger.dart';
import 'models/todo_model.dart';

void main() {
  final netKitManager = NetKitManager(
    baseUrl: 'https://jsonplaceholder.typicode.com',
  );

  const logger = NetworkLogger();

  TodoRemoteDataSourceImpl(netKitManager: netKitManager, logger: logger)
    ..getTodoList()
    ..getTodo(1)
    ..createTodo(TodoModel(id: 1, title: 'Test', userId: 1, completed: false))
    ..deleteTodoById(1);
}

abstract class TodoRemoteDataSource {
  Future<void> deleteTodoById(int id);
  Future<void> getTodoList();
  Future<void> getTodo(int id);
  Future<void> createTodo(TodoModel todo);
}

class TodoRemoteDataSourceImpl extends TodoRemoteDataSource {
  TodoRemoteDataSourceImpl({
    required INetKitManager netKitManager,
    required INetKitLogger logger,
  })  : _netKitManager = netKitManager,
        _logger = logger;

  final INetKitManager _netKitManager;
  final INetKitLogger _logger;

  [@override](/user/override)
  Future<void> deleteTodoById(int id) async {
    try {
      await _netKitManager.requestVoid(
        path: '/todos/$id',
        method: RequestMethod.delete,
      );
      _logger.debug('Todo deleted successfully');
    } on ApiException catch (e) {
      _logger.error(e.message);
    }
  }

  [@override](/user/override)
  Future<void> getTodo(int id) async {
    try {
      final todo = await _netKitManager.requestModel(
        path: '/todos/$id',
        method: RequestMethod.get,
        model: TodoModel(),
      );
      _logger.debug(todo.toString());
    } on ApiException catch (e) {
      _logger.error(e.message);
    }
  }

  [@override](/user/override)
  Future<void> getTodoList() async {
    try {
      final todos = await _netKitManager.requestList(
        path: '/todos',
        method: RequestMethod.get,
        model: TodoModel(),
      );
      _logger.info('Todos length: ${todos.length}');
    } on ApiException catch (e) {
      _logger.error(e.message);
    }
  }

  [@override](/user/override)
  Future<void> createTodo(TodoModel todo) async {
    try {
      final createdTodo = await _netKitManager.requestModel(
        path: '/todos',
        method: RequestMethod.post,
        model: TodoModel(),
        body: todo.toJson(),
      );
      _logger.debug('Created Todo: $createdTodo');
    } on ApiException catch (e) {
      _logger.error(e.message);
    }
  }
}