Skip to content

Latest commit

 

History

History
247 lines (200 loc) · 8.65 KB

README.md

File metadata and controls

247 lines (200 loc) · 8.65 KB

CI MavenCentral API License

logo

ManageStartActivity [MSA]

ActivityResultLauncher辅助类,一行代码解决startActivityForResult过时问题。

基于registerForActivityResult实现,满足日常使用需求。

由于使用到了委托,所以只支持Kotlin,Java无法使用(或者说是没有使用的意义,变成了普通的方法调用)

Android提供的ActivityResultContracts默认协定完整sample ActivityResultContractsActivity


环境依赖

root gradle:

allprojects {
    repositories {
        // release依赖仓库(4.1后as默认配置有)
        mavenCentral()
    }
}

project dependencies:

dependencies {
    // need androidx appcompat
    implementation 'androidx.appcompat:appcompat:1.3.1'
    
    // Manage start activity
    implementation 'com.itxca.msa:msa:1.0.5'
}

文档

  • 1.0.4 非兼容升级, 现在必须在super.onCreate()后初始化 initManageStartActivity - 详情: #1

扩展简写说明

可以写IManageStartActivity by ManageStartActivity() , 也可以使用IMsa by msa()。完全一样,只是实现了一个简写。

// IMsa = IManageStartActivity
typealias IMsa =  IManageStartActivity

// msa() = ManageStartActivity()
fun msa(): ManageStartActivity = ManageStartActivity()

推荐基于Base类,方便统一管理。

// 注意实现 IMsa by msa() 委托
abstract class BaseActivity : AppCompatActivity(), IMsa by msa() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // 从 1.0.4 开始, 必须在`super.onCreate()`后初始化 `initManageStartActivity`
        // 因为需要使用 `SavedStateRegistry` 来保存回调状态
        initManageStartActivity()
    }
}
// 注意实现 IMsa by msa() 委托
abstract class BaseFragment : Fragment(), IMsa by msa()  {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // 从 1.0.4 开始, 必须在`super.onCreate()`后初始化 `initManageStartActivity`
        // 因为需要使用 `SavedStateRegistry` 来保存回调状态
        initManageStartActivity()
    }
}

SampleActivity

完整使用方法说明

// 注意实现 `IMsa by msa()` 委托
class SampleActivity : AppCompatActivity(), IMsa by msa() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // 从 1.0.4 开始, 必须在`super.onCreate()`后初始化 `initManageStartActivity`
        // 因为需要使用 `SavedStateRegistry` 来保存回调状态
        initManageStartActivity()
    }

    /**
     * 直接启动Activity
     * 3 种方式
     */
    fun startActivity() {
        // Android习惯模式,传入KClass即可
        startActivity(MainActivity::class, {
            // 自定义返回 ActivityOptionsCompat, 详细请查看README完整API说明
            null
        }) {
            putExtra("key", "value")
        }

        // KClass扩展方法模式
        MainActivity::class.start {
            putExtra("key", "value")
        }

        // Intent扩展方法模式
        Intent(this, MainActivity::class.java).apply {
            putExtra("key", "value")
        }.start()
    }

    /**
     * 启动Activity并需要回调结果
     * 4 种方法
     */
    fun startActivityForResult() {
        // Android习惯模式,传入KClass即可
        startActivityForResult(MainActivity::class, {
            putExtra("key", "value")
        }) { code: Int, data: Intent? ->
            // code = resultCode
        }

        // KClass扩展方法模式
        MainActivity::class.startForResult({
            putExtra("key", "value")
        }) {code: Int, data: Intent? ->
            // code = resultCode
        }

        // Android习惯模式,传入Intent即可
        startActivityForResult(Intent(this, MainActivity::class.java).apply {
            putExtra("key", "value")
        }){ code: Int, data: Intent? ->
            // code = resultCode
        }

        // Intent扩展方法模式
        Intent(this, MainActivity::class.java).apply {
            putExtra("key", "value")
        }.startForResult { code: Int, data: Intent? ->
            // code = resultCode
        }
    }

    /**
     * Kotlin协程挂起函数
     * 4 种方式
     */
    fun startActivityForResultCoroutine() {
        lifecycleScope.launch {
            // Android习惯模式,传入KClass即可
           val (code1: Int, data1: Intent?) = startActivityForResultSync(MainActivity::class) {
               putExtra("key", "value")
           }

            // KClass扩展方法模式
            val (code2: Int, data2: Intent?) = MainActivity::class.startForResultSync {
                putExtra("key", "value")
            }

            // Android习惯模式,传入Intent即可
            val (code3: Int, data3: Intent?) = startActivityForResultSync(Intent(this@SampleActivity, MainActivity::class.java).apply {
                putExtra("key", "value")
            })

            // Intent扩展方法模式
            val (code4: Int, data4: Intent?) = Intent(this@SampleActivity, MainActivity::class.java).apply {
                putExtra("key", "value")
            }.startForResultSync()
        }
    }
}

完整API

// startActivityForResult
fun startActivityForResult(target: KClass<out Activity>, block: Intent.() -> Unit = {}, options: () -> ActivityOptionsCompat? = { null }, result: StartActivityResult)
fun <T : KClass<out Activity>> T.startForResult(block: Intent.() -> Unit = {}, options: () -> ActivityOptionsCompat? = { null }, result: StartActivityResult)
suspend fun startActivityForResultSync(target: KClass<out Activity>, options: () -> ActivityOptionsCompat? = { null }, block: Intent.() -> Unit = {}): Result
suspend fun <T : KClass<out Activity>> T.startForResultSync(options: () -> ActivityOptionsCompat? = { null }, block: Intent.() -> Unit = {}): Result

// intent startActivityForResult
fun startActivityForResult(intent: Intent, options: () -> ActivityOptionsCompat? = { null }, result: StartActivityResult)
fun Intent.startForResult(options: () -> ActivityOptionsCompat? = { null }, result: StartActivityResult)
suspend fun startActivityForResultSync(intent: Intent, options: () -> ActivityOptionsCompat? = { null }): Result
suspend fun Intent.startForResultSync(options: () -> ActivityOptionsCompat? = { null }): Result

// startActivity
fun startActivity(target: KClass<out Activity>, options: () -> ActivityOptionsCompat? = { null }, block: Intent.() -> Unit = {})
fun <T : KClass<out Activity>> T.start(options: () -> ActivityOptionsCompat? = { null }, block: Intent.() -> Unit = {})
fun Intent.start(options: () -> ActivityOptionsCompat? = { null })

Change

更新历史


Screenshots

screenshot1 screenshot2


screenshot3 screenshot4


License

MIT License

Copyright (c) 2021 TxcA

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.