Skip to content

README.ch.md

Latest commit

 

History

History
174 lines (128 loc) · 4.75 KB

README.ch.md

File metadata and controls

174 lines (128 loc) · 4.75 KB

RxDownload

基于RxJava打造的下载工具, 支持多线程下载和断点续传,使用Kotlin编写

Read this in other languages: 中文, English 

使用方式

准备

1.添加Gradle依赖 Download 

dependencies{
    compile 'zlc.season:rxdownload3:1.1.9'
}

2.配置权限

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

注意: Android 6.0 以上还必须申请运行时权限, 如果遇到不能下载, 请先检查权限

下载

1.创建任务

创建一个任务，并且接收下载的状态

val disposable = RxDownload.create(mission)
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe { status ->
                    setProgress(status)
                    setActionText(status)
                }

注意：下载状态的接收也是在这里进行，接收到的status会根据不同的下载状态自动更新。 重复调用不会导致任务多次创建，因此可以在任何想要接收状态的地方调用该方法来接收下载的状态。

2.开始下载

RxDownload.start(mission).subscribe()

3.停止下载

RxDownload.stop(mission).subscribe()

只需三步, 就是这样简单!!

提示: 创建任务是一个异步操作, 因此如果需要创建成功后立即开始下载有以下方式：

  • 在create()完成的回调中进行，如下
val disposable = RxDownload.create(mission)
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe { status ->
                    //开始下载
                    RxDownload.start(mission).subscribe()
                    setProgress(status)
                    setActionText(status)
                }
  • 或者启用autoStart配置，当autoStart处于开启状态时，create任务完成以后就会自动start开始下载
DownloadConfig.Builder.create(context)
                  .enableAutoStart(true)
                  ...
                  
                  
DownloadConfig.init(builder)

更多API请移步RxDownload.kt

配置

在APP启动时添加您的配置,就像这样:

class BaseApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        val builder = DownloadConfig.Builder.create(this)
                .enableDb(true)
                .enableNotification(true)
				...

        DownloadConfig.init(builder)
    }
}

拥有丰富的配置选项满足您的需求:

DownloadConfig.Builder.create(this)
                .setFps(20)                         //设置更新频率
                .enableAutoStart(true)              //自动开始下载
                .setDefaultPath("custom download path")     //设置默认的下载地址
                .enableDb(true)                             //启用数据库
                .setDbActor(CustomSqliteActor(this))        //自定义数据库
                .enableService(true)                        //启用Service
                .enableNotification(true)                   //启用Notification
                .setNotificationFactory(NotificationFactoryImpl()) 	    //自定义通知
                .setOkHttpClientFacotry(OkHttpClientFactoryImpl()) 	    //自定义OKHTTP
                .addExtension(ApkInstallExtension::class.java)          //添加扩展

扩展

定制您的专属操作

class CustomExtension:Extension {
    override fun init(mission: RealMission) {
        //Init
    }

    override fun action(): Maybe<Any> {
        //Your action
    }
}

可参考ApkInstallExtension代码

混淆

无特殊混淆, 只需添加Retrofit及OKHTTP的混淆即可

-dontnote retrofit2.Platform
-dontwarn retrofit2.Platform$Java8
-keepattributes Signature
-keepattributes Exceptions

-dontwarn okhttp3.**
-dontwarn okio.**
-dontwarn javax.annotation.**

License

Copyright 2017 Season.Zlc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.