配置 | uni-app x

展示全部

# 配置

根据编译出来的unpackage/resource/app-android/{appid}/www/manifest.json中app->distribute->modules节点的模块配置，在下方的API与对应的库参照表中找到对应模块，完成以下配置。

注意：配置本地依赖库和配置线上依赖库都需要配置。

# 配置本地依赖库

将参照表中本地依赖库对应的aar拷贝到app模块的libs目录下。

# 配置线上依赖库

将参照表中的线上依赖库添加到app模块的build.gradle中。以uni-network为例，参考：

build.gradle

build.gradle.kts

	dependencies {
		implementation 'com.squareup.okhttp3:okhttp:3.12.12'
	}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
		implementation 'com.squareup.okhttp3:okhttp:3.12.12'
	}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
		implementation("com.squareup.okhttp3:okhttp:3.12.12")
	}

# 插件注册

将参照表中的插件注册内容拷贝到build.gradle的defaultConfig节点下。以uni-previewImage为例，参考：

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPreviewImage.UniPreviewImageExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPreviewImage.UniPreviewImageExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPreviewImage.UniPreviewImageExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

注意

如果多个模块需要配置同名的buildConfigField，不能分别声明（后声明的会覆盖先声明的），需要将这些配置的JSON合并到同一个数组中。以uni-picker为例，参考：

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiComponentsRegister\",\"method\":\"register\"},{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiComponentsRegister\",\"method\":\"register\"},{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"},{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# API与对应的库参照表

# uni-createRequestPermissionListener

属性	内容
本地依赖库	uni-createRequestPermissionListener-release.aar

# uni-createWebviewContext

属性	内容
本地依赖库	uni-createWebviewContext-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.webkit:webkit:1.6.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.webkit:webkit:1.6.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.webkit:webkit:1.6.0")
}

# uni-fileSystemManager

属性	内容
本地依赖库	uni-fileSystemManager-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'org.brotli:dec:0.1.2'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'org.brotli:dec:0.1.2'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("org.brotli:dec:0.1.2")
}

# uni-getNetworkType

属性	内容
本地依赖库	uni-getNetworkType-release.aar

# uni-installApk

属性	内容
本地依赖库	uni-installApk-release.aar

# uni-network

属性	内容
本地依赖库	uni-network-release.aar

enableQuic 配置

当使用 uni.request 的 enableQuic 属性开启 Quic/h3 协议时，需要根据发布渠道额外引入对应的 cronet 库（拷贝到 app 模块的 libs 目录下）：

发布渠道	本地依赖库
谷歌渠道（GMS）	uni-network-cronet-gms-release.aar
非谷歌渠道	uni-network-cronet-release.aar

注意

谷歌渠道与非谷歌渠道的 cronet 库不能同时引入。

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:3.12.12'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:3.12.12'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.squareup.okhttp3:okhttp:3.12.12")
}

# uni-websocket

属性	内容
本地依赖库	uni-websocket-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:3.12.12'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:3.12.12'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.squareup.okhttp3:okhttp:3.12.12")
}

# uni-cloud-client

注意

该模块仅支持 VDOM模式，蒸汽模式（Vapor）已移除，无需配置。

属性	内容
本地依赖库	uni-cloud-client-release.aar
依赖的模块	uni-network uni-storage uni-prompt uni-media uni-websocket uni-secure-network uni-modal uni-showLoading

# uni-media

属性	内容
本地依赖库	uni-media-release.aar nativeobj-preview-release.aar
依赖的模块	uni-prompt uni-actionSheet

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    implementation 'androidx.recyclerview:recyclerview:1.0.0'
    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'androidx.activity:activity-ktx:1.9.2'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    implementation 'androidx.recyclerview:recyclerview:1.0.0'
    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'androidx.activity:activity-ktx:1.9.2'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.github.bumptech.glide:glide:4.9.0")
    implementation("androidx.recyclerview:recyclerview:1.0.0")
    implementation("androidx.appcompat:appcompat:1.6.1")
    implementation("androidx.activity:activity-ktx:1.9.2")
}

# uni-privacy

属性	内容
本地依赖库	uni-privacy-release.aar

# uni-getProvider

