2010年12月19日日曜日

Android　Android2.3 - DownloadManager を使う

・DownloadManager は long-running HTTP ダウンロード用のシステムサービス

・ダウンロードするファイルのURIを指定してリクエストする

・ダウンロードはバックグラウンドで行われる

・接続が変わったり、リブートしたり、ダウンロードに失敗した場合は再試行される

・getSystemService(String) メソッドの引数に DOWNLOAD_SERVICE を渡してインスタンスを取得する

・このAPIを使ってダウンロードをリクエストするアプリは、ユーザーが notification や downloads UI からダウンロードを開始したことを適切にハンドルするために、ACTION_NOTIFICATION_CLICKED に対する broadcast receiver を登録しておかなければならない



# DownloadManager.Query に渡す URI が https だと怒られた。http じゃないとだめみたい。

# AndoridManifest.xml に <uses-permission android:name="android.permission.INTERNET"/> が必要なのですが、これを書かない時の logcat のエラーメッセージが requires android.permission.ACCESS_ALL_DOWNLOADS or android.permission.ACCESS_ALL_DOWNLOADS (エミュレータで、ですけど。）という（トンチンカン？な internal permission を表示してしまう）ものなので、ちょっと紛らわしいです。


保存先を明示しない場合は、cache にだけ保存されます。

$ adb -e shell
# ls cache
image1-3.png
image1-2.png
image1-1.png
image1.png
backup
lost+found



永続化する場合は、外部メディアのURIを指定します。

view plainprint?
  1. // save with uri  
  2. File file = new File(getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS), "image1.png");  
  3. mRequest.setDestinationUri(Uri.fromFile(file));  


# setDestinationUri() の引数に内部メディアのURIを入れると怒られます。。。


保存先を外部メディアの Application's Directory にした場合は /mnt/sdcard/ とかの下の Android/data/package-name/files/ の下の setDestinationInExternalPublicDir() の第1引数で指定したディレクトリの中になります。

view plainprint?
  1. mRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, "image1.png");  
  2. File pathExternalDir = getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS);  
  3. pathExternalDir.mkdirs();  



$ adb -e shell
# ls mnt/sdcard/Android/data/yanzm.example.downloadmanagersample/files/Download
image1.png



保存先を外部メディアの Public Directory にした場合は /mnt/sdcard/ とかの下の setDestinationInExternalPublicDir() の第1引数で指定したディレクトリの中になります。

view plainprint?
  1. mRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, "image1.png");  
  2. File pathExternalPublicDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS);  
  3. pathExternalPublicDir.mkdirs();  



$ adb -e shell
# ls mnt/sdcard/Download
image1.png



# mkdirs() でディレクトリ作っておかないとダウンロードに失敗するので気をつけて。。。


全ソースはこちら
view plainprint?
  1. package yanzm.example.downloadmanagersample;  
  2.   
  3. import java.io.File;  
  4.   
  5. import android.app.Activity;  
  6. import android.app.DownloadManager;  
  7. import android.content.Context;  
  8. import android.net.Uri;  
  9. import android.os.Bundle;  
  10. import android.os.Environment;  
  11. import android.util.Log;  
  12. import android.view.View;  
  13.   
  14. public class MyActivity extends Activity {  
  15.   
  16.     private int downloadDestination = DESTINATION_EXTERNAL_PUBLICDIR;  
  17.   
  18.     private static final int CACHE = 0;  
  19.     private static final int DESTINATION_URI = 1;  
  20.     private static final int DESTINATION_EXTERNAL_DIR = 2;  
  21.     private static final int DESTINATION_EXTERNAL_PUBLICDIR = 3;  
  22.       
  23.     @Override  
  24.     public void onCreate(Bundle savedInstanceState) {  
  25.         super.onCreate(savedInstanceState);  
  26.         setContentView(R.layout.main);  
  27.     }  
  28.       
  29.     public void startDownload(View v) {  
  30.         DownloadManager mDownloadManager = (DownloadManager) getSystemService(Context.DOWNLOAD_SERVICE);  
  31.           
  32.         Uri uri = Uri.parse("http://sites.google.com/site/yukianzm/tmp/image1.png");  
  33.           
  34.         DownloadManager.Request mRequest = new DownloadManager.Request(uri);  
  35.         mRequest.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_MOBILE);  
  36.         // mRequest.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_WIFI);  
  37.         // mRequest.setAllowedOverRoaming(false);  
  38.         mRequest.setTitle("Test Download!");  
  39.         mRequest.setDescription("sample of using download manager");  
  40.           
  41.         switch (downloadDestination) {  
  42.         case CACHE:  
  43.             break;  
  44.         case DESTINATION_URI:  
  45.             // save with uri  
  46.             File file = new File(getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS), "image1.png");  
  47.             mRequest.setDestinationUri(Uri.fromFile(file));  
  48.             break;  
  49.         case DESTINATION_EXTERNAL_DIR:  
  50.             // save in external storage application's directory  
  51.             mRequest.setDestinationInExternalFilesDir(this,Environment.DIRECTORY_DOWNLOADS, "image1.png");  
  52.             File pathExternalDir = getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS);  
  53.             pathExternalDir.mkdirs();  
  54.             break;  
  55.         case DESTINATION_EXTERNAL_PUBLICDIR:  
  56.             // save in external storage public directory  
  57.             mRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, "image1.png");  
  58.             File pathExternalPublicDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS);  
  59.             pathExternalPublicDir.mkdirs();  
  60.             break;  
  61.         }  
  62.           
  63.         // mRequest.setMimeType(HTTP.OCTET_STREAM_TYPE);  
  64.         mRequest.setShowRunningNotification(true);  
  65.         mRequest.setVisibleInDownloadsUi(true);  
  66.           
  67.         long downloadId = mDownloadManager.enqueue(mRequest);  
  68.           
  69.         Log.d("DownloadManagerSample", "Start Download download Id = " + downloadId);  
  70.     }  
  71. }  



