react-native-unimp

!NPM Downloads
!Node Current

> 集成uni小程序SDK，支持Android和iOS，目前只集成了基础模块，其他原生功能依赖库需要自行集成。

SDK 版本

- Android已更新至2025年11月11日发布的 SDK 4.85 版本
- ios版本为 SDK 4.75 版本

示例

完整示例可以查看 react-native-unimp-example

安装

``sh
npm install react-native-unimp
`

使用示例

`js
import * as Unimp from 'react-native-unimp';

// 初始化小程序
Unimp.initialize(
{ isEnableBackground: false, capsule: true },
{ backgroundColor: '#1991FB' }
)
.then(async () => {
const isInitialize = await Unimp.isInitialize();
if (isInitialize) {
console.log([小程序初始化]: 成功);
}
})
.catch((e) => console.log([小程序初始化]: 失败：${e.message}));
`

配置

$3

#### 1. 集成SDK文件

修改原生集成方式，已移除 android/libs 下的 aar 文件，按照 build.gradle 的引入格式，导入到 JFrog 或其他的 maven 仓库，并添加 maven 仓库地址到你项目的 android/build.gradle，示例如下：
`gradle
buildscript {
ext {
...
}
repositories {
google()
mavenCentral()
maven { url '这里添加本地的maven仓库地址' }
}
dependencies {
...
}
}

allprojects {
repositories {
google()
mavenCentral()
maven { url '这里添加本地的maven仓库地址' }
}
}
`

#### 2. 导入小程序应用资源

打开android原生项目。在主Module模块的`assets`路径下创建`apps/(内置uni小程序的appid)/www`路径，例如`apps/__UNI__04E3A11/www`，将之前导出的应用资源包解压释放到`apps/__UNI__04E3A11/www`路径下(解压方法将资源包的扩展`.wgt`重命名为`.zip`然后使用解压软件打开)

#### 3. 修改gradle配置

在`android/app/build.gradle`中，添加以下配置，否则可能会出现无法开启小程序，并提示 运行路径中无 uni 小程序(\_\_UNI\_\_XXXXXXXX)应用资源，请检查应用资源是否正常部署的问题：

`
android {
//此处配置必须添加 否则无法正确运行
aaptOptions {
additionalParameters '--auto-add-overlay'
//noCompress 'foo', 'bar'
ignoreAssetsPattern "!.svn:!.git:.:!CVS:!thumbs.db:!picasa.ini:!.scc:*~"
}
}
`

#### 4. 异常情况

如果出现打开小程序后界面空白，Logcat 显示以下日志，需要将 android/build.gradle 的targetSdkVersion 改为 28 即可。

`azure
2024-11-28 16:10:12.573 6748-7055 WXParams com.unimpexample E setCrashFilePath: /data/user/0/com.unimpexample/app_crash
2024-11-28 16:10:12.573 6748-7055 weex com.unimpexample E getUseSingleProcess is running false
2024-11-28 16:10:12.573 6748-7055 weex com.unimpexample E getReleaseMap:true
2024-11-28 16:10:12.573 6748-7055 weex com.unimpexample E getLibJsbPath is running /data/user/0/com.unimpexample/cache/cache/weex/libs/weexjsb/arm64-v8a/libweexjsb.so
2024-11-28 16:10:12.573 6748-7055 weex com.unimpexample E getLibLdPath is running /data/app/com.unimpexample-_xag59cq6fFJxVJuCI463A==/lib/arm64:/data/app/com.unimpexample-_xag59cq6fFJxVJuCI463A==/base.apk!/lib/arm64-v8a
`

检查 minSdkVersion 取值范围 19~22 注意 >=23 一定要在原生项目主app的AndroidManifest.xml 中的 application 节点配置 android:extractNativeLibs="true"

$3

#### 1. 安装Git LFS

部分依赖库文件较大，需要安装`git-lfs`插件下载大文件，终端执行git lfs version查看本地是否已安装该插件，如未安装参考安装Git LFS

#### 2. 初始化 sdk engine

> 低于 React Native 0.77.0 版本

在 AppDelegate.m 中：

`c++
#import "DCUniMP.h"