属性	内容
本地依赖库	uni-getProvider-release.aar

# uni-shareWithSystem

属性	内容
本地依赖库	uni-shareWithSystem-release.aar

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String[]', 'UTSHooksClassArray', '{"uts.sdk.modules.uniShareWithSystem.ShareWithSystemHook"}'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String[]', 'UTSHooksClassArray', '{"uts.sdk.modules.uniShareWithSystem.ShareWithSystemHook"}'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String[]", "UTSHooksClassArray", "{\"uts.sdk.modules.uniShareWithSystem.ShareWithSystemHook\"}")
}

# uni-createInnerAudioContext

属性	内容
本地依赖库	uni-createInnerAudioContext-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.google.android.exoplayer:exoplayer-core:2.18.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.google.android.exoplayer:exoplayer-core:2.18.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.google.android.exoplayer:exoplayer-core:2.18.0")
}

# uni-getBackgroundAudioManager

属性	内容
本地依赖库	uni-getBackgroundAudioManager-release.aar
依赖的模块	uni-network

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.google.android.exoplayer:exoplayer-core:2.18.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.google.android.exoplayer:exoplayer-core:2.18.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.google.android.exoplayer:exoplayer-core:2.18.0")
}

# uni-chooseLocation

属性	内容
本地依赖库	uni-chooseLocation-release.aar
依赖的模块	uni-theme uni-getLocation uni-cloud-client uni-getLocation uni-map-tencent

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniChooseLocation.UniChooseLocationExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniChooseLocation.UniChooseLocationExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniChooseLocation.UniChooseLocationExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-actionSheet

属性	内容
本地依赖库	uni-actionSheet-release.aar

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniActionSheet.UniActionSheetExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniActionSheet.UniActionSheetExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniActionSheet.UniActionSheetExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-previewImage

属性	内容
本地依赖库	uni-previewImage-release.aar
依赖的模块	uni-media uni-network uni-fileSystemManager uni-storage uni-prompt uni-modal uni-actionSheet

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPreviewImage.UniPreviewImageExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPreviewImage.UniPreviewImageExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPreviewImage.UniPreviewImageExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-chooseMedia

属性	内容
本地依赖库	uni-chooseMedia-release.aar
依赖的模块	uni-modal uni-actionSheet

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'androidx.activity:activity-ktx:1.9.2'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'androidx.activity:activity-ktx:1.9.2'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.appcompat:appcompat:1.6.1")
    implementation("androidx.activity:activity-ktx:1.9.2")
}

# uni-arrayBufferToBase64

属性	内容
本地依赖库	uni-arrayBufferToBase64-release.aar

# uni-base64ToArrayBuffer

属性	内容
本地依赖库	uni-base64ToArrayBuffer-release.aar

# uni-sse

属性	内容
本地依赖库	uni-sse-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.squareup.okhttp3:okhttp-sse:3.12.12'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.squareup.okhttp3:okhttp-sse:3.12.12'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.squareup.okhttp3:okhttp-sse:3.12.12")
}

属性	内容
本地依赖库	uni-modal-release.aar

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniModal.UniModalExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniModal.UniModalExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniModal.UniModalExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-camera

属性	内容
本地依赖库	uni-camera-release.aar
依赖的模块	uni-media

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.camera:camera-core:1.4.1'
    implementation 'androidx.camera:camera-camera2:1.4.1'
    implementation 'androidx.camera:camera-lifecycle:1.4.1'
    implementation 'androidx.camera:camera-view:1.4.1'
    implementation 'androidx.appcompat:appcompat:1.7.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.camera:camera-core:1.4.1'
    implementation 'androidx.camera:camera-camera2:1.4.1'
    implementation 'androidx.camera:camera-lifecycle:1.4.1'
    implementation 'androidx.camera:camera-view:1.4.1'
    implementation 'androidx.appcompat:appcompat:1.7.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.camera:camera-core:1.4.1")
    implementation("androidx.camera:camera-camera2:1.4.1")
    implementation("androidx.camera:camera-lifecycle:1.4.1")
    implementation("androidx.camera:camera-view:1.4.1")
    implementation("androidx.appcompat:appcompat:1.7.0")
}

插件注册

