EasyAndroid

Project Url: yjfnypeu/EasyAndroid
Introduction: 一系列简单、轻量、方便的 Android 开发工具集合(持续更新中)
More: Author   ReportBugs   
Tags:

在平时的开发过程中,我们经常会需要使用到一些基础功能组件,比如 Toast,比如 Log 等。

而这些功能组件,在开发时需要使用到的功能点其实相当有限,所以这也意味着,我们对此类组件的要求是:简单、轻量、易用!相对应的,此类组件的封装库,也应该尽量实现得轻巧精练

EasyAndroid即是专门针对此种需求所设计的一款基础组件集成库

宗旨

1. 设计独立

组件间独立存在,不相互依赖,且若只需要集成库中的部分组件。也可以很方便的只 copy 对应的组件文件进行使用

2. 设计轻巧

因为是组件集成库,所以要求每个组件的设计尽量精练、轻巧。避免因为一个小功能而引入大量无用代码.

每个组件的方法数均不超过 100. 大部分组件方法数甚至不超过 50

添加依赖

  1. 添加 jitpack 仓库依赖
maven { url 'https://jitpack.io' }
  1. 添加依赖

lastest_version =

implementation "com.github.yjfnypeu:EasyAndroid:$lastest_version"
  1. 初始化

在 Application 中调用初识化方法:

EasyAndroid.init(application)

然后即可直接使用

目录索引

EasySharedPreferences

使用一个具体的实体类,进行 SharedPreferences 数据存取

  • 通过具体的实体类进行 SP 数据存储操作。避免key 值硬编码
  • 自动同步,即使别的地方是直接使用 SharedPreferences 进行赋值,也能自动同步相关数据。
  • 打破 SharedPreferences 限制。支持几乎任意类型数据存取

用法示例:

// 以 SharedPreferences 文件名为 user_info,存储数据为 username, age, address 为例

// 1. 创建映射实体类
@PreferenceRename("user_info")
class User:PreferenceSupport() {
    var username:String
    var age:Int
    var address:String
}

// 2. 进行读取
val user = EasySharedPreferences.load(User::class.java)

// 3. 进行修改

// 直接使用 load 出来的 user 实例进行数值修改
user.age = 16
user.username = "haoge"

// 修改完毕后,apply 更新修改到 SharedPreferences 文件。
user.apply()

EasyDimension

用于灵活的进行设备尺寸单位转换

支持全尺寸数值转换。

用法示例

// 转换 10dp 到 px
EasyDimension.withDIP(10).toPX()
// 转换 30sp 到 MM
EasyDimension.withSP(30).toMM()

EasyFormatter

用于对任意类型数据,进行格式化输出排版,结合 log 打印组件使用,使 log 输出展示更清晰

  • 支持对Set/List/Map/JSON/POJO数据进行格式化排版
  • 支持最高长度过滤:避免打印超长数据时造成版面浪费

用法示例:

// 创建待格式化数据
val any:Any = create()
// 使用 formatter 实例进行格式化
val result:String = EasyFormatter.DEFAULT.format(any)
// 或者使用扩展函数。直接格式化
val result2:String = any.easyFormat()

EasyLog

用于简单的进行日志打印输出,支持格式化输出、自定义打印格式。

  • 不阻塞:打印任务运行于独立线程中,避免大量打印数据时造成 UI 阻塞。
  • 安全: 对打印任务做好了异常处理。不用担心出现 crash 问题
  • 使用 EasyFormatter 对任意数据进行格式化排版
  • 支持添加自定义规则
  • 灵活、直观的进行输出样式定制
  • 自动适配 TAG. 也可手动指定。
  • 使用开关。关闭线上包的日志输出。
  • 使用'上边界'逻辑进行栈帧匹配,支持二次封装使用

用法示例:

val any:Any = create()// 创建待打印数据
EasyLog.DEFAULT.d(any)// 使用默认 log 实例进行数据打印. 以 Log.d()的方式进行输出
any.easyLogE()// 使用扩展函数直接进行数据打印,以 Log.e()的方式进行输出

EasyToast

用于进行 Toast 提示,可很简单的指定输出样式。

  1. 支持在任意线程下进行 toast 提示
  2. 非常方便的进行任意样式的定制
  3. 不管当前是否正在展示之前的数据。有新消息通知时,直接展示新消息,无需等待

博客地址:https://juejin.im/post/5b0638336fb9a07aa9261ce6

用法示例:

val message:String = create()// 创建待提示数据
EasyToast.DEFAULT.show(message)// 使用系统样式进行输出
EasyToast.create(layoutID:Int, tvID:Int, duration:Int).show(message)// 使用自定义样式进行输出

EasyReflect

对常规的反射操作进行封装。达到更便于使用反射的效果

博客地址:https://juejin.im/post/5b1de20c6fb9a01e701000cb

用法示例:

// 以类名 Test 为例
class Test private constructor(private val name:String) {
    private fun wrap(name:String):String = "包裹后的数据$name"
}

// 创建 Reflect 实例:
var reflect = EasyReflect.create(Test::class.java).instance("默认参数")

// 为 name 字段赋值:
reflect.setField("name", "EasyReflect")
// 读取 name 字段的值:"EasyReflect"
val value = reflect.getValue("name")

// 调用方法 wrap 方法,并传入参数 value
reflect.call("wrap", value)
// 调用 wrap 方法,并获取返回值: "包裹后的数据 EasyReflect"
val result = reflect.callWithReturn("wrap", value).get<String>()

EasyActivityResult

