Honoka Android Utils

简介

Honoka Android Utils是一款包含了各式各样实用工具的Android开发工具包。其针对Android基本组件（ContentProvider、Service）、OrmLite框架、Ktor Server、WebView等进行了高度封装，提供了许多默认实现和便捷的方法。引入本工具包的项目，能基于这些类，实现快速创建常用功能齐全的自定义ContentProvider与Service、快速创建基于某个实体类的SQLite DAO以读写SQLite中的对应数据表的数据、快速启动HTTP服务以对外提供访问应用内静态资源（assets）的接口及获取自定义动态数据的接口、快速创建具有全屏WebView且支持异步JavascriptInterface的WebActivity等功能。

本项目采用Apache-2.0 License，使用本项目时，请遵守此开源许可证的相关规定。

本项目中的所有代码并未经过严格测试，请勿用于生产环境。

请参阅：更新日志

功能展示

BaseContentProvider

能基于call方法，实现与其他应用通过JSON数据进行通信的ContentProvider。继承该类时，仅需实现一个方法：

//JSON类来自于hutool，是JSONObject和JSONArray的父类
abstract fun call(method: String?, args: JSON?): Any?

返回值类型可以是任何基本数据类型、String、任何实体类或任何实体类的集合（即任何能够被存放在JSONObject对象中的类型）。

在一个应用中调用另一个应用提供的基于BaseContentProvider实现的ContentProvider时，可使用本工具包所提供的两个方法中的任意一个：

//返回值类型可能为JSONObject、JSONArray或基本数据类型
fun ContentResolver.call(authority: String, method: String? = null, args: Any? = null): Any?

//基于上述方法返回的值，尝试将其转换为指定类型的实体类或集合
inline fun <reified T> ContentResolver.typedCall(
    authority: String, method: String? = null, args: Any? = null
): T

注：基于BaseContentProvider实现的ContentProvider仍需在AndroidManifest.xml中注册。

BaseDao<T>

基于OrmLite封装了常用CRUD方法的基础DAO类，支持自动建库建表（单库单表，一个.db文件中只包含一张表）、自动升级降级数据表、基于OrmLite的QueryBuilder<T, ID>编写查询DSL等功能。

要使用BaseDao<T>，需先按以下示例创建一个实体类：

import com.j256.ormlite.field.DatabaseField
import com.j256.ormlite.table.DatabaseTable
import de.honoka.sdk.util.android.database.Table

/*
 * @Table(version = 1)代表该实体类所对应的.db文件（单库单表）中的数据库的版本，若该实体类所对应
 * 的BaseDao的子类在被初始化时，检测到应用数据目录中的该实体类所对应的.db文件与此处定义的版本不符，
 * 则触发数据表的自动升级降级。
 */
@Table(version = 1)
@DatabaseTable(tableName = "some_entity")
data class SomeEntity(

    @DatabaseField(id = true)
    var id: String? = null,

    @DatabaseField
    var name: String? = null,

    @DatabaseField
    var enabled: Boolean? = null
)

然后创建一个object类（Kotlin中的单例对象），继承BaseDao，将此类作为泛型和Class对象传入：

object SomeEntityDao : BaseDao<SomeEntity>(SomeEntity::class.java)

在任何一个地方首次调用SomeEntityDao中的任何成员（包括继承的成员）时，其所继承的来自BaseDao中的成员才会被初始化，此时才可能会触发数据表的升级或降级。

若想在应用启动时就初始化所有BaseDao的子类，可在项目中创建任意一个继承AbstractAndroidDatabaseUtils类的自定义子类，并在实现抽象属性daoInstances时，引用每一个需要被初始化的BaseDao的子类，并在应用启动时即调用该子类的initDaoInstances()方法。

AbstractWebActivity

仅包含一个全屏WebView的Activity的子类，其中包含了针对网页触发的全局全屏（可使状态栏隐藏的全屏，通常由网页中的视频播放器触发）的默认实现、全局全屏（横屏）时的重力感应旋屏、返回键触发网页后退、将Activity事件传递到WebView中的JavaScript层的实现、自动注册多个包含JavascriptInterface或AsyncJavascriptInterface的对象等功能。

要使用AbstractWebActivity，可选择直接使用DefaultWebActivity，或继承AbstractWebActivity创建一个自定义的Activity，然后实现抽象属性definedJsInterfaceInstances，传入包含JavascriptInterface方法的一个或多个类的实例列表，例如：

class WebActivity : AbstractWebActivity() {

    override val definedJsInterfaceInstances: List<Any> = listOf(
        AnyJsInterface()
    )

    override fun extendedOnResume() {
        //需要在onResume方法被调用时执行的额外操作
    }
}

有关AsyncJavascriptInterface方法的实现原理，请参考源代码。

HttpServer

基于Ktor框架实现的HTTP服务，能使应用具有监听端口，对外提供HTTP服务的功能。

要使应用启动一个HTTP服务，只需直接调用HttpServer.createInstance()即可。HttpServer所监听的默认端口为38081，服务启动前将会检测端口占用情况，若端口被占用，则自动依次按端口号向下寻找可用的端口号，最多寻找10个端口号。若希望更改默认端口号，仅需在调用createInstance()前，修改HttpServerVariables.serverPort的值即可。

默认情况下，HttpServer仅提供静态资源服务，包含以下URL与静态资源的映射:

URL	静态资源
`/`、`/index.html`、任何未定义的路由	`[assets]/web/index.html`
`/assets/**`	`[assets]/web/assets/**`
`/font/**`	`[assets]/web/font/**`
`/img/**`	`[assets]/web/img/**`
`/js/**`	`[assets]/web/js/**`
`/favicon.ico`	`[assets]/web/favicon.ico`
`/android/img/**`	`[Application.dataDir]/**`

要添加自定义路由及其处理逻辑，可在调用createInstance()前，为customRoutingList变量重新赋值一个包含自定义路由定义的List。

customRoutingList中的成员均为io.ktor.server.routing.Routing类的扩展函数，请参考Ktor官方文档了解如何基于编写Routing的扩展函数的方式，编写自定义路由的处理逻辑。

使用

本项目部署于：

使用前请先阅读此仓库的文档，为你的Gradle添加依赖仓库。

项目的各个版本号请前往Releases查看。

Gradle

Groovy DSL

dependencies {
    implementation 'de.honoka.sdk:honoka-android-utils:版本号'
}

Kotlin DSL

dependencies {
    implementation("de.honoka.sdk:honoka-android-utils:版本号")
}

kosaka-bun / honoka-android-utils