build.gradle（VDOM模式）

build.gradle.kts（VDOM模式）

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniCamera.UniCameraExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniCamera.UniCameraExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniCamera.UniCameraExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-requestMerchantTransfer

属性	内容
本地依赖库	uni-requestMerchantTransfer-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.tencent.mm.opensdk:wechat-sdk-android:6.8.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.tencent.mm.opensdk:wechat-sdk-android:6.8.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.tencent.mm.opensdk:wechat-sdk-android:6.8.0")
}

# uni-recorder

属性	内容
本地依赖库	uni-recorder-release.aar audio-mp3aac-release.aar

# uni-makePhoneCall

属性	内容
本地依赖库	uni-makePhoneCall-release.aar

# uni-clipboard

属性	内容
本地依赖库	uni-clipboard-release.aar

# uni-keyboard

属性	内容
本地依赖库	uni-keyboard-release.aar

# uni-openDocument

属性	内容
本地依赖库	uni-openDocument-release.aar
依赖的模块	uni-fileSystemManager

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String[]', 'UTSHooksClassArray', '{"uts.sdk.modules.DCloudUniOpenDocument.UniOpenDocumentHookProxy"}'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String[]', 'UTSHooksClassArray', '{"uts.sdk.modules.DCloudUniOpenDocument.UniOpenDocumentHookProxy"}'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String[]", "UTSHooksClassArray", "{\"uts.sdk.modules.DCloudUniOpenDocument.UniOpenDocumentHookProxy\"}")
}

# uni-barcode-scanning

属性	内容
本地依赖库	uni-barcode-scanning-release.aar
依赖的模块	uni-camera uni-getSystemInfo

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.camera:camera-core:1.4.1'
    implementation 'com.google.mlkit:barcode-scanning:17.2.0'
    implementation 'com.github.albfernandez:juniversalchardet:2.0.4'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.camera:camera-core:1.4.1'
    implementation 'com.google.mlkit:barcode-scanning:17.2.0'
    implementation 'com.github.albfernandez:juniversalchardet:2.0.4'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.camera:camera-core:1.4.1")
    implementation("com.google.mlkit:barcode-scanning:17.2.0")
    implementation("com.github.albfernandez:juniversalchardet:2.0.4")
}

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String[]', 'UTSHooksClassArray', '{"uts.sdk.modules.DCloudUniBarcodeScanning.AppHookProxy"}'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String[]', 'UTSHooksClassArray', '{"uts.sdk.modules.DCloudUniBarcodeScanning.AppHookProxy"}'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String[]", "UTSHooksClassArray", "{\"uts.sdk.modules.DCloudUniBarcodeScanning.AppHookProxy\"}")
}

# uni-match-media

注意

该模块仅支持 VDOM模式，蒸汽模式（Vapor）已移除，无需配置。

属性	内容
本地依赖库	uni-match-media-release.aar
依赖的模块	uni-getDeviceInfo

插件注册

HBuilderX 5.0及之后版本配置：

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"type\":\"customElement\",\"name\":\"match-media\",\"class\":\"uts.sdk.modules.DCloudUniMatchMedia.UniMatchMediaElementRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"type\":\"customElement\",\"name\":\"match-media\",\"class\":\"uts.sdk.modules.DCloudUniMatchMedia.UniMatchMediaElementRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"type\\\":\\\"customElement\\\",\\\"name\\\":\\\"match-media\\\",\\\"class\\\":\\\"uts.sdk.modules.DCloudUniMatchMedia.UniMatchMediaElementRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-scanCode

属性	内容
本地依赖库	uni-scanCode-release.aar
依赖的模块	uni-camera uni-barcode-scanning uni-media uni-getSystemInfo

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.camera:camera-core:1.4.1'
    implementation 'androidx.appcompat:appcompat:1.7.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.camera:camera-core:1.4.1'
    implementation 'androidx.appcompat:appcompat:1.7.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.camera:camera-core:1.4.1")
    implementation("androidx.appcompat:appcompat:1.7.0")
}

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniScanCode.UniScanCodeExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniScanCode.UniScanCodeExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniScanCode.UniScanCodeExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-rich-text