# broadcast receiver 部分についてはまた今度。。。

2.3 の Built-in Application の Downloads でみてみるとこんな感じ。






■ Nested Classes
　- DownloadManager.Query
　　　　ダウンロードマネジャークエリーをフィルターするのに使う

　- DwonloadManager.Request
　　　　新しいダウンロードのリクエストに必要な全ての情報を含む


■Constants
　- ACTION_DOWNLOAD_COMPLETE
　　　　ダウンロードが完了したときに download manager によって
　　　　発行される broadcast intent action

　- ACTION_NOTIFICATION_CLICKED
　　　　ユーザーが system notification や downloads UI から
　　　　実行中のダウンロードをクリックしたときに download manager
　　　　から発行される broadcast intent action

　- ACTION_VIEW_DOWNLOADS
　　　　全ダウンロードを表示するための Activity を起動する intent action

　- COLUMN_BYTES_DOWNLOADED_SO_FAR
　　　　これまでのダウンロードバイト数

　- COLUMN_DESCRIPTION
　　　　クライアントが提供するこのダウンロードの詳細

　- COLUMN_ID
　　　　特定のダウンロードの識別子。システム上でユニーク

　- COLUMN_LAST_MODIFIED_TIMESTAMP
　　　　最後にダウンロードが編集されたタイムスタンプ
　　　　 (System.currentTimeMillis() UTC)

　- COLUMN_LOCAL_URI
　　　　ダウンロードされたファイルが保存される場所のUri

　- COLUMN_MEDIAPROVIDER_URI
　　　　このダウンロードエントリに対応する MediaProvider でのエントリへのURI

　- COLUMN_MEDIA_TYPE
　　　　このダウンロードファイルの Internet Media Type

　- COLUMN_REASON
　　　　ダウンロードのステータスの詳細を提供する
　　　　ERROR_* か PAUSED_* の定数の1つ

　　　　- ERROR_CANNNOT_RESUME
　　　　　　　一時的なエラーでダウンロードを再開できない

　　　　- ERROR_DEVICE_NOT_FOUND
　　　　　　　外部ストレージデバイスがみつからない

　　　　- ERROR_FILE_ALREADY_EXISTS
　　　　　　　リクエスト先のファイルがすでに存在している
　　　　　　　（download manager はすでに存在している
　　　　　　　ファイルを上書きしない）

　　　　- ERROR_FILE_ERROR
　　　　　　　他のエラーコードに合致しないストレージ問題が起こった

　　　　- ERROR_HTTP_DATA_ERROR
　　　　　　　データを受信もしくは解析中にHTTPレベルでエラーが起こった

　　　　- ERROR_INSUFFICIENT_SPACE
　　　　　　　十分なストレージ領域がない

　　　　- ERROR_TOO_MANY_REDIRECTS
　　　　　　　リダイレクトが多すぎる

　　　　- ERROR_UNHANDLED_HTTP_CODE
　　　　　　　download manager がハンドルできない HTTP code を受信した

　　　　- ERROR_UNKNOWN
　　　　　　　他のエラーコードに合致しないエラーでダウンロードが完了した

　　　　- PAUSED_QUEUED_FOR_WIFI
　　　　　　　ダウンロードが mobile network を介すときのリミットサイズ
　　　　　　　を超えたので、download manager は Wi-Fi 接続による再開を
　　　　　　　待っている

　　　　- PAUSED_UNKNOWN
　　　　　　　ダウンロードは何かの理由で一時停止している

　　　　- PAUSED_WAITING_FOR_NETWORK
　　　　　　　ダウンロードは再開のためにネットワーク接続を待っている

　　　　- PAUSED_WAITING_TO_RETRY
　　　　　　　ネットワークエラーが発生し、download manager はリクエストを
　　　　　　　再試行する前に待っているので、ダウンロードが一時停止している

　- COLUMN_STATUS
　　　　ダウンロードの現在の状態。STATUS_* 定数の1つ

　　　　- STATUS_FAILED
　　　　　　　ダウンロードが失敗したときの値
　　　　　　　（再試行はされない）

　　　　- STATUS_PAUSED
　　　　　　　ダウンロードが再試行か再開を待っているときの値

　　　　- STATUS_PENDING
　　　　　　　ダウンロードが開始されるのを待っているときの値

　　　　- STATUS_RUNNING
　　　　　　　ダウンロードが実行されているときの値

　　　　- STATUS_SUCCESSFUL
　　　　　　　ダウンロードが成功し完了したときの値


　- COLUMN_TITLE
　　　　クライアントが提供するこのダウンロードのタイトル

　- COLUMN_TOTAL_SIZE_BYTES
　　　　ダウンロードのトータルバイト数

　- COLUMN_URI
　　　　ダンロードする URI

　- EXTRA_DOWNLOAD_ID
　　　　ACTION_DOWNLOAD_COMPLETE intents に含まれる
　　　　intent extra
　　　　今完了したダウンロードのID (long値）

■ Public Methods

　- long enqueue(DownloadManager.Request request)
　　　　新しいダウンロードをキューに入れる

　- ParcelFileDescriptor openDonwloadedFile(long id)
　　　　ダウンロードしたファイルを読むために開く

　- Cursor query(DownloadManager.Query query)
　　　　リクエストされているダウンロードについてのクエリ

　- int remove(long... ids)
　　　　ダウンロードをキャンセルし、download manager から削除する
投稿者 時刻:
ラベル:

2 件のコメント:

登録: コメントの投稿 (Atom)