flutter_downloader

その他のソースコード

1.11.8

ダウンロード

フラッターダウンローダー

ダウンロードタスクを作成および管理するためのプラグイン。 iOSとAndroidをサポートします。

このプラグインは、Android ではWorkManager使用し、iOS ではNSURLSessionDownloadTask使用して、バックグラウンドでダウンロードタスクを実行します。

開発ノート:

Android 11 での外部ストレージ API の変更により、現在の実装にいくつかの問題が発生します。ダウンロードファイルの場所を管理するための新しい戦略を使用してこのプラグインを再設計することにしました。この PR ではまだトリアージと議論が行われています。プラグインの設計を改善するために、Flutter 開発者からの貢献とフィードバックをいただければ幸いです。

過去のバージョンと SQL インジェクションの脆弱性

このパッケージの以前のバージョンには、SQL インジェクションに関連する既知の脆弱性がありました。 SQL インジェクションはセキュリティ上の脆弱性の一種で、悪意のあるユーザーがアプリケーションによって実行される SQL クエリを操作できるようになり、データベースへの不正なアクセスや操作につながる可能性があります。

アプリケーションが SQL インジェクションの脆弱性にさらされないようにするために、このパッケージの最新バージョンにアップグレードすることを強くお勧めします。最新バージョンには、そのようなリスクを軽減するために必要なセキュリティの改善とパッチが含まれています。

iOSの統合

必要な構成:

次の手順では、Xcode でiosプロジェクトを開く必要があります。

バックグラウンドモードを有効にします。

sqliteライブラリを追加します。

AppDelegateを構成します。

目標-C:

 /// AppDelegate.h#import #import @interface AppDelegate : FlutterAppDelegate@end

 // AppDelegate.m#include "AppDelegate.h"#include "GeneratedPluginRegistrant.h"#include "FlutterDownloaderPlugin.h"@implementation AppDelegatevoid registerPlugins(NSObject* registry) { if (![registry hasPlugin:@"FlutterDownloaderPlugin" ]){
     [FlutterDownloaderPlugin registerWithRegistrar:[レジストリ registrarForPlugin:@"FlutterDownloaderPlugin"]];
  }
}

- (BOOL)application:(UIApplication *)application DidFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [GeneratedPluginRegistrant registerWithRegistry:self];
  [FlutterDownloaderPlugin setPluginRegistrantCallback:registerPlugins];  // アプリケーション起動後のカスタマイズのためのオーバーライドポイント。  return [スーパーアプリケーション:アプリケーションdFinishLaunchingWithOptions:launchOptions];
}@終わり

またはスウィフト:

 UIKitをインポートする
フラッターをインポートする
import flutter_downloader@UIApplicationMain@objc class AppDelegate: FlutterAppDelegate { override func application(
    _ アプリケーション: UIApplication、
    DidFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?  ) -> Bool { GeneratedPluginRegistrant.register(with: self) FlutterDownloaderPlugin.setPluginRegistrantCallback(registerPlugins) return super.application(application, DidFinishLaunchingWithOptions: launchOptions) }}private func registerPlugins(registry: FlutterPluginRegistry) {
    if (!registry.hasPlugin("FlutterDownloaderPlugin")) { FlutterDownloaderPlugin.register(with: registry.registrar(forPlugin: "FlutterDownloaderPlugin")!) }}

オプションの構成:

HTTP リクエストのサポート: HTTP リクエストでファイルをダウンロードする場合は、Apple Transport Security (ATS) 機能を無効にする必要があります。オプションは 2 つあります。

特定のドメインに対してのみ ATS を無効にします: (次のコードをInfo.plistファイルに追加します)

 NSAppTransportSecurity
<辞書>
  NSExceptionDomains
  <辞書>
    www.yourserver.com
     
      NS サブドメインを含む
       
      NSTemporaryExceptionAllowsInsecureHTTPLoads
       
      NSTemporaryExceptionMinimumTLSVersion
      TLSv1.1

ATSを完全に無効にします。以下をInfo.plistファイルに追加します)

 NSAppTransportSecurity