用于解决 onActivityResult 业务逻辑臃肿的问题

  • 业务解耦分离: 各自启动业务线处理各自的回调逻辑
  • 去除 requestCode: 进行启动时自动生成随机的 requestCode, 不用再为每个启动任务分别配置请求码了。
  • 防暴击: 防止快速点击时启动多个重复页面

博客地址:https://juejin.im/post/5b21d019e51d4506d93701ba

用法示例:

EasyActivityResult.startActivity(activity, Intent(activity, DemoActivity::class.java),
        { resultCode:Int, data:Intent? ->
            // 直接在此进行返回数据处理
        })

EasyPermissions

进行 6.0+的动态权限请求

  • 链式调用
  • 支持定制权限申请说明弹窗
  • 支持同时申请多个权限
  • 多权限申请时进行去重与空过滤
  • 自动使用顶层 Activity 执行权限请求
  • 支持在任意线程进行权限申请

博客地址:https://juejin.im/post/5b1a2a326fb9a01e5d32f208

用法示例:

EasyPermissions.create(// 指定待申请权限
    Manifest.permission.WRITE_EXTERNAL_STORAGE,
    Manifest.permission.WRITE_CALENDAR,
    Manifest.permission.WRITE_CONTACTS
    )
    // 定制权限申请说明弹窗
    .rational { permission, chain ->
        AlertDialog.Builder(this)
                .setTitle("权限申请说明")
                .setMessage("应用需要此权限:\n$permission")
                .setNegativeButton("拒绝", {_, _ -> chain.cancel() })
                .setPositiveButton("同意", {_, _ -> chain.process() })
                .show()

        return@rational true
    }
    // 设置授权结果回调
    .callback { grant ->
        EasyToast.DEFAULT.show("权限申请${if (grant) "成功" else "失败"}")
    }
    // 发起请求
    .request()

EasyExecutor

用于进行安全高效便利的线程池操作功能组件

  • 安全: 直接 catch 住任务执行期间出现的异常。并通知给用户,避免出现 crash
  • 回调通知: 执行任务期间,有分别的生命周期作为通知。
  • 配置灵活: 可方便、灵活的对每次所启动的任务,配置线程名、回调等。
  • 任务延迟: 支持在每次启动任务前。指定延迟时间
  • 异步任务: 支持直接启动异步任务并回调传递数据
  • 线程切换: 支持指定回调方法所在的线程。默认为运行于 UI 线程中

用法示例

// 1. 第一步:创建示例
val executor =
    // size 为所需创建的线程池的大小。当 size <= 0 时。
    // 表示需要使用 newCachedThreadPool。
    EasyExecutor.newBuilder(size)
            .setName(name)// 默认的线程名
            .setPriority(priority)// 线程池中创建线程的优先级
            .onStart {threadName -> } // 默认任务启动时的回调
            .onSuccess {threadName -> }// 默认任务执行完毕后的回调
            .onError {threadName, throwable -> }// 默认任务执行出现异常时的回调
            .setDeliver(deliver)// 默认的回调任务派发器。用于将信息派发到指定线程去。
            .build()// 最后。执行创建

// 2. 第二步:启动任务
executor.execute(runnable:Runnable)// 启动普通任务
executor.async(callable:Callable<T>, result:(T) -> Unit)// 启动异步回调任务
executor.setDelay(delay).execute(runnable)// 延时启动任务

EasyBundle

用于使 Bundle 数据存取操作变得简单方便灵活强大

  1. 简化 Bundle 数据存取 api:
  2. 打破 Bundle 数据格式限制。支持对非可序列化对象进行存取。
  3. 支持注入操作。在进行页面跳转传值时。将会非常好用。

博客地址:https://juejin.im/post/5b2c65bde51d45587d2dd86f

用法示例:

// 1. 存储任意数据对象到 bundle 中去
EasyBundle.create(bundle)// 绑定 bundle 容器
    .put(key, value)// 指定任意数据进行存储。包括非可序列化对象

// 2. 从 bundle 中读取并自动转换为具体对象数据
EasyBundle.create(bundle).get<User>("user")

// 3. 支持数据自动注入
class ExampleActivity:BaseActivity() {
    // 从 intent 中读取 name 数据并注入到 name 字段中去
    @BundleField
    var name:String? = null
}

MVP

博客地址:https://juejin.im/post/5b4ee27ff265da0f98314f01

提供的一种简单的 MVP 分层架构实现。

  • 支持单页面绑定多个 Presenter 进行使用
  • 支持 P 层进行生命周期派发

用法示例

// 1. 创建页面通信协议接口:
interface CustomView:MVPView {
    // 定义通信协议方法:P 层将使用此方法驱动 V 层进行界面更新
    fun updateUI()
}

// 2. 创建 Presenter。并与对应的通信协议相绑定:
class CustomPresenter(view:CustomView):MVPPresenter(view) {
    // 直接创建对应的启动方法,供 V 层进行启动调用
    fun requestData() {
        // TODO 进行数据业务处理。并在处理完成后,通过 view 通知到 V 层
    }
}

// 3. 创建具体的 V 层(Activity or Fragment),并绑定 Presenter 进行使用:
class CustomActivity:BaseMVPActivity<CustomPresenter>, CustomView {
    override fun updateUI() {// TODO 进行界面更新}

    fun initPage() {
        // 通过绑定的 Presenter 发起任务
        presenter?.requestData()
    }
}

APIs

提供的一些其他零散的类库 APIs

联系作者

安卓交流会所

或者手动加入 QQ 群: 108895031

License

apache license 2.0

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea