Android四大组件之服务的演示Demo

一个完整版的下载示例

首先新建一个ServiceBestPractice项目

• 在项目中添加依赖库

图片.png

• 定义一个回调接口，用于对下载过程中的各种状态进行监听和回调

新建一个DownloadListener接口

public interface DownloadListener {

    void onProgress(int progress);

    void onSuccess();

    void onFailed();

    void onPaused();

    void onCanceled();
}

可以看到，这里我们一共定义了5个回调方法，
onProgress()方法用于通知当前的下载进度
onSuccess()方法用于通知下载成功事件
onFailed()方法用于通知下载失败事件
onPaused()方法用于通知下载暂时事件
onCanceled()方法用于通知下载取消事件

回调接口定义好了之后，下面我们就可以开始编写下载功能了。这里我准备使用AsyncTask来进行实现

• 新建一个DownloadTask继承自AsyncTask

public class DownloadTask extends AsyncTask<String, Integer, Integer> {

    public static final int TYPE_SUCCESS = 0;
    public static final int TYPE_FAILED = 1;
    public static final int TYPE_PAUSED = 2;
    public static final int TYPE_CANCELED = 3;


    private DownloadListener listener;
    private boolean isCanceled = false;
    private boolean isPaused = false;
    private int lastProgress;

    public DownloadTask(DownloadListener listener) {
        this.listener = listener;
    }

