uni-app x 原生SDK Android版

准备

• HBuilder X （4.18版本及以上）
• android studio

---

说明：当前文档基于android studio 2023.2.1 Patch 2。gradle版本为8.4。gradle插件版本为8.2.2。kotlin插件版本为1.9.10。

---

新建uni-app x模块

点击File->New->New Module...

点击左侧Templates的Android Library。

Language选择Kotlin。

Module name建议设置为uniappx。

点击Finish。

注意

• Language 一定要选择Kotlin。
• uni-app x最低支持版本为21，Minimum SDK需要选择21及以上的版本。
• Build configuration language建议选择Groovy DSL(build.gradle)。以下教程均按照此模式进行。

工程配置

基础库配置

将uts-runtime-release.aar，android-gif-drawable-1.2.28.aar，app-common-release.aar，app-runtime-release.aar，breakpad-build-release.aar，dcloud-layout-release.aar， framework-release.aar，uni-exit-release.aar，uni-getAccessibilityInfo-release.aar，uni-getAppAuthorizeSetting-release.aar，uni-getAppBaseInfo-release.aar， uni-getSystemSetting-release.aar，uni-openAppAuthorizeSetting-release.aar，uni-prompt-release.aar，uni-storage-release.aar，uni-getDeviceInfo-release.aar， uni-getSystemInfo-release.aar，uni-rpx2px-release.aar，uni-theme-release.aar共19个aar拷贝到uni-app x模块的libs下，如果没有libs需要手动创建，参考下图：

修改build.gradle

修改uniappx模块下的build.gradle

• 添加依赖

  将下面的依赖信息添加到build.gradle中

  dependencies {
  	implementation fileTree(include: ['*.aar'], dir: './libs')
  	implementation "androidx.core:core-ktx:1.10.1"
  	implementation "androidx.recyclerview:recyclerview:1.3.2"
  	implementation "androidx.appcompat:appcompat:1.0.0"
  	implementation "androidx.exifinterface:exifinterface:1.3.6"
  	implementation "androidx.localbroadcastmanager:localbroadcastmanager:1.0.0@aar"
  	implementation "androidx.constraintlayout:constraintlayout:2.1.4"
  	implementation "androidx.webkit:webkit:1.6.0"
  	implementation "com.google.android.material:material:1.4.0"
  	implementation "androidx.viewpager2:viewpager2:1.1.0-beta02"
  	implementation "com.alibaba:fastjson:1.2.83"
  	implementation "com.facebook.fresco:fresco:3.1.3"
  	implementation "com.facebook.fresco:middleware:3.1.3"
  	implementation "com.facebook.fresco:animated-gif:3.1.3"
  	implementation "com.facebook.fresco:webpsupport:3.1.3"
  	implementation "com.facebook.fresco:animated-webp:3.1.3"
  	implementation "com.github.bumptech.glide:glide:4.9.0"
  	implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4"
  	implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4"
  	implementation "org.jetbrains.kotlin:kotlin-stdlib:1.8.10"
  	implementation "org.jetbrains.kotlin:kotlin-reflect:1.8.10"
  	implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1"
  	implementation "com.squareup.okhttp3:okhttp:3.12.12"
  	implementation "com.github.getActivity:XXPermissions:18.63"
  }
  

• 添加aaptOptions配置

  将aaptOptions配置添加到android节点下

  aaptOptions {
      additionalParameters '--auto-add-overlay'
      ignoreAssetsPattern '!.svn:!.git:.*:!CVS:!thumbs.db:!picasa.ini:!*.scc:*~'
  }
  

  注意：上面的配置需要同时设置到主模块中。

配置gradle插件

在项目根目录的build.gradle的顶部添加gradle插件的依赖。参考：

buildscript {
    dependencies {
		...
        classpath(files('plugins/uts-kotlin-compiler-plugin-0.0.1.jar'))
        classpath(files('plugins/uts-kotlin-gradle-plugin-0.0.1.jar'))
    }
}

注意：文件uts-kotlin-compiler-plugin-0.0.1.jar和uts-kotlin-gradle-plugin-0.0.1.jar位于原生SDK中，示例中放到了项目根目录的plugin文件夹下。参考：

