Skip to content

README.md

Latest commit

 

History

History
127 lines (94 loc) · 3.63 KB

README.md

File metadata and controls

127 lines (94 loc) · 3.63 KB
Raw

Dimina Android SDK

dimina

系统要求

  • Android SDK: 最低 API 26 (Android 8.0)
  • Java 17
  • Android Gradle Plugin 8.0+
  • 仅支持 ARM64 架构 (arm64-v8a)

快速接入

步骤 1: 添加 JitPack 仓库

在项目根目录的 settings.gradle 或 settings.gradle.kts 文件中添加：

dependencyResolutionManagement {
    repositories {
        // 其他仓库...
        maven { url = uri("https://jitpack.io") }
    }
}

步骤 2: 添加依赖

在应用模块的 build.gradle 或 build.gradle.kts 文件中添加：

Groovy DSL

dependencies {
    // Dimina 核心库
    implementation 'com.github.didi.dimina:dimina:latest.release'
}

Kotlin DSL

dependencies {
    // Dimina 核心库
    implementation("com.github.didi.dimina:dimina:latest.release")
}

步骤 3: 初始化 SDK

在应用的 Application 类中初始化 Dimina SDK：

import com.didi.dimina.Dimina

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        Dimina.init(this, Dimina.DiminaConfig.Builder()
            // 是否启用调试模式：影响日志显示，并允许 pageFrame 初始化 vConsole
            // 调试模式不检测 App 是否已更新，都会进入 JSSDK 和 JSApp 的更新检测逻辑
            .setDebugMode(true)
            .build()
        )
    }
}

调试模式与 vConsole

当 setDebugMode(true) 时，SDK 会在加载 pageFrame 时追加 ?vconsole=1。JSSDK 直接依赖 vConsole，并随 pageFrame 静态同步打包；只有检测到该启用标记时，pageFrame 才会在 render 初始化前同步初始化 vConsole。

步骤 4: 启动小程序

将编译好的小程序压缩包放入 app/src/main/assets/jsapp 文件夹，文件夹以小程序 ID 命名。仓库示例工程会在构建时从根目录 shared/jsapp 自动复制资源到该目录。每个小程序文件夹需包含以下内容：

  1. config.json - 小程序配置文件，包含以下字段：
{
  "appId": "wx92269e3b2f304afc", // 小程序唯一标识
  "name": "小程序名称",
  "path": "example/index", // 小程序入口路径
  "versionCode": 1, // 启动小程序时会根据版本号确认是否需要更新
  "versionName": "1.0.0"
}
  1. [appId].zip - 小程序代码包，文件名需与 appId 一致

目录结构示例：

assets/
  └── jsapp/
      ├── wx92269e3b2f304afc/
      │   ├── config.json
      │   └── wx92269e3b2f304afc.zip
      └── wxbaf4b47de04f1d8a/
          ├── config.json
          └── wxbaf4b47de04f1d8a.zip

内置包会在启动时按 versionCode 解压到应用沙盒目录后运行。动态下发、远程下载和 wx.getUpdateManager 的职责边界请参考小程序包更新说明。

启动小程序：

// 从 config.json 文件创建 MiniProgram 对象
val miniProgram = MiniProgram(
    appId = "wx92269e3b2f304afc",  // 小程序唯一标识
    name = "小程序名称",      // 小程序名称
    versionCode = 1,            // 版本号
    versionName = "1.0.0",      // 版本名称
    path = "example/index",      // 小程序入口路径
    // updateManifestUrl = "https://example.com/jsapp/wx92269e3b2f304afc.json" // 可选：远程更新 manifest
)

// 启动小程序
Dimina.getInstance().startMiniProgram(context, miniProgram)

模块说明

  • dimina: 核心库，包含小程序运行环境、UI 组件和生命周期管理
  • engine-qjs: QuickJS JavaScript 引擎，提供 JS 执行环境