Skip to content

Latest commit

 

History

History
227 lines (164 loc) · 7.28 KB

README_CN.md

File metadata and controls

227 lines (164 loc) · 7.28 KB

Longan

English | 中文

Longan 是一个简化 Android 开发的 Kotlin 工具库，可以使代码更加简洁易读。目前有超过 500 个常用方法或属性，能有效提高开发效率。

个人认为 API 设计对 Kotlin 工具类来说非常重要，因为 Kotlin 玩法很多，可以设计出很骚的用法，但不一定好用。所以个人花了大量时间去斟酌每一个扩展的用法，每个命名和用法都是经过了非常多的考虑，既要简洁易用又要清晰地描述功能不产生歧义。有的会参考官方 KTX 库的命名规则和用法，与官方用法统一能降低点学习成本。会用尽可能简洁轻量的代码实现功能，有兴趣的可以读下源码。整体会比大多数人封装的工具类好用。

本库会长期维护，有任何使用上的问题或者想要的功能都可以反馈。

Gradle

在根目录的 build.gradle 添加：

allprojects {
    repositories {
        // ...
        maven { url 'https://www.jitpack.io' }
    }
}

添加依赖：

dependencies {
    implementation 'com.github.DylanCaiCoding.Longan:longan:1.1.1'
    // Optional
    implementation 'com.github.DylanCaiCoding.Longan:longan-design:1.1.1'
}

用法

📝 >> 使用文档 <<

示例

下面介绍部分常用的功能：

在需要 Context 或 Activity 的时候，可直接获取 application 或 topActivity 属性。

跳转 Activity 并传参：

startActivity<SomeOtherActivity>("id" to 5)

在 Activity 内使用属性委托获取参数：

class SomeActivity : AppCompatActivity() {
  private val name: String? by intentExtras("name")          // 通过 Intent 获取可空的参数
  private val position: Int by intentExtras("position", 0)   // 通过 Intent 获取含默认值的非空参数
  private val id: String by safeIntentExtras("id")           // 通过 Intent 获取人为保证非空的参数
}

创建带参数的 Fragment：

val fragment = SomeFragment().withArguments("id" to 5)

在 Fragment 内使用属性委托获取参数：

class SomeFragment : Fragment() {
  private val name: String? by arguments("name")          // 通过 arguments 获取可空的参数
  private val position: Int by arguments("position", 0)   // 通过 arguments 获取含默认值的非空参数
  private val id: String by safeArguments("id")           // 通过 arguments 获取人为保证非空的参数
}

显示 Toast 或 Snackbar 消息：

toast("Hi there!")
snackbar("Action, reaction", "Click me!") { doStuff() }

显示隐藏键盘：

editText.showKeyboard()
editText.hideKeyboard()

快速实现 TabLayout + ViewPager2 的自定义样式的底部导航栏：

viewPager2.adapter = FragmentStateAdapter(HomeFragment(), ShopFragment(), MineFragment())
tabLayout.setupWithViewPager2(viewPager2, enableScroll = false) { tab, position ->
  tab.setCustomView(R.layout.layout_bottom_tab) {
    findViewById<TextView>(R.id.tv_title).setText(titleList[position])
    findViewById<ImageView>(R.id.iv_icon).apply {
      setImageResource(iconList[position])
      contentDescription = getString(titleList[position])
    }
  }
}

一行代码实现双击返回键退出 App 或者点击返回键不退出 App 回到桌面：

pressBackTwiceToExitApp("再次点击退出应用")
// pressBackToNotExitApp()

实现沉浸式状态栏，并且给标题栏的顶边距增加状态栏高度，可以适配刘海水滴屏：

immerseStatusBar()
toolbar.addStatusBarHeightToMarginTop()
// toolbar.addStatusBarHeightToPaddingTop()

快速实现获取验证码的倒计时（默认 60 秒）：

btnSendCode.startCountDown(this,
  onTick = {
    text = "${it}秒"
  },
  onFinish = {
    text = "获取验证码"
  })

设置按钮在输入框有内容时才能点击：

btnLogin.enableWhenOtherTextNotEmpty(edtAccount, edtPwd)

点击事件可以设置的点击间隔，防止一段时间内重复点击：

btnLogin.doOnClick(clickIntervals = 500) {
  // ...
}

在 RecyclerView 数据为空的时候自动显示一个空布局：

recyclerView.setEmptyView(this, emptyView)

RecyclerView 的 smoothScrollToPosition() 方法是滑动到 item 可见，如果从上往下滑会停在底部，一般不符合需求。所以增加了个始终滑动到顶部位置的扩展方法。

recyclerView.smoothScrollToStartPosition(position)

简化自定义控件获取自定义属性：

withStyledAttributes(attrs, R.styleable.CustomView) {
  textSize = getDimension(R.styleable.CustomView_textSize, 12.sp)
  textColor = getColor(R.styleable.CustomView_textColor, getCompatColor(R.color.text_normal))
  icon = getDrawable(R.styleable.CustomView_icon) ?: getCompatDrawable(R.drawable.default_icon)
  iconSize = getDimension(R.styleable.CustomView_iconSize, 30.dp)
}

自定义控件绘制居中或者垂直居中的文字：

canvas.drawCenterText(text, centerX, centerY, paint)
canvas.drawCenterVerticalText(text, centerX, centerY, paint)

切换到主线程，用法与 thread {...} 保持了统一：

mainThread {
  // ...
}

更多的用法请查看使用文档。

更新日志

Releases

相关文章

反馈

有任何使用上的问题或者想要的功能都可以提 issues 或者加我微信 DylanCaiCoding 直接反馈。

作者其它的库

库 简介
LoadingStateView 深度解耦标题栏或加载中、加载失败、无数据等视图，支持两行代码集成到基类
ViewBindingKTX 最全面的 ViewBinding 工具
MMKV-KTX 最灵活易用的 MMKV 工具
Tracker 基于西瓜视频的责任链埋点思路实现的轻量级埋点框架

License

Copyright (C) 2021. Dylan Cai

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.