快速开始

前置条件

您已经接入工程到 mPaaS。更多信息，请参见以下内容：

• 基于 mPaaS 框架接入
• 基于已有工程且使用 mPaaS 插件接入
• 基于已有工程且使用 CocoaPods 接入

添加 SDK

根据您采用的接入方式，请选择相应的添加方式。

• 使用 mPaaS Xcode Extension。
  此方式适用于采用了 基于 mPaaS 框架接入 或 基于已有工程且使用 mPaaS 插件接入 的接入方式。
  
  1. 点击 Xcode 菜单项 Editor > mPaaS > 编辑工程，打开编辑工程页面。
  2. 选择 小程序，保存后点击 开始编辑，即可完成添加。
     
• 使用 cocoapods-mPaaS 插件。
  此方式适用于采用了 基于已有工程且使用 CocoaPods 接入 的接入方式。
  
  1. 在 Podfile 文件中，使用 mPaaS_pod "mPaaS_TinyApp" 添加小程序组件依赖。
     
  2. 执行 pod install 即可完成接入。

如在接入小程序的过程中遇到问题，欢迎扫码入群讨论。

使用 SDK

本文将结合 小程序官方 Demo 来介绍小程序的使用。

小程序的整个使用过程主要分为以下三步：

1. 初始化配置
2. 发布小程序
3. 启动小程序

1. 初始化配置

在配置工程时，您需要：

• 初始化容器
• 配置小程序

如果您的 App 生命周期并没有交给 mPaaS 框架托管，您还需进行 非框架托管配置。

1.1 初始化容器

容器初始化操作包括启动容器、定制容器和更新离线包。

1.1.1 启动容器

为了使用 Nebula 容器，您需要在程序启动完成后调用 SDK 接口，对容器进行初始化。必须在 DTFrameworkInterface 的 - (void)application:(UIApplication *)application beforeDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions 中进行初始化。

  - (void)application:(UIApplication *)application beforeDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
  {
      // 初始化容器
      [MPNebulaAdapterInterface initNebula];
  }

若您需要使用 预置离线包、自定义 JSAPI 和 Plugin 等功能，请将上方代码中的 initNebula 替换为下方代码中的 initNebulaWith 接口，传入对应参数对容器进行初始化。

• presetApplistPath：自定义的预置离线包的包信息路径。
• appPackagePath：自定义的预置离线包的包路径。
• pluginsJsapisPath：自定义 JSAPI 和 Plugin 文件的存储路径。

- (void)application:(UIApplication *)application beforeDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // 初始化容器
    NSString *presetApplistPath = [[NSBundle mainBundle] pathForResource:[NSString stringWithFormat:@"MPCustomPresetApps.bundle/h5_json.json"] ofType:nil];
    NSString *appPackagePath = [[NSBundle mainBundle] pathForResource:[NSString stringWithFormat:@"MPCustomPresetApps.bundle"] ofType:nil];
    NSString *pluginsJsapisPath = [[NSBundle mainBundle] pathForResource:[NSString stringWithFormat:@"Poseidon-UserDefine-Extra-Config.plist"] ofType:nil];
    [MPNebulaAdapterInterface initNebulaWithCustomPresetApplistPath:presetApplistPath customPresetAppPackagePath:appPackagePath customPluginsJsapisPath:pluginsJsapisPath];
}

1.1.2 定制容器

如有需要，您可以通过设置 MPNebulaAdapterInterface 的属性值来定制容器配置。必须在 DTFrameworkInterface 的 - (void)application:(UIApplication *)application afterDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions 中设置，否则会被容器默认配置覆盖。

  - (void)application:(UIApplication *)application afterDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
  {
      // 定制容器
      [MPNebulaAdapterInterface shareInstance].nebulaVeiwControllerClass = [MPH5WebViewController class];
      [MPNebulaAdapterInterface shareInstance].nebulaNeedVerify = NO;
      [MPNebulaAdapterInterface shareInstance].nebulaUserAgent = @"mPaaS/Portal";
  }

属性含义如下：

1.1.3 更新离线包

启动完成后，全量请求所有离线包信息，检查服务端是否有更新包。为了不影响应用启动速度，建议在 (void)application:(UIApplication \*)application afterDidFinishLaunchingWithOptions:(NSDictionary \*)launchOptions 之后调用。

- (void)application:(UIApplication *)application afterDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // 定制容器
    [MPNebulaAdapterInterface shareInstance].nebulaVeiwControllerClass = [MPH5WebViewController class];
    [MPNebulaAdapterInterface shareInstance].nebulaNeedVerify = NO;
    [MPNebulaAdapterInterface shareInstance].nebulaUserAgent = @"mPaaS/Portal";
    [MPNebulaAdapterInterface shareInstance].nebulaCommonResourceAppList = @[@"77777777"];
    // 全量更新离线包
    [[MPNebulaAdapterInterface shareInstance] requestAllNebulaApps:^(NSDictionary *data, NSError *error) {
        NSLog(@"");
    }];
}

初始化完成后，效果如下：

1.2 配置小程序

