qiniu_flutter_sdk 0.8.0

Qiniu Flutter sdk

example/lib/main.dart

import 'dart:convert';
import 'dart:io';

import 'package:file_picker/file_picker.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:qiniu_flutter_sdk/qiniu_flutter_sdk.dart';

import 'utils/uint.dart';
import 'widgets/app.dart';
import 'widgets/console.dart';
import 'widgets/dispose.dart';
import 'widgets/progress.dart';
import 'widgets/select_file.dart';
import 'widgets/string_input.dart';

void main() {
  runApp(const App(child: Base()));
}

// 基础的上传示例
class Base extends StatefulWidget implements Example {
  const Base({super.key});

  @override
  String get title => '基础上传示例';

  @override
  State<Base> createState() {
    return BaseState();
  }
}

class BaseState extends State<Base> with DisposableState {
  /// storage 实例
  final storage = Storage();

  // 控制器，可以用于取消任务、获取上述的状态，进度等信息
  PutController? putController;

  // 用户输入的文件名
  String? key;

  // 用户输入的 mimeType
  String? mimeType;

  // 用户输入的 partSize
  int partSize = 1;

  // 用户输入的 token
  // 运行示例前请通过界面上方的输入框填入有效的上传 token，
  // 切勿在源码中硬编码生产环境 token。
  String? token;

  /// 当前选择的文件
  PlatformFile? selectedFile;

  // 当前的进度
  double progressValue = 1;

  // 当前的任务状态
  StorageStatus? statusValue;

  void onStatus(StorageStatus status) {
    printToConsole('状态变化: 当前任务状态：${status.toString()}');
    setState(() => statusValue = status);
  }

  void onProgress(double percent) {
    setState(() => progressValue = percent);
    printToConsole('任务进度变化：进度：${percent.toStringAsFixed(4)}');
  }

  void onSendProgress(double percent) {
    // setState(() => progressValue = percent);
    printToConsole('实际发送变化：进度：${percent.toStringAsFixed(4)}');
  }

  void printToConsole(String? message) {
    if (message == null || message == '') {
      return;
    }

    debugPrint(message);
    Console.of(context).print(message);
  }

  void startUpload() {
    printToConsole('创建 PutController');
    putController = PutController();

    printToConsole('添加实际发送进度订阅');
    addDisposer(putController!.addSendProgressListener(onSendProgress));

    printToConsole('添加任务进度订阅');
    addDisposer(putController!.addProgressListener(onProgress));

    printToConsole('添加状态订阅');
    addDisposer(putController!.addStatusListener(onStatus));

    var usedToken = token;
    if (usedToken == null || usedToken == '') {
      printToConsole('token 不能为空');
      return;
    }

    if (selectedFile == null) {
      printToConsole('请选择文件');
      return;
    }

    printToConsole('开始上传文件');

    final putOptions = PutOptions(
        key: key,
        mimeType: mimeType,
        partSize: partSize,
        controller: putController,
        forceBySingle: false,
        maxPartsRequestNumber: 3);

    final upload = kIsWeb
        ? storage.putBytes(selectedFile!.bytes!, usedToken, options: putOptions)
        : storage.putFile(
            File(selectedFile!.path!),
            usedToken,
            options: putOptions,
          );

    final startTime = DateTime.now();
    upload
      ..then((PutResponse response) {
        final duration = DateTime.now().difference(startTime);
        printToConsole(
            '上传成功，耗时: ${duration.inMilliseconds} 毫秒 速度： ${humanizeFileSize(selectedFile!.size * 1000 / duration.inMilliseconds.toDouble())}/s');
        printToConsole('上传已完成: 原始响应数据: ${jsonEncode(response.rawData)}');
        printToConsole('------------------------');
      })
      ..catchError((dynamic error) {
        final duration = DateTime.now().difference(startTime);
        printToConsole('上传失败，耗时: ${duration.inMilliseconds} 毫秒');
        if (error is StorageError) {
          switch (error.type) {
            case StorageErrorType.CONNECT_TIMEOUT:
              printToConsole('发生错误: 连接超时');
              break;
            case StorageErrorType.SEND_TIMEOUT:
              printToConsole('发生错误: 发送数据超时');
              break;
            case StorageErrorType.RECEIVE_TIMEOUT:
              printToConsole('发生错误: 响应数据超时');
              break;
            case StorageErrorType.RESPONSE:
              printToConsole('发生错误: ${error.message}');
              break;
            case StorageErrorType.CANCEL:
              printToConsole('发生错误: 请求取消');
              break;
            case StorageErrorType.RESOURCE_READ_EXCEPTION:
              printToConsole('发生错误: 资源读取异常');
              break;
            case StorageErrorType.UNKNOWN:
              printToConsole('发生错误: 未知错误');
              break;
            case StorageErrorType.NO_AVAILABLE_HOST:
              printToConsole('发生错误: 无可用 Host');
              break;
            case StorageErrorType.NO_AVAILABLE_REGION:
              printToConsole('发生错误: 无可用 Region');
              break;
            case StorageErrorType.IN_PROGRESS:
              printToConsole('发生错误: 已在队列中');
              break;
          }
        } else {
          printToConsole('发生错误: ${error.toString()}');
        }

        printToConsole('-----------上传结束-------------');
        return PutResponse.fromJson({'error': error});
      });
  }