<辞書>
    NSAllowsArbitraryLoads

同時タスクの最大数を構成します。プラグインでは、デフォルトで一度に 3 つのダウンロードタスクを実行できます (3 つを超えるタスクをキューに入れると、実行中のタスクは 3 つだけになり、他のタスクは保留状態になります)。この番号を変更するには、次のコードをInfo.plistファイルに追加します。

 FDMinimumConcurrentTasks
<整数>5

通知メッセージのローカライズ:アプリケーションがフォアグラウンドで実行されていないときにすべてのファイルがダウンロードされた場合、プラグインは通知メッセージを送信してユーザーに通知します。このメッセージはデフォルトでは英語です。 Info.plistファイルに次のメッセージを追加してローカライズすることで、このメッセージをローカライズできます。 ( Info.plistローカリゼーションの詳細については、このリンクを参照してください)

 FDAllFilesDownloadedMessage
すべてのファイルがダウンロードされました

注記：

このプラグインはNSDocumentDirectory内のファイルの保存のみをサポートします

Androidの統合

プラグインを Android で動作させるために特別なことをする必要はありません。

ただし、構成する必要があるオプションの設定がいくつかあります。

通知からダウンロードしたファイルを開く

通知をタップして Android でダウンロードしたファイルを開くようにするには、次のコードをAndroidManifest.xmlに追加します。

 <プロバイダー android:name="vn.hunghd.flutterdownloader.DownloadedFileProvider" android:authorities="${applicationId}.flutter_downloader.provider" android:exported="false" android:grantUriPermissions="true">
    <メタデータ android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/provider_paths"/>

注意事項

ダウンロードしたファイルは外部ストレージ (他のアプリケーションがファイルを読み取る権限を持っている場所) に保存する必要があります。
ダウンロードしたファイルは、デバイスにこれらのファイルタイプ (mp3、pdf など) を読み取ることができるアプリケーションが少なくとも 1 つある場合にのみ開くことができます。

同時ダウンロードタスクの最大数を構成する

プラグインはWorkManagerライブラリに依存し、 WorkManager利用可能なプロセッサの数に応じて、同時に実行されるタスクの最大数を構成します。次のコードをAndroidManifest.xmlに追加することで、この構成に固定数を設定できます。

 
    <メタデータ android:name="androidx.work.WorkManagerInitializer" android:value="androidx.startup" tools:node="remove" />
 
    <メタデータ android:name="vn.hunghd.flutterdownloader.MAX_CONCURRENT_TASKS" android:value="5" />

通知内の文字列をローカライズする

次のメッセージをローカライズすることで、ダウンロード進行状況通知のテキストをローカライズできます。

 ダウンロードが開始されました
ダウンロードが進行中
ダウンロードがキャンセルされました
ダウンロードに失敗しました
ダウンロードが完了しました
ダウンロードが一時停止されました

Android でのローカリゼーションについて詳しくは、こちらをご覧ください。

.apk ファイルをインストールする

.apkファイルを開いてインストールするには、アプリケーションにREQUEST_INSTALL_PACKAGES権限が必要です。 AndroidManifest.xmlに以下を追加します。

以下も参照してください。

Android 9 Pieのクリアテキストトラフィックエラーを修正

使用法

インポートと初期化

import 'package:flutter_downloader/flutter_downloader.dart';void main() { WidgetsFlutterBinding.ensureInitialized();  // await FlutterDownloader.initialize( を使用する前にプラグインを初期化する必要があります
    debug: true, // オプション: コンソールへのログの出力を無効にするには false に設定します (デフォルト: true)
    ignoreSsl: true // オプション: http リンクの操作を無効にするには false に設定します (デフォルト: false)
  );  runApp(/*...*/)
}

新しいダウンロードタスクを作成する

