Kotlin/Native KMM项目架构

编程之家收集整理的这篇文章主要介绍了Kotlin/Native KMM项目架构编程之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

一、什么是KMM?

Kotlin Multiplatform Mobile ( KMM ) 是一个 SDK,旨在简化跨平台移动应用程序的创建。在 KMM 的帮助下,您可以在 iOS 和 Android 应用程序之间共享通用代码,并仅在必要时编写特定于平台的代码

KMM用纯Kotlin编写一次代码,即可在iOS和Android上运行,开发应用的公共业务逻辑只需要编写一次。KMM减少了为不同平台编写和维护相同代码所花费的时间。在Jenkins上一次构建可以产出aar、framework、klib,Android依赖aar,iOS依赖framework,性能与原生一致。当然可以使用KMM依赖klib开发Android、iOS应用。

二、KMM项目架构

项目架构主要分为原生系统层、Android/iOS业务SDK层、KMM SDK层、KMM业务逻辑SDK层、iOS sdkframework层、Android/iOS App层。

原生系统层:这里提下原生系统层的目的是,有些平台特性需要分开实现,比如读取文件、打印日志、摄像头等。

Android/iOS业务SDK层:主要是包括一些现有的Android/iOS SDK,需要直接依赖现有SDK来开发KMM时,在commonMain expect声明接口,在androidMain、iosMain actual分别依赖现有SDK实现。这样就可以使用已有的SDK,后续也可以保持接口不变,直接使用KMM实现SDK,如alog、PlatformMMKV。

KMM SDK层:如alog、PlatformMMKV写成一个SDK可以供其他KMM模块(business)使用。

KMM业务逻辑SDK层:具体业务的逻辑模块,比如登录逻辑、获取首页列表逻辑、查看首页列表数据详情等。

iOS sdkframework层:Kotlin/Native构建一个framework时,产物是二进制,也包含了Kotlin/Native的基础库、Runtime,会使包大小增加1M+左右,而且多个Kotlin/Native构建的framework不会共享基础库导致每一个framework都会增加1M+,为了避免包过大,统一构建一个framework。

App层:Android的依赖无变化,依赖aar或者jar;iOS依赖sdkframework,这样iOS包大小只增加1M+。当然如果依赖了一些库如ktor网络库,包也会变大,避免这个问题也可以不用依赖ktor,直接依赖现有的网络库来实现一个KMM SDK。

三、使用expect/actual编写平台特定的代码

以打印日志为例,打造一个alog日志SDK

在commonMain定义IALog接口,声明fun v函数,其他函数忽略。并定义expect ALogImpl类来实现平台特性打印日志

interface IALog {
    fun v(tag: String,message: String)
    ...
}

expect class ALogImpl(): IALog

在androidMain实现ALogImpl

import android.util.Log
actual class ALogImpl actual constructor() : IALog {
    override fun v(tag: String,message: String) {
        Log.v(tag,message)
    }
    ...
}

在iosMain实现ALogImpl

import platform.Foundation.NSLog
internal actual class ALogImpl actual constructor(): IALog {
    override fun v(tag: String,message: String) {
        NSLog("[$tag] $message")
    }
    ...
}

到此,我们已经使用KMM实现了一个alog日志SDK。

四、依赖现有的Android/iOS SDK开发KMM SDK

alog的实现过于简单,使用了android.util.Log、platform.Foundation.NSLog。如果使用现有的Android/iOS SDK,如何实现呢?比如Android使用mars-xlog、iOS使用CocoaLumberjack

Android的实现没什么变化,依赖mars-xlog即可

implementation("com.tencent.mars:mars-xlog:1.2.6")

import com.tencent.mars.xlog.Log
actual class ALogImpl actual constructor() : IALog {
    override fun v(tag: String,message)
    }
    ...
}

在ios实现依赖CocoaLumberjack,需要用到native.cocoapods插件