...

- (BOOL)application:(UIApplication )application didFinishLaunchingWithOptions:(NSDictionary )launchOptions {
// Override point for customization after application launch.

// 配置参数
NSMutableDictionary *options = [NSMutableDictionary dictionaryWithDictionary:launchOptions];
// 设置 debug YES 会在控制台输出 js log，默认不输出 log，注：需要引入 liblibLog.a 库
[options setObject:[NSNumber numberWithBool:YES] forKey:@"debug"];
// 初始化引擎
[DCUniMPSDKEngine initSDKEnvironmentWithLaunchOptions:options];

return YES;
}

...

#pragma mark - App 生命周期方法
- (void)applicationDidBecomeActive:(UIApplication *)application {
[DCUniMPSDKEngine applicationDidBecomeActive:application];
}

- (void)applicationWillResignActive:(UIApplication *)application {
[DCUniMPSDKEngine applicationWillResignActive:application];
}

- (void)applicationDidEnterBackground:(UIApplication *)application {
[DCUniMPSDKEngine applicationDidEnterBackground:application];
}

- (void)applicationWillEnterForeground:(UIApplication *)application {
[DCUniMPSDKEngine applicationWillEnterForeground:application];
}

- (void)applicationWillTerminate:(UIApplication *)application {
[DCUniMPSDKEngine destory];
}

...

#pragma mark - 如果需要使用 URL Scheme 或 通用链接相关功能，请实现以下方法
- (BOOL)application:(UIApplication )app openURL:(NSURL )url options:(NSDictionary *)options {
// 通过 url scheme 唤起 App
[DCUniMPSDKEngine application:app openURL:url options:options];
return YES;
}

- (BOOL)application:(UIApplication )application continueUserActivity:(NSUserActivity )userActivity restorationHandler:(void (^)(NSArray> * _Nullable))restorationHandler {
// 通过通用链接唤起 App
[DCUniMPSDKEngine application:application continueUserActivity:userActivity];
return YES;
}

`

> 高于 React Native 0.77.0 版本

首先在 *-Brdging-Header.h 文件中导入 DCUniMP 模块

`c++
//
// Use this file to import your target's public headers that you would like to expose to Swift.
//
#define uabp_Bridging_Header_h

#import "DCUniMP.h"
`

在 AppDelegate.swift 中

`swift
import UIKit
import React
import React_RCTAppDelegate
import ReactAppDependencyProvider

@main
// 2. 阿里云推送 AppDelegate 遵循 UNUserNotificationCenterDelegate 协议
class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate {
var window: UIWindow?

var reactNativeDelegate: ReactNativeDelegate?
var reactNativeFactory: RCTReactNativeFactory?

func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
) -> Bool {
let delegate = ReactNativeDelegate()
let factory = RCTReactNativeFactory(delegate: delegate)
delegate.dependencyProvider = RCTAppDependencyProvider()

reactNativeDelegate = delegate
reactNativeFactory = factory

// 3. 设置通知代理 (必须在应用启动时设置)
UNUserNotificationCenter.current().delegate = self

window = UIWindow(frame: UIScreen.main.bounds)

factory.startReactNative(
withModuleName: "uabp",
in: window,
launchOptions: launchOptions
)

// 1. 创建一个可变字典，用于配置 SDK 启动参数
// 这里的 options 类型需要是 [AnyHashable: Any] 来兼容 Objective-C 的 SDK
var options: [AnyHashable: Any] = launchOptions ?? [:]

// 2. 设置 debug 参数为 YES，会在控制台输出 JS log
// 注意：需要引入 liblibLog.a 库才能看到 JS log
// 我们使用 NSNumber(value: true) 来确保正确桥接到 Objective-C 的 BOOL/NSNumber 类型
options["debug"] = NSNumber(value: true)

// 3. 初始化引擎
DCUniMPSDKEngine.initSDKEnvironment(launchOptions: options)

return true
}

// MARK: - App Lifecycle Methods (DCUniMPSDK)