Final taskId = await FlutterDownloader.enqueue(
  URL: 'ダウンロードリンク',
  headers: {}, // オプション: URL (認証トークンなど) とともに送信されるヘッダー
  SavedDir: 'ダウンロードしたファイルを保存するディレクトリのパス',
  showNotification: true, // ダウンロードの進行状況をステータスバーに表示します (Android の場合)
  openFileFromNotification: true, // 通知をクリックしてダウンロードしたファイルを開きます (Android の場合);

ダウンロードの進行状況を更新する

FlutterDownloader.registerCallback(callback); を待ちます。 // コールバックはトップレベル関数または静的関数です

重要

UI はメインアイソレートでレンダリングされますが、ダウンロードイベントはバックグラウンドアイソレートから取得される (つまり、 callbackのコードはバックグラウンドアイソレートで実行される) ため、2 つのアイソレート間の通信を処理する必要があります。例えば：

 ReceivePort _port = ReceivePort();@overridevoid initState() { super.initState();  IsolateNameServer.registerPortWithName(_port.sendPort, 'downloader_send_port');
  _port.listen((動的データ) { String id = data[0]; DownloadTaskStatus status = DownloadTaskStatus(data[1]); int progress = data[2]; setState((){ });
  });  FlutterDownloader.registerCallback(downloadCallback);
}@overridevoid destroy() { IsolateNameServer.removePortNameMapping('downloader_send_port');  super.dispose();
}@pragma('vm:entry-point')static void downloadCallback(String id, int status, int progress) {final SendPort send = IsolateNameServer.lookupPortByName('downloader_send_port');
  send.send([id, ステータス, 進行状況]);
}

Android のリリースモードでのツリーの揺れを避けるために、 @pragma('vm:entry-point') callback関数の上に配置する必要があります。

すべてのダウンロードタスクをロードする

最終タスク = await FlutterDownloader.loadTasks();

生の SQL クエリを使用してダウンロードタスクをロードする

最終タスク = await FlutterDownloader.loadTasksWithRawQuery(query: query);

データをDownloadTaskオブジェクトに正常に解析するには、すべてのフィールドを含むデータをデータベースからロードする必要があります (つまり、 SELECT *を使用します)。例えば：

 SELECT * FROM タスク WHERE ステータス=3

以下は、 flutter_downloaderプラグインがダウンロードタスクに関する情報を保存するtaskテーブルのスキーマです。

 CREATE TABLE `task` ( `id` INTEGER PRIMARY KEY AUTOINCREMENT, `task_id` VARCHAR ( 256 ), `url` TEXT, `status` INTEGER DEFAULT 0, `progress` INTEGER DEFAULT 0, `file_name` TEXT, `saved_dir` TEXT 、`再開可能` TINYINT DEFAULT 0、`headers` TEXT、`show_notification` TINYINT DEFAULT 0、`open_file_from_notification` TINYINT DEFAULT 0、`time_created` INTEGER DEFAULT 0);

タスクをキャンセルする

FlutterDownloader.cancel(taskId: taskId);

すべてのタスクをキャンセルする

FlutterDownloader.cancelAll();

タスクを一時停止する

FlutterDownloader.pause(taskId: taskId);

タスクを再開する

FlutterDownloader.resume(taskId: taskId);

resume()ダウンロードプロセスを続行するために作成された新しいバックグラウンドタスクに対応する新しいtaskIdを返します。ダウンロードの進行状況を追跡し続けるには、古いtaskId ( pausedステータスになっている) を新しいtaskIdに置き換える必要があります。

失敗したタスクを再試行する

FlutterDownloader.retry(taskId: taskId);

retry()新しいtaskId返します ( resume()と同様)

タスクを削除する

FlutterDownloader.remove(taskId: taskId, shouldDeleteContent:false);

ダウンロードしたファイルを開いてプレビューする

FlutterDownloader.open(taskId: taskId);

Android では、ダウンロードしたファイルが外部ストレージに保存されており、デバイス上にそのファイルタイプを読み取ることができるアプリケーションが少なくとも 1 つある場合にのみ、そのファイルを開くことができます。

バグ・要望

問題が発生した場合、またはプラグインに機能が欠けていると思われる場合は、お気軽に問題を開いてください。

プルリクエストも大歓迎です！

拡大する

追加情報

バージョン 1.11.8
タイプその他のソースコード
更新時間 2024-11-05
サイズ
言語簡体字中国語

flutter_downloader