plugins {
    kotlin("multiplatform")
    kotlin("native.cocoapods")
    id("com.android.library")
}

cocoapods {
    ...
    frameworkName = "alog"
    pod("CocoaLumberjack")
}

通过cinterop一些gradle Task会自动生成文件给iosMain使用,比如生成alog-cinterop-CocoaLumberjack.klib包含1_CocoaLumberjack.knm。

import cocoapods.CocoaLumberjack.*
internal actual class ALogImpl actual constructor(): IALog {
    private val dLog = DDLog
    override fun v(tag: String,message: String) {
        dLog.log(asynchronousLog,toMessage(tag,"[$tag] $message",DDLogLevelVerbose,DDLogFlagVerbose))
    }

    private fun toMessage(tag: String,message: String,level: DDLogLevel,flag: DDLogFlag): DDLogMessage {
        return DDLogMessage(message,level,flag,"",null,tag,null)
    }
    ...
}

为了方便Android/iOS App使用,添加一个ALog.kt类

/**
 * Android App使用 ALog.i(tag,message)
 */
val ALog: IALog by lazy { ALogImpl() }

/**
 * iOS App使用ALogKt.i(tag,message)
 */
fun d(tag: String,message: String) = ALog.d(tag,message)

到此,alog就完成了依赖现有的Android/iOS SDK(mars-xlog、CocoaLumberjack)开发alog KMM SDK。

五、声明Android/iOS公共接口以及独有接口

用expect修饰commonMain中声明公共的接口

expect interface IALog {
    fun v(tag: String,message: String)
    ...
}

在iosMain中用actual修饰来实现真正的接口

actual interface IALog {
    actual fun v(tag: String,message: String)
    ...
}

在androidMain中用actual修饰来实现真正的接口,带actual修饰的方法为Android/iOS公共方法,不带actual修饰的方法为Android独有(Android有这个接口iOS没有这个接口)

actual interface IALog {
    actual fun v(tag: String,message: String)
    ...

    fun v(tag: String,format: String,vararg args: Any?)
}

这样Android就可以使用fun v(tag: String,vararg args: Any?)函数,而iOS没有这个函数。好处是通常一些SDK在commonMain中会定义一套公共接口,有时候Android或iOS有一些独有接口,就可以用这种方式声明。同理data class也是可以这样使用。

六、为iOS统一构建成一个framework

为了避免Kotlin/Native构建framework时包过大,统一构建一个framework,下面把包名称为sdkframework。这里提一下几个值得注意的问题。有2种方式构建:1、本地构建,写一个sdkframework项目依赖其他模块的klib包,来构建sdkframework。2、构建系统上构建依赖其他模块的klib包构建,业务直接pod sdkframework即可。第1种方案比较灵活,版本号可以写脚本控制,但是要求开发人员使用的电脑都要配置KMM开发环境。第2种方案业务接入更加简单,跟iOS原生开发的SDK一样,无需KMM环境,主要问题是各个业务依赖klib的版本不一致,导致构建sdkframework多个版本,这时需要用不同分支构建不同业务的sdkframework,版本号加后缀来区别 1.0.0-love、1.0.0-like。

6.1 sdkframework模块的iosMain需要有一个kotlin文件

如果iosMain没有kotlin文件,将无法生成 iOS framework,为其添加一个文件即可,如SDKTest.kt

// 加个类,避免Framework没生成
class SDKTest {
    fun test() {

    }
}

6.2 生成文件sdkframework.h时,把注释也带上

生成文件sdkframework.h时,如果需要把注释也带上,那需要在gradle中添加Task

targets.withType<org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget> {
    compilations.get("main").kotlinOptions.freeCompilerArgs += "-Xexport-kdoc"
}

6.3 依赖的模块需要使用export来导出到sdkframework.h头文件

sdkframework依赖了utils、alog、PlatformMMKV、business,需要添加export,把这几个模块的类和方法导出到sdkframework.h头文件中,这样iosApp才可以使用这几个模块的类和方法