/// Called when the application is about to become the active state.
func applicationDidBecomeActive(_ application: UIApplication) {
// Call the DCUniMPSDK method corresponding to app activation
DCUniMPSDKEngine.applicationDidBecomeActive(application)
}

/// Called when the application is about to move from active to inactive state.
func applicationWillResignActive(_ application: UIApplication) {
// Call the DCUniMPSDK method corresponding to app resigning active state
DCUniMPSDKEngine.applicationWillResignActive(application)
}

/// Called when the application is entering the background state.
func applicationDidEnterBackground(_ application: UIApplication) {
// Call the DCUniMPSDK method corresponding to entering background
DCUniMPSDKEngine.applicationDidEnterBackground(application)
}

/// Called when the application is about to enter the foreground from the background state.
func applicationWillEnterForeground(_ application: UIApplication) {
// Call the DCUniMPSDK method corresponding to entering foreground
DCUniMPSDKEngine.applicationWillEnterForeground(application)
}

/// Called when the application is about to terminate.
func applicationWillTerminate(_ application: UIApplication) {
// Call the SDK's destory method to clean up resources before termination.
DCUniMPSDKEngine.destory()
}
}

class ReactNativeDelegate: RCTDefaultReactNativeFactoryDelegate {
override func sourceURL(for bridge: RCTBridge) -> URL? {
self.bundleURL()
}

override func bundleURL() -> URL? {
#if DEBUG
RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index")
#else
Bundle.main.url(forResource: "main", withExtension: "jsbundle")
#endif
}
}

`

#### 3. 导入小程序应用资源

打开原生工程目录，在iOS项目路径中创建名称为Apps的文件夹，将之前导出的wgt包拷贝到Apps文件夹中，再右键菜单中选择Add Files to “工程名...”，然后打开工程目录，选择 Apps 文件夹，然后点击“Add”，将应用资源包添加到工程中。

> iOS已改用Pod方式集成，以下配置可以跳过

#### ~~4. 配置CocoaPods~~

~~打开podfile文件，添加以下内容：~~

`


target 'XXX' do

pod 'SSZipArchive'

#

...

end

``

~~在工程的Build Settings -> Preprocessor Macros -> Debug和Release中分别添加HAVE_INTTYPES_H，HAVE_PKCRYPT，HAVE_STDINT_H，HAVE_WZAES，HAVE_ZLIB 这 5 个宏定义（注意：原有的配置项下不要删除，点击+号添加））~~

支持的接口

| 序号 | 接口名称 | 参数 | 支持平台 | 描述 |
|----| ------------------- |------------------------------------------------------------------| ------------- |-------------------------------------------|
| 1 | initialize | params: InitializeProps, capsuleBtnStyle?: ICapsuleBtnStyleProps | Android / iOS | 小程序初始化方法，支持初始化胶囊按钮样式和菜单 |
| 2 | isInitialize | / | Android | 检测小程序引擎是否已经初始化 |
| 3 | getAppBasePath | appid?: string | Android / iOS | 获取小程序运行路径 |
| 4 | releaseWgtToRunPath | appid: string, wgtPath?: string, password?: string | Android / iOS | 将wgt包中的资源文件释放到uni小程序运行时路径下 |
| 5 | getWgtPath | appid: string | Android / iOS | 读取导入到工程中的wgt应用资源 |
| 6 | isExistsApp | appid: string | Android / iOS | 检查当前appid小程序是否已释放wgt资源，可用来检查当前appid资源是否存在 |
| 7 | openUniMP | appid: string, configuration?: IConfigurationProps | Android / iOS | 启动小程序 |
| 8 | getAppVersionInfo | appid: string | Android / iOS | 获取uni小程序版本信息 |
| 9 | closeUniMP | appid: string | Android / iOS | 宿主关闭小程序 |
| 10 | showOrHideUniMP | appid: string, show: boolean | Android / iOS | 当前小程序显示到前台/退到后台 |
| 11 | sendUniMPEvent | appid: string, eventName: string, data: Record | Android / iOS | 宿主主动触发事件到正在运行的小程序 |
| 12 | getCurrentPageUrl | appid: string | Android / iOS | 获取运行时uni小程序的当前页面url 可用于页面直达等操作的地址 |