Flutter文件上传插件uploadthing的使用

UploadThing Dart SDK

一个非官方的Dart/Flutter SDK，用于UploadThing API，提供无缝的文件上传功能。此包允许你通过UploadThing服务轻松地将文件上传功能集成到你的Dart或Flutter应用程序中。

特性

• 轻松上传单个或多个文件。
• 跟踪上传进度并管理文件数据。
• 支持各种文件类型和操作，如重命名和删除文件。
• 检索和显示应用信息和使用统计。

使用方法

导入包

import 'package:uploadthing/uploadthing.dart';
import 'dart:io';

初始化和上传文件

void main() async {
  // 使用你的实际API密钥替换
  final uploadThing = UploadThing('YOUR_API_KEY');

  // 文件列表
  List<File> files = [
    File('path/to/file1.jpg'),
    File('path/to/file2.png'),
  ];

  try {
    // 执行文件上传
    bool isUploaded = await uploadThing.uploadFiles(files);
    if (isUploaded) {
      print('Files uploaded successfully');
      print('Uploaded Files Data: ${uploadThing.uploadedFilesData}');
    }
  } catch (e) {
    print('Upload failed: $e');
  }
}

跟踪上传进度

print('Uploaded ${uploadThing.uploadedFiles} of ${uploadThing.totalFiles} files');

访问上传的文件数据

for (var fileData in uploadThing.uploadedFilesData) {
  print('File URL: ${fileData['url']}');
}

API参考

类

UploadThing

处理文件上传和与UploadThing API交互的主要类。

• 构造函数: UploadThing(String apiKey)
  • 初始化实例并传入API密钥。

方法

1. Future<bool> uploadFiles(List<File> files)

   • 上传文件列表到API。
   • 参数:
     • files: File对象列表。
   • 返回值: 成功时返回true，否则抛出Exception。

2. Future<List<UploadThingFile>> listFiles({int limit = 500, int offset = 0})

   • 获取已上传文件列表。
   • 参数:
     • limit: 最大文件数（默认为500）。
     • offset: 跳过的文件数。
   • 返回值: UploadThingFile对象列表。

3. Future<bool> renameFile(String fileKey, String newName)

   • 在服务器上重命名文件。
   • 参数:
     • fileKey: 文件标识符。
     • newName: 新文件名。
   • 返回值: 成功时返回true，否则抛出Exception。

4. Future<bool> renameFiles(List<Map<String, String>> updates)

   • 重命名多个文件。
   • 参数:
     • updates: 包含文件键和新名称的映射列表。
   • 返回值: 成功时返回true，否则抛出Exception。

5. Future<bool> deleteFile(String fileKey)

   • 删除文件。
   • 参数:
     • fileKey: 文件标识符。
   • 返回值: 成功时返回true，否则抛出Exception。

6. Future<bool> deleteFiles(List<String> fileKeys)

   • 删除多个文件。
   • 参数:
     • fileKeys: 文件标识符列表。
   • 返回值: 成功时返回true，否则抛出Exception。

7. Future<AppInfo> getAppInfo()

   • 获取应用程序信息。
   • 返回值: 包含应用程序详细信息的AppInfo对象。

8. String getFileUrl(String key)

   • 根据文件键获取文件URL。
   • 参数:
     • key: 文件唯一标识符。
   • 返回值: 构建的文件URL。

9. Future<UsageInfo> getUsageInfo()

   • 获取应用程序使用情况信息。
   • 返回值: 包含使用统计信息的UsageInfo对象。

类详情

AppInfo

包含应用程序信息。

• 属性:
  • appId: 应用程序ID。
  • defaultACL: 默认访问控制列表。
  • allowACLOverride: 是否允许ACL覆盖。

UploadThingFile

表示上传到UploadThing的文件。

• 属性:
  • id: 文件ID。
  • key: 文件唯一标识符。
  • name: 文件名。
  • customId: 文件自定义标识符。
  • status: 文件状态。

UsageInfo

提供应用程序使用统计信息。

• 属性:
  • totalBytes: 总字节数。
  • appTotalBytes: 应用程序使用的总字节数。
  • filesUploaded: 已上传文件数量。
  • limitBytes: 应用程序字节限制。

示例用法

上传多个文件

void main() async {
  final uploadThing = UploadThing('YOUR_API_KEY');

  List<File> files = [
    File('path/to/file1.jpg'),
    File('path/to/file2.png'),
  ];

  try {
    bool isUploaded = await uploadThing.uploadFiles(files);
    if (isUploaded) {
      print('Files uploaded successfully');
    }
  } catch (e) {
    print('Upload failed: $e');
  }
}

列出文件

void listFiles() async {
  final uploadThing = UploadThing('YOUR_API_KEY');
  try {
    List<UploadThingFile> files = await uploadThing.listFiles(limit: 10);
    files.forEach((file) {
      print('File: ${file.name}, Status: ${file.status}');
    });
  } catch (e) {
    print('Error: $e');
  }
}

重命名文件

void renameFileExample() async {
  final uploadThing = UploadThing('YOUR_API_KEY');
  try {
    bool response = await uploadThing.renameFile("exampleKey", "newName.jpg");
    if (response) {
      print('File renamed successfully');
    }
  } catch (e) {
    print('Error: $e');
  }
}

删除文件

void deleteFileExample() async {
  final uploadThing = UploadThing('YOUR_API_KEY');
  try {
    bool response = await uploadThing.deleteFile("exampleKey");
    if (response) {
      print('File deleted successfully');
    }
  } catch (e) {
    print('Error: $e');
  }
}