属性	内容
本地依赖库（蒸汽模式）	richtext-release.aar
本地依赖库（VDOM模式）	uni-rich-text-release.aar
依赖的模块	uni-arrayBufferToBase64 uni-web-view

插件注册（VDOM模式）

HBuilderX 5.0之前版本配置：

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"type\":\"customElement\",\"name\":\"rich-text\",\"class\":\"uts.sdk.modules.DCloudUniRichText.UniRichTextElementRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"type\":\"customElement\",\"name\":\"rich-text\",\"class\":\"uts.sdk.modules.DCloudUniRichText.UniRichTextElementRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"type\\\":\\\"customElement\\\",\\\"name\\\":\\\"rich-text\\\",\\\"class\\\":\\\"uts.sdk.modules.DCloudUniRichText.UniRichTextElementRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

HBuilderX 5.0及之后版本配置：

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniRichText.UniRichTextExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniRichText.UniRichTextExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniRichText.UniRichTextExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

蒸汽模式（Vapor）说明

蒸汽模式（Vapor）下对应模块为 uni-rich-text-native，本地依赖库为 richtext-release.aar，无需插件注册。支持的 ABI 架构：armeabi-v7a、arm64-v8a、x86、x86_64。

# uni-live-player

属性	内容
本地依赖库	uni-live-player-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.qiniu:qplayer2-core:1.5.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.qiniu:qplayer2-core:1.5.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.qiniu:qplayer2-core:1.5.0")
}

插件注册

build.gradle（VDOM模式）

build.gradle.kts（VDOM模式）

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniLivePlayer.UniLivePlayerExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniLivePlayer.UniLivePlayerExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniLivePlayer.UniLivePlayerExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-live-pusher

属性	内容
本地依赖库	uni-live-pusher-release.aar pldroid-media-streaming-3.1.6.jar
依赖的模块	uni-fileSystemManager uni-network

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.core:core:1.10.1'
    implementation 'android.arch.lifecycle:extensions:1.1.1'
    implementation 'com.qiniu:happy-dns:1.0.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.core:core:1.10.1'
    implementation 'android.arch.lifecycle:extensions:1.1.1'
    implementation 'com.qiniu:happy-dns:1.0.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.core:core:1.10.1")
    implementation("android.arch.lifecycle:extensions:1.1.1")
    implementation("com.qiniu:happy-dns:1.0.0")
}

插件注册

build.gradle（VDOM模式）

build.gradle.kts（VDOM模式）

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniLivePusher.UniLivePusherExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniLivePusher.UniLivePusherExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniLivePusher.UniLivePusherExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-loading

属性	内容
本地依赖库	uni-loading-release.aar

插件注册

build.gradle（VDOM模式）

build.gradle.kts（VDOM模式）

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniLoading.UniLoadingExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniLoading.UniLoadingExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniLoading.UniLoadingExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-showLoading

属性	内容
本地依赖库	uni-showLoading-release.aar
依赖的模块	uni-theme uni-getSystemInfo uni-loading

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniShowLoading.UniShowLoadingExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniShowLoading.UniShowLoadingExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniShowLoading.UniShowLoadingExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-web-view

属性	内容
本地依赖库	uni-web-view-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'androidx.webkit:webkit:1.6.0'
    implementation 'androidx.appcompat:appcompat:1.1.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'androidx.webkit:webkit:1.6.0'
    implementation 'androidx.appcompat:appcompat:1.1.0'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("androidx.webkit:webkit:1.6.0")
    implementation("androidx.appcompat:appcompat:1.1.0")
}

插件注册

build.gradle（VDOM模式）

build.gradle.kts（VDOM模式）

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniWebView.UniWebViewExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniWebView.UniWebViewExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniWebView.UniWebViewExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-page-container(hx5.15起不需要配)

属性	内容
本地依赖库	uni-page-container-release.aar

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPageContainer.UniPageContainerExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPageContainer.UniPageContainerExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPageContainer.UniPageContainerExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-accelerometer

属性	内容
本地依赖库	uni-accelerometer-release.aar

# uni-authentication

属性	内容
本地依赖库	uni-authentication-release.aar

# uni-calendar

属性	内容
本地依赖库	uni-calendar-release.aar

