1. ホーム
  2. java

[解決済み] Androidでファイルをダウンロードし、ProgressDialogで進捗を表示する。

2022-03-18 22:19:56

質問

私は、更新される簡単なアプリケーションを書こうとしています。このために、私はファイルをダウンロードすることができる簡単な関数が必要です。 現在の進捗状況を表示する の中で ProgressDialog . を行う方法は知っています。 ProgressDialog が、現在の進行状況を表示する方法と、そもそもファイルをダウンロードする方法がよくわかりません。

どのように解決するのですか?

ファイルをダウンロードする方法はたくさんあります。以下に、最も一般的な方法を掲載しますが、どの方法があなたのアプリに適しているかは、あなた次第です。

1. 使用方法 AsyncTask で、ダウンロードの進行状況をダイアログで表示します。

この方法を使うと、いくつかのバックグラウンド処理を実行しながら、同時にUIを更新することができます(今回はプログレスバーを更新します)。

インポートしています。

import android.os.PowerManager;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.FileOutputStream;
import java.net.HttpURLConnection;

これはコード例です。

// declare the dialog as a member field of your activity
ProgressDialog mProgressDialog;

// instantiate it within the onCreate method
mProgressDialog = new ProgressDialog(YourActivity.this);
mProgressDialog.setMessage("A message");
mProgressDialog.setIndeterminate(true);
mProgressDialog.setProgressStyle(ProgressDialog.STYLE_HORIZONTAL);
mProgressDialog.setCancelable(true);

// execute this when the downloader must be fired
final DownloadTask downloadTask = new DownloadTask(YourActivity.this);
downloadTask.execute("the url to the file you want to download");

mProgressDialog.setOnCancelListener(new DialogInterface.OnCancelListener() {

    @Override
    public void onCancel(DialogInterface dialog) {
        downloadTask.cancel(true); //cancel the task
    }
});

AsyncTask はこのようになります。

// usually, subclasses of AsyncTask are declared inside the activity class.
// that way, you can easily modify the UI thread from here
private class DownloadTask extends AsyncTask<String, Integer, String> {

    private Context context;
    private PowerManager.WakeLock mWakeLock;

    public DownloadTask(Context context) {
        this.context = context;
    }

    @Override
    protected String doInBackground(String... sUrl) {
        InputStream input = null;
        OutputStream output = null;
        HttpURLConnection connection = null;
        try {
            URL url = new URL(sUrl[0]);
            connection = (HttpURLConnection) url.openConnection();
            connection.connect();

            // expect HTTP 200 OK, so we don't mistakenly save error report
            // instead of the file
            if (connection.getResponseCode() != HttpURLConnection.HTTP_OK) {
                return "Server returned HTTP " + connection.getResponseCode()
                        + " " + connection.getResponseMessage();
            }

            // this will be useful to display download percentage
            // might be -1: server did not report the length
            int fileLength = connection.getContentLength();

            // download the file
            input = connection.getInputStream();
            output = new FileOutputStream("/sdcard/file_name.extension");

            byte data[] = new byte[4096];
            long total = 0;
            int count;
            while ((count = input.read(data)) != -1) {
                // allow canceling with back button
                if (isCancelled()) {
                    input.close();
                    return null;
                }
                total += count;
                // publishing the progress....
                if (fileLength > 0) // only if total length is known
                    publishProgress((int) (total * 100 / fileLength));
                output.write(data, 0, count);
            }
        } catch (Exception e) {
            return e.toString();
        } finally {
            try {
                if (output != null)
                    output.close();
                if (input != null)
                    input.close();
            } catch (IOException ignored) {
            }

            if (connection != null)
                connection.disconnect();
        }
        return null;
    }

上記のメソッド( doInBackground ) は常にバックグラウンドスレッドで実行されます。そこでUIタスクを行うべきではありません。一方 onProgressUpdateonPreExecute はUIスレッドで実行されるので、そこでプログレスバーを変更することができます。

    @Override
    protected void onPreExecute() {
        super.onPreExecute();
        // take CPU lock to prevent CPU from going off if the user 
        // presses the power button during download
        PowerManager pm = (PowerManager) context.getSystemService(Context.POWER_SERVICE);
        mWakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK,
             getClass().getName());
        mWakeLock.acquire();
        mProgressDialog.show();
    }

    @Override
    protected void onProgressUpdate(Integer... progress) {
        super.onProgressUpdate(progress);
        // if we get here, length is known, now set indeterminate to false
        mProgressDialog.setIndeterminate(false);
        mProgressDialog.setMax(100);
        mProgressDialog.setProgress(progress[0]);
    }

    @Override
    protected void onPostExecute(String result) {
        mWakeLock.release();
        mProgressDialog.dismiss();
        if (result != null)
            Toast.makeText(context,"Download error: "+result, Toast.LENGTH_LONG).show();
        else
            Toast.makeText(context,"File downloaded", Toast.LENGTH_SHORT).show();
    }