    @Override
    protected Integer doInBackground(String... params) {
        InputStream is = null;
        RandomAccessFile savedFile = null;
        File file = null;
        try {
            long downloadedLength = 0; // 记录已下载的文件长度
            String downloadUrl = params[0];
            String fileName = downloadUrl.substring(downloadUrl.lastIndexOf("/"));
            String directory = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).getPath();
            file = new File(directory + fileName);
            if (file.exists()) {
                downloadedLength = file.length();
            }
            long contentLength = getContentLength(downloadUrl);
            if (contentLength == 0) {
                return TYPE_FAILED;
            } else if (contentLength == downloadedLength) {
                // 已下载字节和文件总字节相等，说明已经下载完成了
                return TYPE_SUCCESS;
            }
            OkHttpClient client = new OkHttpClient();
            Request request = new Request.Builder()
                    // 断点下载，指定从哪个字节开始下载
                    .addHeader("RANGE", "bytes=" + downloadedLength + "-")
                    .url(downloadUrl)
                    .build();
            Response response = client.newCall(request).execute();
            if (response != null) {
                is = response.body().byteStream();
                savedFile = new RandomAccessFile(file, "rw");
                savedFile.seek(downloadedLength); // 跳过已下载的字节
                byte[] b = new byte[1024];
                int total = 0;
                int len;
                while ((len = is.read(b)) != -1) {
                    if (isCanceled) {
                        return TYPE_CANCELED;
                    } else if(isPaused) {
                        return TYPE_PAUSED;
                    } else {
                        total += len;
                        savedFile.write(b, 0, len);
                        // 计算已下载的百分比
                        int progress = (int) ((total + downloadedLength) * 100 / contentLength);
                        publishProgress(progress);
                    }
                }
                response.body().close();
                return TYPE_SUCCESS;
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (is != null) {
                    is.close();
                }
                if (savedFile != null) {
                    savedFile.close();
                }
                if (isCanceled && file != null) {
                    file.delete();
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return TYPE_FAILED;
    }

    @Override
    protected void onProgressUpdate(Integer... values) {
        int progress = values[0];
        if (progress > lastProgress) {
            listener.onProgress(progress);
            lastProgress = progress;
        }
    }

    @Override
    protected void onPostExecute(Integer status) {
        switch (status) {
            case TYPE_SUCCESS:
                listener.onSuccess();
                break;
            case TYPE_FAILED:
                listener.onFailed();
                break;
            case TYPE_PAUSED:
                listener.onPaused();
                break;
            case TYPE_CANCELED:
                listener.onCanceled();
            default:
                break;
        }
    }

    public void pauseDownload() {
        isPaused = true;
    }


    public void cancelDownload() {
        isCanceled = true;
    }

    private long getContentLength(String downloadUrl) throws IOException {
        OkHttpClient client = new OkHttpClient();
        Request request = new Request.Builder()
                .url(downloadUrl)
                .build();
        Response response = client.newCall(request).execute();
        if (response != null && response.isSuccessful()) {
            long contentLength = response.body().contentLength();
            response.close();
            return contentLength;
        }
        return 0;
    }

}

这段代码就比较长了，我们需要一步步地进行分析。
首先看一下AsyncTask中的3个泛型参数：
第一个泛型参数指定为String，表示在执行 Asynctask的时候需要传入一个字符串参数给后台任务；
第二个泛型参数指定为Integer，表示使用整型数据来作为进度显示单位；
第三个泛型参数指定为Integer，则表示使用整型数据来反馈执行结果。

接下来我们定义了4个整型常量用于表示下载的状态：
TYPE_SUCCESS表示下载成功
TYPE_FAILED表示下载失败
TYPE_PAUSED表示暂停下载
TYPE_CANCELED表示取消下载
然后在DownloadTask的构造函数中要求传入一个刚刚定义的DownloadListener参数，我们待会就会将下载的状态通过这个参数进行回调。

接着就是要重写doInBackground()、onProgressUpdate()和onPostExecute()这3个方法了
doInBackground()方法用于在后台执行具体的下载逻辑
onProgressUpdate()方法用于在界面上更新当前的下载进度
onPostExecute()方法用于通知最终的下载结果

那么先来看一下doInBackground()方法
首先我们从参数中获取到了下载的URL地址并根据URL地址解析出了下载的文件名，然后指定将文件下载到Environment. DIRECTORY_DOWNLOADS目录下，也就是SD卡的 Download目录。
我们还要判断下Download目录中是不是已经存在要下载的文件了，如果已经存在的话则读取已下载的字节数，这样就可以在后面启用断点续传的功能。
接下来先是调用了getContentLength()方法来获取待下载文件的总长度，
如果文件长度等于0则说明文件有问题，直接返回TYPE_FAILED，
如果文件长度等于已下载文件长度，那么就说明文件已经下载完了，直接返回 TYPE_SUCCESS即可。

紧接着使用OkHttp来发送一条网络请求，需要注意的是，这里在请求中添加了一个header，用于告诉服务器我们想要从哪个字节开始下载，因为已下载过的部分就不需要再重新下载了。
接下来读取服务器响应的数据，并使用Java的文件流方式，不断从网络上读取数据，不断写入到本地，一直到文件全部下载完成为止。在这个过程中，我们还要判断用户有没有触发暂停或者取消的操作，如果有的话则返回TYPE_PAUSED或TYPE_CANCELED来中断下载，如果没有的话则实时计算当前的下载进度，然后 调用publishProgress()方法进行通知。暂停和取消操作都是使用一个布尔型的变量来进行控制的，调用 pauseDownload()或cancelDownload()方法即可更改变量的值

接下来看一下onProgressUpdate()方法，这个方法就简单得多了，它首先从参数中获取到当前的下载进度，然后和上一次的下载进度进行对比，如果有变化的话则调用DownloadListener的onProgress()方法来通知下载进度更新。

最后是onPostExecute()方法，也非常简单，就是根据参数中传入的下载状态来进行回调。
下载成功就调用DownloadListener的onSuccess()方法
下载失败就调用onFailed()方法
暂停下载就调用onPaused()方法
取消下载就调用 onCanceled()方法。

这样我们就把具体的下载功能完成了，下面为了保证DownloadTask可以一直在后台运行，我们还需要创建一个下载的服务。

• 新建DownloadService

public class DownloadService extends Service {

    private DownloadTask downloadTask;
    private String downloadUrl;

    private DownloadListener listener = new DownloadListener() {
        @Override
        public void onProgress(int progress) {
            getNotificationManager().notify(1, getNotification("Downloading...", progress));
        }

        @Override
        public void onSuccess() {
            downloadTask = null;
            // 下载成功时将前台服务通知关闭，并创建一个下载成功的通知
            stopForeground(true);
            getNotificationManager().notify(1, getNotification("Download Success", -1));
            Toast.makeText(DownloadService.this, "Download Success", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onFailed() {
            downloadTask = null;
            // 下载失败时将前台服务通知关闭，并创建一个下载失败的通知
            stopForeground(true);
            getNotificationManager().notify(1, getNotification("Download Failed", -1));
            Toast.makeText(DownloadService.this, "Download Failed", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onPaused() {
            downloadTask = null;
            Toast.makeText(DownloadService.this, "Paused", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onCanceled() {
            downloadTask = null;
            stopForeground(true);
            Toast.makeText(DownloadService.this, "Canceled", Toast.LENGTH_SHORT).show();
        }
    };

    private DownloadBinder mBinder = new DownloadBinder();

    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }

    class DownloadBinder extends Binder {

        public void startDownload(String url) {
            if (downloadTask == null) {
                downloadUrl = url;
                downloadTask = new DownloadTask(listener);
                downloadTask.execute(downloadUrl);
                startForeground(1, getNotification("Downloading...", 0));
                Toast.makeText(DownloadService.this, "Downloading...", Toast.LENGTH_SHORT).show();
            }
        }

        public void pauseDownload() {
            if (downloadTask != null) {
                downloadTask.pauseDownload();
            }
        }

        public void cancelDownload() {
            if (downloadTask != null) {
                downloadTask.cancelDownload();
            } else {
                if (downloadUrl != null) {
                    // 取消下载时需将文件删除，并将通知关闭
                    String fileName = downloadUrl.substring(downloadUrl.lastIndexOf("/"));
                    String directory = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).getPath();
                    File file = new File(directory + fileName);
                    if (file.exists()) {
                        file.delete();
                    }
                    getNotificationManager().cancel(1);
                    stopForeground(true);
                    Toast.makeText(DownloadService.this, "Canceled", Toast.LENGTH_SHORT).show();
                }
            }
        }

    }

    private NotificationManager getNotificationManager() {
        return (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
    }

    private Notification getNotification(String title, int progress) {
        Intent intent = new Intent(this, MainActivity.class);
        PendingIntent pi = PendingIntent.getActivity(this, 0, intent, 0);
        NotificationCompat.Builder builder = new NotificationCompat.Builder(this);
        builder.setSmallIcon(R.mipmap.ic_launcher);
        builder.setLargeIcon(BitmapFactory.decodeResource(getResources(), R.mipmap.ic_launcher));
        builder.setContentIntent(pi);
        builder.setContentTitle(title);
        if (progress >= 0) {
            // 当progress大于或等于0时才需显示下载进度
            builder.setContentText(progress + "%");
            builder.setProgress(100, progress, false);
        }
        return builder.build();
    }
}

这段代码同样也比较长，我们还是得耐心慢慢看。
首先这里创建了一个DownloadListener的匿名类实例，并在匿名类中实现了onProgress()、 onSuccess()、 onFailed()、onPaused()和onCanceled()这5个方法。
在onProgress()方法中，我们调用getNotification()方法构建了一个用于显示下载进度的通知，然后调用 NotificationManager的notify()方法去触发这个通知，这样就可以在下拉状态栏中实时看到当前下载的进度了。在onSuccess()方法中，我们首先是将正在下载的前台通知关闭，然后了创建一个新的通知用于告诉用户下载成功了。其他几个方法也都是类似的，分别用于告诉用户下载失败、暂停和取消这几个事件。

接下来为了要让DownloadService可以和活动进行通信，我们又创建了一个 DownloadBinder。Downloadbinder中提供了startDownload()、 pauseDownload()和cancelDownload()这3个方法，那么顾名思义，它们分别是用于开始下载、暂停下载和取消下载的。
在startDownload()方法中，我们创建了一个 DownloadTask的实例，把刚才的DownloadListener作为参数传入，然后调用execute()方法开启下载，并将下载文件的URL地址传入到execute()方法中。同时为了让这个下载服务成为一个前台服务，我们还调用了startForeground()方法，这样会在系统状态栏中创建一个持续运行的通知了。接着往下看，pauseDownload()方法中的代码就非常简单了，就是简单地调用了ー下DownloadTask 中的pauseDownload()方法。cancelDownload()方法中的逻辑也基本类似，但是要注意，取消下载的时候我们需要将正在下载的文件删除掉，这一点和暂停下载是不同的。

另外，DownloadService类中所有使用到的通知都是调用getNotification()方法进行构建的，这个方法中的代码我们之前基本都是学过的、只有一个 setProgress()方法没有见过
setProgress()方法接收3个参数
第一个参数传入通知的最大进度
第二个参数传入通知的当前进度
第三个参数表示是否使用模糊进度条，这里传入false。
设置完setProgress()方法通知上就会有进度条显示出来了。

现在下载的服务也已经成功实现，后端的工作基本都完成了，那么接下来我们开始编写前端的部分。

• 修改activity_main.xml中的代码

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <Button
        android:id="@+id/start_download"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Start Download" />

    <Button
        android:id="@+id/pause_download"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Pause Download" />

    <Button
        android:id="@+id/cancel_download"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Cancel Download" />

</LinearLayout>

布局中三个按钮分别用于开始、暂停和取消下载。

• 修改MainActivity中的代码

public class MainActivity extends AppCompatActivity implements View.OnClickListener{

    private DownloadService.DownloadBinder downloadBinder;

    private ServiceConnection connection = new ServiceConnection() {

        @Override
        public void onServiceDisconnected(ComponentName name) {
        }

        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            downloadBinder = (DownloadService.DownloadBinder) service;
        }

    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Button startDownload = (Button) findViewById(R.id.start_download);
        Button pauseDownload = (Button) findViewById(R.id.pause_download);
        Button cancelDownload = (Button) findViewById(R.id.cancel_download);
        startDownload.setOnClickListener(this);
        pauseDownload.setOnClickListener(this);
        cancelDownload.setOnClickListener(this);
        Intent intent = new Intent(this, DownloadService.class);
        startService(intent); // 启动服务
        bindService(intent, connection, BIND_AUTO_CREATE); // 绑定服务
        if (ContextCompat.checkSelfPermission(MainActivity.this, Manifest.permission.WRITE_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED) {
            ActivityCompat.requestPermissions(MainActivity.this, new String[]{ Manifest.permission. WRITE_EXTERNAL_STORAGE }, 1);
        }
    }

    @Override
    public void onClick(View v) {
        if (downloadBinder == null) {
            return;
        }
        switch (v.getId()) {
            case R.id.start_download:
                String url = "https://raw.githubusercontent.com/guolindev/eclipse/master/eclipse-inst-win64.exe";
                downloadBinder.startDownload(url);
                break;
            case R.id.pause_download:
                downloadBinder.pauseDownload();
                break;
            case R.id.cancel_download:
                downloadBinder.cancelDownload();
                break;
            default:
                break;
        }
    }

    @Override
    public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
        switch (requestCode) {
            case 1:
                if (grantResults.length > 0 && grantResults[0] != PackageManager.PERMISSION_GRANTED) {
                    Toast.makeText(this, "拒绝权限将无法使用程序", Toast.LENGTH_SHORT).show();
                    finish();
                }
                break;
            default:
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        unbindService(connection);
    }
}

可以看到，这里我们首先创建了一个ServiceConnection的匿名类，然后在onServiceConnected()方法中获取到DownloadBinder的实例，有了这个实例，我们就可以在活动中调用服务提供的各种方法了。

接下来看一下onCreate()方法，在这里我们对各个按钮都进行了初始化操作并设置了点击事件，然后分别调用了startService()和bindService(()方法来启动和绑定服务。这一点至关重要，因为启动服务可以保证 DownloadService一直在后台运行，绑定服务则可以让MainActivity和DownloadService进行通信，因此两个方法调用都必不可少。在onCreate()方法的最后，我们还进行了WRITE_EXTERNAL_STORAGE的运行时权限申请，因为下载文件是要下载到SD卡的Download目录下的，如果没有这个权限的话，我们整个程序都无法正常工作。

接下来的代码就非常简单了，在onClick()方法中我们对点击事件进行判断
如果点击了开始按钮就调用 DownloadBinder的startDownload()方法
如果点击了暂停按钮就调用pauseDownload()方法
如果点击了取消按钮就调用 canceldown Load()方法。
startDownload()方法中你可以传入任意的下载地址，这里我使用了一个Eclipse的下载地址，以此向这个 Android平台上曾经最出色的开发工具致敬。

另外还有一点需要注意，如果活动被销毁了，那么一定要记得对服务进行解绑，不然就有可能会造成内存泄漏。这里我们在onDestroy()方法中完成了解绑操作。

现在只差最后一步了，我们还需要在AndroidManifest.xml文件中声明使用到的权限。当然除了权限之外， MainActivity和DownloadService也是需要声明的，不过 Android Studio应该早就帮我们将这两个组件声明好了，如下所示

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.servicebestpractice">

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

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

        <service
            android:name=".DownloadService"
            android:enabled="true"
            android:exported="true" />
    </application>

</manifest>

其中，由于我们的程序使用到了网络和访问SD卡的功能，因此需要声明INTERNET和WRITE_EXTERNAL_STORAGE这两个权限

现在运行程序查看效果

Screenshot_2019-05-16-23-19-33-644_com.lbe.securi.png

程序一启动立刻就会申请访问SD卡的权限，这里我们点击ALLOW，然后点击Start Download按钮就可以开始下载了。下载过程中可以下拉系统状态栏查看实时的下载进度，如图所示。

同时，我们还可以点击Pause Download或Cancel Download，甚至于断网操作来测试这个下载程序的健壮性。最终下载完成后会弹出一个Download Success的通知

20190516_231244.gif

然后我们可以通过任意一个文件浏览器来查看一下SD卡的Download目录，如图所示

Screenshot_2019-05-16-23-15-46-732_com.android.fi.png

可以看到，文件已经成功下载下来了。

总体来说，这个下载示例的稳定性还是挺不错的，而且综合性很强，