val iosX64 = iosX64()
val iosArm64 = iosArm64()
targets {
    configure(listOf(iosX64,iosArm64)) {
        binaries.withType(org.jetbrains.kotlin.gradle.plugin.mpp.Framework::class.java) {
            export(project(":utils"))
            export(project(":alog"))
            export(project(":PlatformMMKV"))
            export(project(":business"))
        }
    }
}

6.4 sdkframework本地依赖的模块使用了pod,sdkframework也要pod,以klib依赖可避免该问题

sdkframework依赖utils、alog、PlatformMMKV、business模块源码构建framework时,模块使用了pod的,那sdkframework也要pod。如PlatformMMKV pod("MMKV","1.2.8"),那sdkframework也要pod("MMKV","1.2.8")。那如何避免这个问题,可以先把utils、alog、PlatformMMKV、business模块在构建系统上构建成klib,sdkframework依赖各个模块的klib即可。

6.5 use_frameworks! 和 use_modular_headers!

上面说到的第1点本地构建,在iosApp本地依赖构建sdkframework时,要将依赖项正确导入 Kotlin/Native 模块,Podfile必须包含use_modular_headers! 或 use_frameworks! 指令,查看文档链接。当然,如果是第2点构建系统上构建则不需要使用这2个指令。

源码地址:https://github.com/libill/kmmApp

七、参考链接

1、本文地址:https://www.cnblogs.com/liqw/p/15416758.html

2、kmm-getting-started

3、Multiplatform programming

4、KMM 求生日记二:Kotlin/Native 被踩中的坑

5、KNDemo

总结

以上是编程之家为你收集整理的Kotlin/Native KMM项目架构全部内容,希望文章能够帮你解决Kotlin/Native KMM项目架构所遇到的程序开发问题。

如果觉得编程之家网站内容还不错,欢迎将编程之家网站推荐给程序员好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您喜欢寻找一群志同道合、互帮互助的学习伙伴,可以点击下方链接加入:
编程之家官方1群
编程之家官方2群
编程之家官方3群
编程之家官方4群

相关文章

猜你在找的Android相关文章

一、什么是KMM? Kotlin Multiplatform Mobile ( KMM ) 是一个 SDK,旨在简化跨平台移动应用程序的创建。在 KMM 的帮助下,您可以在 iOS 和 Android
什么是事件?事件是用户触摸手机屏幕,引起的一系列TouchEvent,包括ACTION_DOWN、ACTION_MOVE、ACTION_UP、ACTION_CANCEL等,这些action组合后变成点
经常我们会在资源文件(res/strings.xml)定义字符串,一维数组,那定义二维数组?直接定义二维数组没找到,可以间接定义。其实很简单,看过用过一次就可以记住了,一维数组估计大家经常用到,但是二
目前手机端和服务端数据交流格式一般是json,而谷歌提供了Gson来解析json。下载Gson:https://code.google.com/p/google-gson/下载的放在lib并导入,若出
一、用KMM写Flutter插件 Google官方有一个写Flutter例子How to write a Flutter plugin,这里把Google plugin_codelab 例子改成用KM
一、利用Android提供的左右移动工具类:AnimationUtils LinearLayout ll_first = (LinearLayout) findViewById(R.id.ll_fir
这里,通过一个小demo,就可以掌握在布局容器中动态添加控件,以动态添加Button控件为例,添加其他控件同样道理。1、addView添加控件到布局容器2、removeView在布局容器中删掉已有的控
在这里,总结一下loading进度条的使用简单总结一下。一、说起进度条,必须说说条形进度条,经常都会使用到嘛,特别是下载文件进度等等,还有像腾讯QQ安装进度条一样,有个进度总给人良好的用户体验。先来找
微信公众号搜索 “ 程序精选 ” ,选择关注!
微信公众号搜 "程序精选"关注