これを実行するためには、WAKE_LOCKパーミッションが必要です。

<uses-permission android:name="android.permission.WAKE_LOCK" />

2. サービスからのダウンロード

ここで大きな疑問があります。 サービスからアクティビティを更新するには? . 次の例では、皆さんがご存じない2つのクラスを使用します。 ResultReceiverIntentService . ResultReceiver は、サービスからスレッドを更新できるようにするためのものです。 IntentService のサブクラスです。 Service で、そこから背景処理を行うスレッドを生成する(知っておくべきは Service は、実際にはアプリと同じスレッドで実行されます。 Service CPUのブロッキング処理を実行するために、手動で新しいスレッドを生成する必要があります)。

ダウンロードサービスはこのような形になります。

public class DownloadService extends IntentService {
    public static final int UPDATE_PROGRESS = 8344;

    public DownloadService() {
        super("DownloadService");
    }
    @Override
    protected void onHandleIntent(Intent intent) {

        String urlToDownload = intent.getStringExtra("url");
        ResultReceiver receiver = (ResultReceiver) intent.getParcelableExtra("receiver");
        try {

            //create url and connect
            URL url = new URL(urlToDownload);
            URLConnection connection = url.openConnection();
            connection.connect();

            // this will be useful so that you can show a typical 0-100% progress bar
            int fileLength = connection.getContentLength();

            // download the file
            InputStream input = new BufferedInputStream(connection.getInputStream());

            String path = "/sdcard/BarcodeScanner-debug.apk" ;
            OutputStream output = new FileOutputStream(path);

            byte data[] = new byte[1024];
            long total = 0;
            int count;
            while ((count = input.read(data)) != -1) {
                total += count;

                // publishing the progress....
                Bundle resultData = new Bundle();
                resultData.putInt("progress" ,(int) (total * 100 / fileLength));
                receiver.send(UPDATE_PROGRESS, resultData);
                output.write(data, 0, count);
            }

            // close streams 
            output.flush();
            output.close();
            input.close();

        } catch (IOException e) {
            e.printStackTrace();
        }

        Bundle resultData = new Bundle();
        resultData.putInt("progress" ,100);

        receiver.send(UPDATE_PROGRESS, resultData);
    }
}

マニフェストにサービスを追加します。

<service android:name=".DownloadService"/>

そして、アクティビティはこのようになります。

// initialize the progress dialog like in the first example

// this is how you fire the downloader
mProgressDialog.show();
Intent intent = new Intent(this, DownloadService.class);
intent.putExtra("url", "url of the file to download");
intent.putExtra("receiver", new DownloadReceiver(new Handler()));
startService(intent);

以下は ResultReceiver が登場します。

private class DownloadReceiver extends ResultReceiver{

    public DownloadReceiver(Handler handler) {
        super(handler);
    }

    @Override
    protected void onReceiveResult(int resultCode, Bundle resultData) {

        super.onReceiveResult(resultCode, resultData);

        if (resultCode == DownloadService.UPDATE_PROGRESS) {

            int progress = resultData.getInt("progress"); //get the progress
            dialog.setProgress(progress);

            if (progress == 100) {
                dialog.dismiss();
            }
        }
    }
}

2.1 グラウンディライブラリを使用する

グラウンディ は、基本的にバックグラウンドサービスでコードの断片を実行するのを助けるライブラリです。 ResultReceiver というコンセプトで作られています。このライブラリは 非推奨 を、現時点では このように 全体 のコードは、このようになります。

ダイアログを表示しているアクティビティ...

public class MainActivity extends Activity {

    private ProgressDialog mProgressDialog;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);

        findViewById(R.id.btn_download).setOnClickListener(new View.OnClickListener() {
            public void onClick(View view) {
                String url = ((EditText) findViewById(R.id.edit_url)).getText().toString().trim();
                Bundle extras = new Bundler().add(DownloadTask.PARAM_URL, url).build();
                Groundy.create(DownloadExample.this, DownloadTask.class)
                        .receiver(mReceiver)
                        .params(extras)
                        .queue();

                mProgressDialog = new ProgressDialog(MainActivity.this);
                mProgressDialog.setProgressStyle(ProgressDialog.STYLE_HORIZONTAL);
                mProgressDialog.setCancelable(false);
                mProgressDialog.show();
            }
        });
    }

    private ResultReceiver mReceiver = new ResultReceiver(new Handler()) {
        @Override
        protected void onReceiveResult(int resultCode, Bundle resultData) {
            super.onReceiveResult(resultCode, resultData);
            switch (resultCode) {
                case Groundy.STATUS_PROGRESS:
                    mProgressDialog.setProgress(resultData.getInt(Groundy.KEY_PROGRESS));
                    break;
                case Groundy.STATUS_FINISHED:
                    Toast.makeText(DownloadExample.this, R.string.file_downloaded, Toast.LENGTH_LONG);
                    mProgressDialog.dismiss();
                    break;
                case Groundy.STATUS_ERROR:
                    Toast.makeText(DownloadExample.this, resultData.getString(Groundy.KEY_ERROR), Toast.LENGTH_LONG).show();
                    mProgressDialog.dismiss();
                    break;
            }
        }
    };
}