然后在uniappx模块的build.gradle下添加插件io.dcloud.uts.kotlin的依赖。参考：

plugins {
	...
    id 'io.dcloud.uts.kotlin'
}

注意：io.dcloud.uts.kotlin仅需要配置到uniappx模块和android uts插件模块中。原有的主项目不需要配置。

修改项目的settings.gradle

在项目根路径下的settings.gradle中添加jitpack的maven的仓库地址和本地gradle插件的路径配置。参考如下：

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        ...
        maven { url = uri("https://jitpack.io") }
		flatDir { dirs('./plugins/') }
    }
}

修改项目的gradle.properties

在项目根路径下的gradle.properties中追加如下内容

android.useAndroidX=true
android.enableJetifier=true

修改uniappx模块下的AndroidManifest.xml

• 添加activity

  将下面内容拷贝到application节点下

      <activity
          android:name="io.dcloud.uniapp.UniAppActivity"
          android:configChanges="orientation|keyboard|keyboardHidden|smallestScreenSize|screenLayout|screenSize|mcc|mnc|fontScale|navigation|uiMode"
          android:exported="true"
          android:label="@string/app_name"
          android:screenOrientation="portrait"
          android:theme="@style/UniAppX.Activity.DefaultTheme"
          android:windowSoftInputMode="adjustResize"
          tools:replace="android:label,android:exported,android:theme,android:configChanges,android:windowSoftInputMode,android:screenOrientation">
      </activity>
  

• 添加appid

  在application节点下添加DCLOUD_UNI_APPID节点

  <meta-data
  	android:name="DCLOUD_UNI_APPID" android:value="替换成应用的appid" />
  

• 修改application

  将application节点的android:name修改为io.dcloud.uniapp.UniApplication

  注意：如果需要自定义application，必须继承自UniApplication

• 配置应用分发渠道

  在application节点下添加DCLOUD_CHANNEL节点

  <meta-data
  	android:name="DCLOUD_CHANNEL" android:value="替换成需要发布的应用分发渠道" />
  

  获取配置的应用分发渠道，可以通过uni.getAppBaseInfo()。

• 合并AndroidManifest.xml

  如果uni-app x项目根目录下有AndroidManifest.xml文件，你需要按照xml文件的结构将内容拷贝到uniappx模块的AndroidManifest.xml中。

拷贝资源文件

1. 导出uni-app x项目的资源文件

   选择项目，然后点击：发行 -> 原生App-本地打包 -> 生成本地打包App资源

   

   导出成功之后会在项目的unpackage/resources目录下生成资源文件

   

2. 将app-android目录下与appid对应的目录拷贝到主项目的assets/apps目录下

   

   注意：apps下的appid必须与AndroidManifest.xml的DCLOUD_UNI_APPID保持一致。

拷贝kt文件

需要将unkackage/resource/app-android/uniappx/app-android/src/目录下的所有文件拷贝到项目的src/main/java下

注意：不要破坏原有src下的目录结构。

添加到主模块

将uni-app x模块添加到主模块中。

	dependencies {
		implementation project(':uniappx')
		implementation fileTree(include: ['*.aar'], dir: '../uniappx/libs')
	}

配置内置模块

根据unpackage/resource/{appid}/manifest.json的配置，添加内置模块的配置。

uts插件配置

uts插件资源位于unpackage/resource/app-android/uni_modules下。如果uni_modules下存在uts插件，需要按照uts插件配置文档将插件集成到项目中。

以下模块可以忽略配置：

• uni-exit
• uni-getAccessibilityInfo
• uni-getAppAuthorizeSetting
• uni-getAppBaseInfo
• uni-getDeviceInfo
• uni-getSystemInfo
• uni-getSystemSetting
• uni-openAppAuthorizeSetting
• uni-prompt
• uni-storage
• uni-rpx2px
• uni-theme

启动

至此，uni-app x 导入原生项目的所有配置已经完成。uni-app x的启动、退出及运行期间通讯可以参考文档。