Moko Resources 开源项目使用手册

Moko Resources 是一个专为 Kotlin 多平台开发设计的库及Gradle插件，它允许开发者在macOS、iOS、Android、JVM以及JS/Browser平台上访问资源，并支持系统默认的本地化功能。本指南旨在帮助您理解项目结构、启动和配置的关键要素。

1. 项目目录结构及介绍

Moko Resources 的仓库结构遵循Kotlin多平台项目的常规布局，结合自定义的逻辑和资源管理需求。下面是核心部分的概览：

• src: 包含不同平台的源代码。
  • commonMain: 存放跨平台共享的代码，包括对资源的访问逻辑。
  • androidMain, iosMain, jvmMain, jsMain, 等：特定平台的实现或额外配置。
• build.gradle.kts: 根构建脚本，配置了整个多平台项目的构建规则，包括依赖和插件应用。
• settings.gradle.kts: 项目的设置文件，如果存在多模块，这里会引入它们。
• resources-build-logic: 插件逻辑相关的代码，用于自动生成和管理资源。
• resources-generator: 负责资源处理的Gradle插件部分。
• samples: 示例应用，展示了如何在实际项目中集成和使用Moko Resources。
• docs: 可能包含一些内部或外部文档，虽然在引用链接中未明确提及。
• 其他如.gitignore, CONTRIBUTING.md, LICENSE.md, README.md等标准文件，分别控制Git忽略项、贡献指导、许可证信息以及项目概述。

2. 项目的启动文件介绍

对于Moko Resources这样的库项目，没有传统意义上的“启动文件”。它的“启动”更多指的是在您的多平台项目中集成并正确配置资源访问的过程。您需要在根目录下的build.gradle.kts文件中添加必要的插件应用和依赖：

// 引入资源生成插件
buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath("dev.icerock.moko:resources-generator:<latest_version>")
    }
}

allprojects {
    repositories {
        mavenCentral()
    }
}

// 应用多平台资源插件
project.build.gradle.apply(plugin = "dev.icerock.mobile.multiplatform-resources")

dependencies {
    // 添加资源库依赖
    commonMainApi("dev.icerock.moko:resources:<latest_version>")
    // 如果使用Compose Multiplatform，还需添加此依赖
    commonMainApi("dev.icerock.moko:resources-compose:<latest_version>")
}

记得替换 <latest_version> 为您查找到的最新版本号。

3. 项目的配置文件介绍

配置主要发生在以下两个层面：

(a) build.gradle.kts 文件中的配置

在应用Moko Resources插件后，您可以在multiplatformResources块内进行配置，例如指定资源包名、类名、可见性等：

multiplatformResources {
    resourcesPackage.set("org.example.library")
    resourcesClassName.set("SharedRes") // 可选，默认为MR
    resourcesVisibility.set(MRVisibility.Internal) // 可选，默认Public
    // ...其他可能的配置
}

(b) 定制资源路径与特定平台配置

对于希望自定义资源路径的情况，可以增加resourcesSourceSets选项来指定资源存放位置，并确保资源被正确编译和打包到目标平台。

通过以上步骤和配置，您的项目就能利用Moko Resources轻松管理和访问多平台上的资源了。请参照实际项目需求调整上述示例中的配置细节。