跳到主要内容

多语言框架

欢愉多语言是基于 Kotlin 开发的支持 Jetpack Compose 与常规方式的多语言框架， 其特点是基于 FVV 而不是传统的 xml 存放文本，并且实现了通过 Gradle 插件自动生成 Kotlin 文件， 可以通过配置来让指定语言的文本以 KDoc 形式为文本注释，通过 IDE 即可快速查看文本具体内容

并且 Jetpack Compose 方式实现了使用 Pangu Text 来达成优化中英文字符间距，常规方案请自行使用 Pangu Text

引入依赖​

JitPack 发布页面

先确保 repositories 内有 https://jitpack.io:

buildscript {
  repositories {
      maven { url "https://jitpack.io" }
  }
}
dependencyResolutionManagement {
  repositories {
      maven { url 'https://jitpack.io' }
  }
}

然后添加欢愉多语言的 Gradle 插件:

buildscript {
    dependencies {
        classpath("dev.oom-wg.PureJoy-MultiLang:plugin:-SNAPSHOT")
    }
}
备注

由于 JitPack 的发布限制，无法通过 id 直接引入 Gradle 插件

在项目中引入并配置内容:

plugins {
    id("dev.oom-wg.purejoy.mlang")
}

MLang {
    name = null // 可选字符串，用于防止包名冲突
    configDir = "dir" // 存放 FVV 文本的目录路径
    baseLang = "zh" // 默认语言，例如 en 、 en_US
    base = true // 常规方式
    compose = true // Jetpack Compose 方式
    // 常规方式 与 Jetpack Compose 方式 必须启用其中至少一种
}
注意

Gradle 插件仅支持在 com.android.application 与 com.android.library 中使用

由于 AGP 9 破坏性变动严重，暂不支持

使用方法​

编写多语言文件​

Gradle 插件会遍历传入的文件夹，以传入的文件夹的子文件夹作为语言标签，子文件夹内所有 FVV 文件作为语言数据

在目录下创建例如:

zh/lang.fvv:

Hello = "你好"
Home = {
    Welcome = "欢迎%s"
}

en/lang.fvv:

Hello = "Hello"

以上内容会自动生成如下 kotlin 代码 (如果启用了常规方式和 Jetpack Compose 方式):

object MLang {
    private val _Hello by lazy { MLangBase("你好", mapOf("en" to "Hello", "zh" to "你好")) }
    /** 你好
     * @suppress compose
     **/
    val Hello get() = "$_Hello"
    /** 你好
     * @suppress non-compose
     **/
    @Composable
    fun Hello(vararg args: Any?) = "${PanguText.format(_Hello.get().run { takeIf { args.isEmpty() } ?: format(*args) })}"
    object Home {
        private val _Welcome by lazy { MLangBase("欢迎%s", mapOf("zh" to "欢迎%s")) }
        /** 欢迎%s
         * @suppress compose
         * NA: en
         **/
        val Welcome get() = "$_Welcome"
        /** 欢迎%s
         * @suppress non-compose
         * NA: en
         **/
        @Composable
        fun Welcome(vararg args: Any?) = "${PanguText.format(_Welcome.get().run { takeIf { args.isEmpty() } ?: format(*args) })}"
    }
}

在代码中使用​

备注

由于要兼顾常规方式与 Jetpack Compose 方式两个场景， MLang 以 getter 调用为常规方式，函数调用 为 Jetpack Compose 方式， 这可能并不是一个太好的解决方案，请在使用时留意调用的到底是哪一个

如果要调用文本，只需要调用 MLang.Hello(常规方式) 或 MLang.Home.Welcome()(Jetpack Compose 方式) 即可

调用 Jetpack Compose 方式时，可以直接传入内容来实现格式化文本，并且输出后的文本默认经过 Pangu Text 处理

文本均使用 lazy 实现懒加载，仅在调用时初始化当前文本的多语言数据，无需显式调用初始化

为了确保性能，欢愉多语言会将当前系统语言列表缓存， 在使用 Jetpack Compose 方式时，缓存会自动刷新，但常规方式的缓存需要手动调用 MLangProvider.clearCache()

示例
import dev.oom_wg.purejoy.mlang.MLangProvider

class AppActivity : Activity() {
    override fun onConfigurationChanged(newConfig: Configuration) =
        super.onConfigurationChanged(newConfig).also { MLangProvider.clearCache() }
}