A GroundyTask で使用される実装です。 グラウンディ ファイルをダウンロードし、進捗状況を表示します。

public class DownloadTask extends GroundyTask {    
    public static final String PARAM_URL = "com.groundy.sample.param.url";

    @Override
    protected boolean doInBackground() {
        try {
            String url = getParameters().getString(PARAM_URL);
            File dest = new File(getContext().getFilesDir(), new File(url).getName());
            DownloadUtils.downloadFile(getContext(), url, dest, DownloadUtils.getDownloadListenerForTask(this));
            return true;
        } catch (Exception pokemon) {
            return false;
        }
    }
}

そして、これをマニフェストに追加するだけです。

<service android:name="com.codeslap.groundy.GroundyService"/>

これ以上ないほど簡単だと思います。最新のjarを取得するだけです Githubから で、準備完了です。以下の点に注意してください。 グラウンディ の主な目的は、バックグラウンドサービスで外部のREST APIを呼び出し、結果を簡単にUIにポストすることです。もし、あなたのアプリでそのようなことを行っているのであれば、本当に役に立つかもしれません。

2.2 使用方法 https://github.com/koush/ion

3. 使用方法 DownloadManager クラス( GingerBread およびそれ以降のみ)

GingerBreadは新しい機能をもたらしました。 DownloadManager これにより、ファイルを簡単にダウンロードすることができ、スレッドやストリームなどを処理する大変な作業をシステムに委ねることができます。

まず、ユーティリティ・メソッドを見てみましょう。

/**
 * @param context used to check the device version and DownloadManager information
 * @return true if the download manager is available
 */
public static boolean isDownloadManagerAvailable(Context context) {

    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
        return true;
    }
    return false;
}

メソッドの名前がすべてを物語っています。一旦、あなたが DownloadManager が使えるようになると、次のようなことができるようになります。

String url = "url you want to download";
DownloadManager.Request request = new DownloadManager.Request(Uri.parse(url));
request.setDescription("Some descrition");
request.setTitle("Some title");
// in order for this if to run, you must use the android 3.2 to compile your app
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
    request.allowScanningByMediaScanner();
    request.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
}
request.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, "name-of-the-file.ext");

// get download service and enqueue file
DownloadManager manager = (DownloadManager) getSystemService(Context.DOWNLOAD_SERVICE);
manager.enqueue(request);

ダウンロードの進行状況は、通知バーに表示されます。

最終的な感想

1つ目と2つ目の方法は、氷山の一角に過ぎません。アプリを堅牢にしたいのであれば、留意しなければならないことがたくさんあります。以下はその簡単なリストです。

  • ユーザーがインターネットに接続可能かどうかを確認する必要があります。
  • 正しいパーミッションがあることを確認する ( INTERNETWRITE_EXTERNAL_STORAGE ); また ACCESS_NETWORK_STATE インターネットの空き状況を確認したい場合。
  • ファイルをダウンロードするディレクトリが存在し、書き込み権限があることを確認してください。
  • ダウンロードが大きすぎる場合、前の試行が失敗した場合にダウンロードを再開する方法を実装するとよいでしょう。
  • ダウンロードを中断できるようにしておくと、ユーザーにとってありがたい。

ダウンロードのプロセスを詳細に制御する必要がない場合は、ダウンロードの際に DownloadManager (3)は、すでに上記の項目のほとんどを処理しているからです。

しかし、ニーズが変わる可能性があることも考慮してください。たとえば DownloadManager レスポンスキャッシュを行いません。 . 同じ大きなファイルを何度もやみくもにダウンロードすることになります。後から簡単に修正する方法はない。もしあなたが基本的な HttpURLConnection (1, 2)の場合、必要なのは HttpResponseCache . ですから、基本的で標準的なツールを学ぶという最初の努力は、良い投資となるでしょう。

<ブロッククオート

このクラスはAPIレベル26で非推奨となりました。ProgressDialog はモーダルダイアログである。 ダイアログが表示され、ユーザーがアプリと対話することができなくなります。代わりに このクラスを使用する前に、次のような進行状況インジケータを使用する必要があります。 ProgressBarは、アプリのUIに埋め込むことができます。あるいは を使えば、タスクの進捗を通知することができます。詳細はこちら リンク