1.2.1 配置权限

在 info.plist 中配置以下 App 权限：

• NSBluetoothAlwaysUsageDescription：蓝牙权限（iOS 13 中的新增权限）。
• NSCameraUsageDescription：相机权限。
• NSPhotoLibraryUsageDescription：相册权限。
• NSLocationWhenInUseUsageDescription：定位权限。

1.2.2 配置动态库

在当前工程 TARGETS 的 General > Embedded Binaries 中添加 FalconLooks 库。

1.3 非框架托管配置

若您 App 的生命周期并没有交给 mPaaS 框架托管，而是指定为您自己定义的 delegate，那么您还需额外配置进行非框架托管。

1.3.1 启动 mPaaS 框架

在当前应用的 didFinishLaunchingWithOptions 方法中调用 [[DTFrameworkInterface sharedInstance] manualInitMpaasFrameworkWithApplication:application launchOptions:launchOptions]; 来启动 mPaaS 框架。

1.3.2 创建应用启动器

创建 DTBootLoader 的子类，重写 createWindow 和 createNavigationController 方法，返回当前应用自己的 window 和 navigationControlle。

• 设置 window：当前应用的 keyWindow。
• 设置 navigationController：加载小程序所在的navigationController ，必须继承 DFNavigationController。
  • 若当前应用 keyWindow 的 rootviewcontroller 是一个 navigationController，设置为该类即可；
  • 若当前应用 keyWindow 的 rootviewcontroller 是一个 tabBarViewController，取加载小程序所在标签（tab）的 navigationController。

在 DTBootPhase 的category 中重写 setupNavigationController 方法，指定小程序加载的 navigationController。

1.3.3 指定应用启动器

在 DTFrameworkInterface 的 category 中重写方法，指定当前应用自己的 bootloader，并隐藏 mPaaS 框架默认的 window 和 launcher 应用。

2. 发布小程序

启动小程序之前，您需要先通过 mPaaS 控制台发布该小程序。

2.1 进入小程序后台

登录 mPaaS 控制台，进入目标应用后，从左侧导航栏进入 小程序 > 小程序发布 页面。

2.2 配置虚拟域名

如果您是第一次使用，请先在 小程序 > 小程序发布 > 配置管理 中配置虚拟域名。虚拟域名可以为任意域名，建议使用您的企业域名，如 test.com。

2.3 创建小程序

进入 mPaaS 控制台，完成以下步骤：

1. 点击左侧导航栏的 小程序 > 小程序发布。
2. 在打开的小程序包列表页，点击 新建。
3. 在 新建小程序 窗口，填写小程序的 ID 和小程序名称，点击 提交。其中，小程序 ID 为任意 16 位数字，例如 2018080616290001。
   
   

4. 在小程序 App 列表下，找到新增的小程序，点击 添加。
   

   
   

5. 在基本信息栏，完成以下配置：

   • 版本：填写小程序包的版本号，例如 1.0.0.0。

   • 客户端范围：选择小程序 App 对应的 iOS 客户端最低版本和最高版本。在这个范围内的客户端 App 可以启动对应的小程序，否则无法启动。这里最低版本可以填写 0.0.0，最高版本可以不填，代表客户端所有版本都可以启动这个小程序。
     注意：这里的版本号指当前客户端 App 的版本号，请参考工程 Info.plist 中的 Product Version 字段。
     

     
     

   • 图标：点击 选择文件 上传小程序包的图标。第一次创建小程序时必需上传图标。示例图标如下：
     
     

   • 文件：上传小程序包资源文件，文件格式为 .zip。我们为您准备了一个 mPaaS 示例小程序（点此下载），您可以直接上传。

     
     

6. 在配置信息栏，完成以下配置：

   • 主入口 URL：必填，小程序包的首页，例如 /index.html#page/tabBar/component/index。

   • 其他配置保持默认即可
     

     
     

7. 勾选 已确认以上信息准确，提交后不再修改。
8. 点击 提交。

2.4 发布小程序

进入 mPaaS 控制台，完成以下步骤：

1. 点击左侧导航栏的 小程序 > 小程序发布 > 小程序正式包管理。
2. 在打开的小程序包列表页中，选择您要发布的小程序包与版本，点击 创建发布。
   
3. 在创建发布任务栏，完成以下配置：
   • 发布类型：选择 正式 发布类型。
   • 发布描述：选填。
4. 点击 确定 完成发布创建。
   

3. 启动小程序

完成上述步骤之后，进入对应的页面时，调用框架提供的 startTinyAppWithId 接口方法加载小程序。

[MPNebulaAdapterInterface startTinyAppWithId:appId params:nil];

若打开小程序时需要传递参数，可以通过 param 参数进行设置。其中 param 包含 page 和 query 两个字段：

• page： 用来指定打开特定页面的路径。
• query：用来传入自定义的参数。多个键值对以 & 进行拼接。

NSDictionary *param = @{@"page":@"pages/card/index", @"query":@"own=1&sign=1&code=2452473"};
[MPNebulaAdapterInterface startTinyAppWithId:appId params:dic];