# uni-compass

属性	内容
本地依赖库	uni-compass-release.aar

# uni-editor

属性	内容
本地依赖库	uni-editor-release.aar
依赖的模块	uni-web-view

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniEditor.UniEditorExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniEditor.UniEditorExtApiComponentsRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniEditor.UniEditorExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-gyroscope

属性	内容
本地依赖库	uni-gyroscope-release.aar

# uni-memory

属性	内容
本地依赖库	uni-memory-release.aar

# uni-phoneContact

属性	内容
本地依赖库	uni-phoneContact-release.aar
依赖的模块	uni-media uni-getAppBaseInfo uni-actionSheet

# uni-picker

注意

该模块仅支持 VDOM模式，蒸汽模式（Vapor）已移除，无需配置。

属性	内容
本地依赖库	uni-picker-release.aar
依赖的模块	uni-theme uni-getSystemInfo uni-getAppBaseInfo uni-getDeviceInfo

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiComponentsRegister\",\"method\":\"register\"},{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiComponentsRegister\",\"method\":\"register\"},{\"class\":\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"},{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniPicker.UniPickerExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# uni-screenBrightness

属性	内容
本地依赖库	uni-screenBrightness-release.aar

# uni-vibrate

属性	内容
本地依赖库	uni-vibrate-release.aar

# uni-openLocation

属性	内容
本地依赖库	uni-openLocation-release.aar
依赖的模块	uni-actionSheet uni-getAppBaseInfo uni-theme uni-prompt uni-getSystemInfo uni-map-tencent

插件注册

build.gradle

build.gradle.kts

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniOpenLocation.UniOpenLocationExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniOpenLocation.UniOpenLocationExtApiPagesRegister\",\"method\":\"register\"}]"'
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniOpenLocation.UniOpenLocationExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
}

# 仅蒸汽模式（Vapor）支持的模块

以下模块仅支持蒸汽模式（Vapor），VDOM模式不包含。

# uni-form

属性	内容
本地依赖库	uni-form-release.aar
依赖的模块	uni-theme uni-getSystemInfo uni-dialogPage uni-event

# uni-requestSystemPermission

属性	内容
本地依赖库	uni-requestSystemPermission-release.aar

配置线上依赖库

build.gradle

build.gradle.kts

dependencies {
    implementation 'com.github.getActivity:XXPermissions:18.63'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation 'com.github.getActivity:XXPermissions:18.63'
}

示例源码如下，请查看 pre > code 标签中的内容

dependencies {
    implementation("com.github.getActivity:XXPermissions:18.63")
}

各模块对应的API可参考文档App端支持的内置模块列表

# 其他模块

# canvas

本地依赖库

模式	名称
蒸汽模式（Vapor）	uni-canvas-dom2-release.aar uni-canvas-component-release.aar
VDOM模式	uni-canvas-release.aar uni-canvas-component-release.aar

组件注册

将以下内容添加到主模块的build.gradle，详见根据configjson配置应用。

build.gradle（VDOM模式）

build.gradle.kts（VDOM模式）

defaultConfig {
    buildConfigField "String", "UTSRegisterComponents", "\"[{\\\"name\\\":\\\"canvas\\\",\\\"class\\\":\\\"io.dcloud.canvas.CanvasComponent\\\",\\\"node\\\":\\\"io.dcloud.canvas.UniCanvasElementImpl\\\"}]\""
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField "String", "UTSRegisterComponents", "\"[{\\\"name\\\":\\\"canvas\\\",\\\"class\\\":\\\"io.dcloud.canvas.CanvasComponent\\\",\\\"node\\\":\\\"io.dcloud.canvas.UniCanvasElementImpl\\\"}]\""
}

示例源码如下，请查看 pre > code 标签中的内容

defaultConfig {
    buildConfigField("String", "UTSRegisterComponents", "\"[{\\\"name\\\":\\\"canvas\\\",\\\"class\\\":\\\"io.dcloud.canvas.CanvasComponent\\\",\\\"node\\\":\\\"io.dcloud.canvas.UniCanvasElementImpl\\\"}]\"")
}

uni-ad

uni-video

uni-push

uni-facialRecognitionVerify