RxUpDownloader

RxUpDownloader 使用RxJava2+Retrofit2+OkHttp3 以及IntentService来 下载/上传 文件。而且支持进度回调、任务状态通知(成功/失败)以及取消任务。 使用起来非常简单,适合直接拿来使用。

入门

第一步是将RxUpDownloader集成到你的项目中。

  • 因为library放在 jitpack.io上, 所以首先需要将 jitpack.io 仓库加入到你的项目根Gradle中:
allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }
  • 接下来将UpDownloader加入到项目中:
dependencies {
            ...
            implemention 'com.github.wind0ws:rxupdownloader:x.y.z'
    }

如果你的gradle版本低于3.0, 那么你需要将 implemention 关键词替换为 compile.
提示: 你应该将 x.y.z 替换为正确的版本, 你可在 发布页 找到版本号.

好了, 我们已经完成集成了。

Hello,World.

RxUpDownloader 需要在manifest.xml中添加 UpDownService , 因为这个library的原理就是将上传下载任务发给这个Service,由他在后台下载/上传。
参考示例:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.threshold.rxupdownloader">
    <!-- 需要添加 网络 和 存储权限 去上传/下载-->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

    <application
        android:name=".App"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">

        <!-- 这就是我们添加的service,由他来负责上传下载任务 -->
        <service android:name="com.threshold.updownloader.UpDownService"/>

        <activity
            android:name=".MainActivity"
            android:label="@string/app_name"
            android:theme="@style/AppTheme.NoActionBar">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

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

    </application>

</manifest>

注意: 从Android6.0开始,Android新增了运行时权限,所以仅仅在manifest.xml中声明所需的权限是不够的,你还应该在应用中申请存储权限:WRITE_EXTERNAL_STORAGE,否则在上传下载的时候由于没有权限会导致应用闪退。

现在我们应该有上传下载文件的能力了:

  • 下载文件:
 UpDownService.startServiceForDownload(context,1002,true,
                    "http://issuecdn.baidupcs.com/issue/netdisk/yunguanjia/BaiduNetdisk_5.6.3.exe")
  • 上传文件:
UpDownService.startServiceForUpload(context,1001,
                                  "http://your.restful.website/files","/sdcard/1.txt")

上面参数中的 "1001" and "1002" 是 taskId, 你可以通过
UpDownService.getTaskDisposable(taskId) 来获取这个任务的 disposable , 然后你可以通过这个disposable来取消任务.
所有的上传/下载任务都只在后台线程执行.

监听上传/下载状态:

我们使用 RxBus2 来发射/监听 进度/成功/失败 事件.

示例如下:

          RxBus.getDefault()
                .ofType(UpDownEvent::class.java)
                .filter {
                    //   it.taskId == 1002
                    it.type == UpDownEvent.Type.DOWNLOAD
                }
                .subscribeOn(Schedulers.io())
                .observeOn(Schedulers.io())
                .subscribe {
                    when (it) {
                        is UpDownProgressEvent -> {
                            info { "Current progress: ${it.percent}" }
                        }
                        is UpDownSucceedEvent -> debug { "Download succeed: $it" }
                        is UpDownFailedEvent -> debug { "Download failed: $it" }
                    }
                }

注意:不是所有的下载任务都能获取到进度值。能不能获取到下载进度值取决于你的下载服务器:如果你的服务器返回的 content-typeapplication/octet-stream, 那么就获取不到content-length的值,所以就无法计算下载进度。
默认的content-length是 -1, 所以如果你发现进度低于0,这就意味着这个进度不是真实的进度,他的绝对值实际上是目前已下载的数据的大小(单位:字节)
通常来说,进度值范围为0~100
UpDownSucceedEvent UpDownFailedEvent 事件是一直可靠的.

  • UpDownSucceedEvent 对应 下载/上传 成功事件.
  • UpDownFailedEvent 对应 下载/上传 失败事件.

Want demo?

看看这个项目的 app 模块。

关注我的公众号.jpg
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,311评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,339评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,671评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,252评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,253评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,031评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,340评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,973评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,466评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,937评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,039评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,701评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,254评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,259评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,497评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,786评论 2 345

推荐阅读更多精彩内容