  void onSelectedFile(PlatformFile file) {
    if (kIsWeb) {
      printToConsole('选中文件: filename: ${file.name}, size: ${file.size}');
    } else {
      printToConsole(
        '选中文件: path: ${file.path}, filename: ${file.name}, size: ${file.size}',
      );
    }

    if (file.size != 0) {
      // 一般在非 web 平台上可以直接读取 size 属性
      printToConsole('文件尺寸：${humanizeFileSize(file.size.toDouble())}');
    } else if (file.bytes != null) {
      printToConsole('文件尺寸：${humanizeFileSize(file.bytes!.length.toDouble())}');
    }

    setState(() {
      printToConsole('设置 selectedFile');
      selectedFile = file;

      startUpload();
    });
  }

  void onPartSizeChange(String partSize) {
    if (partSize == '') {
      printToConsole('设置默认 partSize');
      this.partSize = 4;
      return;
    }

    printToConsole('设置 partSize: $partSize');
    this.partSize = int.parse(partSize);
  }

  void onTokenChange(String token) {
    if (token == '') {
      printToConsole('清除 token');
      this.token = null;
      return;
    }

    printToConsole('设置 Token: $token');
    this.token = token;
  }

  void onKeyChange(String key) {
    if (key == '') {
      printToConsole('清除 key');
      this.key = null;
      return;
    }

    printToConsole('设置 key: $key');
    this.key = key;
  }

  void onMimeTypeChange(String mimeType) {
    if (mimeType == '') {
      printToConsole('清除 mimeType');
      this.mimeType = null;
      return;
    }

    printToConsole('设置 mimeType: $mimeType');
    this.mimeType = mimeType;
  }

  @override
  Widget build(BuildContext context) {
    return ListView(
      children: [
        Padding(
          padding: const EdgeInsets.all(20),
          child: Progress(value: progressValue),
        ),
        Padding(
          padding: const EdgeInsets.all(8.0),
          child: StringInput(
              onChanged: onKeyChange, label: '请输入 Key（可选）', value: 'Dart-Text'),
        ),
        Padding(
          padding: const EdgeInsets.all(8.0),
          child: StringInput(
            onChanged: onMimeTypeChange,
            label: '请输入 MimeType（可选）',
          ),
        ),
        Padding(
          padding: const EdgeInsets.all(8.0),
          child: StringInput(
            onChanged: onPartSizeChange,
            label: '请输入分片尺寸，单位 M（默认 4，可选）',
          ),
        ),
        Padding(
          padding: const EdgeInsets.all(8.0),
          child: StringInput(
            onChanged: onTokenChange,
            label: '请输入 Token（可选）',
            value: token ?? '',
          ),
        ),
        Padding(
          padding: const EdgeInsets.all(8.0),
          child: SelectFile(onSelectedFile),
        ),
        if (statusValue == StorageStatus.Request)
          Padding(
            padding: const EdgeInsets.all(10),
            child: ElevatedButton(
              child: const Text('取消上传'),
              onPressed: () => putController?.cancel(),
            ),
          ),
        const Padding(
          key: Key('console'),
          padding: EdgeInsets.all(8.0),
          child: Console(),
        )
      ],
    );
  }
}