# 离线版(本地)小程序
本地小程序的大多数操作跟线上小程序的api都一样,只有个别api或事件不太一样。在这里重点做一下说明:
# 1 打开离线小程序
这个场景是App中有小程序包和基础库库,且没有部署后台服务时打开小程序。
本地小程序的zip包,是在IDE导出的离线包,解压后得到的。IDE导出的离线包解压后,内部有两个文件:miniprogram.zip和packageConfig.json,其中miniprogram.zip就是下面要传入的小程序本地zip包;packageConfig.json内的内容,就是下面要传入的packages。
/// 启动本地离线小程序
/// @param request 请求对象
/// @param parentVC 父页面
/// @param completion 完成回调
/// @param closeCompletion 关闭小程序时的回调
- (void)startLocalAppletWithRequest:(FATLocalAppletRequest *)request
inParentViewController:(UIViewController *)parentVC
completion:(void (^)(BOOL result, FATError *error))completion
closeCompletion:(dispatch_block_t)closeCompletion;
示例代码:
FATLocalAppletRequest *request = [[FATLocalAppletRequest alloc] init];
// 本地小程序服务标识,与初始化SDK时 本地服务器的apiServer保持一致
request.apiServer = @"localServer";
// 小程序的唯一标识
request.appletId = appletId;
// 小程序的名称
request.appName = appletTitle;
// 小程序的启动参数
request.startParams = startParams;
// 小程序的版本号
request.version = @"1.0.1";
//小程序的可访问域名列表
request.domainList = [self.domainList copy];
// 小程序的logo,图片对象,如果为nil,则会加载appletLogo
request.logoImage = [UIImage imageNamed:@"fav_fileicon_loc90"];
//request.appletLogo = @"http://inews.gtimg.com/newsapp_bt/0/13083551761/641.jpg";
NSString *appPath = [[NSBundle mainBundle] pathForResource:offline_appZipName ofType:nil];
// 该路径可以是bundle 内的完整路径,也可以是沙盒内的完整路径
request.offlineMiniprogramZipPath = appPath;
// 小程序zip包的密码
request.zipPassword = password;
NSString *libPath = [[NSBundle mainBundle] pathForResource:offline_libZipName ofType:nil];
// 该路径可以是bundle 内的完整路径,也可以是沙盒内的完整路径
request.offlineFrameworkZipPath = libPath;
NSString *packageConfigPath = [[NSBundle mainBundle] pathForResource:packageConfig ofType:nil];
NSData *packagesData = [[NSData alloc] initWithContentsOfFile:packageConfigPath];
NSArray *packages = [NSJSONSerialization JSONObjectWithData:packagesData options:0 error:nil];
// 小程序的分包信息字典
request.packages = packages;
// 是否使用小程序缓存
request.useAppletCache = NO;
// 是否使用基础库缓存
request.useFrameworkCache = NO;
// 自定义api报名单列表
request.extApiWhiteList = @[@"finclipLogin", @"finclipGetUser"];
[[FATClient sharedClient] startLocalAppletWithRequest:request inParentViewController:self completion:^(BOOL result, FATError *error) {
NSLog(@"result:%d---error:%@", result, error);
} closeCompletion:^{
}];
# 2 代理方法
线上版的小程序打开小程序(即navigateToMiniprogram),会直接打开从服务器端拉取和打开。但是本地小程序的小程序包和基础库包,都是本地传入的,所以要实现该流程,就得由App层传入将要打开的小程序的信息,故通过代理方法传递事件。
# 2.1 navigateToMiniProgram 事件
/**
触发打开其他本地小程序的请求事件
该事件只有离线小程序才会触发。
@param appletInfo 小程序对象
@param request 小程序request对象,应该直接使用该request对象,不要创建新的对象。
@param currentVC 当前小程序的顶层视图控制器
@param completion 打开小程序完毕的回调
*/
- (void)applet:(FATAppletInfo *)appletInfo
navigateToMiniProgram:(FATLocalAppletRequest *)request
currentVC:(UIViewController *)currentVC
completion:(void (^)(FATExtensionCode code, NSDictionary *result))completion;
示例代码:
- (void)applet:(FATAppletInfo *)appletInfo
navigateToMiniProgram:(FATLocalAppletRequest *)request
currentVC:(UIViewController *)currentVC
completion:(void (^)(FATExtensionCode, NSDictionary *))completion
{
FATLocalAppletRequest *localRequest = [[FATLocalAppletRequest alloc] init];
NSString *offline_appZipName = @"finapplet_demo.zip";
NSString *offline_libZipName = @"mop-framework-3.0.1.zip";
NSString *packageConfig = @"finapplet_demo.json";
NSString *password = @"1234";
NSString *appPath = [[NSBundle mainBundle] pathForResource:offline_appZipName ofType:nil];
localRequest.offlineMiniprogramZipPath = appPath;
NSString *libPath = [[NSBundle mainBundle] pathForResource:offline_libZipName ofType:nil];
localRequest.offlineFrameworkZipPath = libPath;
NSString *packageConfigPath = [[NSBundle mainBundle] pathForResource:packageConfig ofType:nil];
NSData *packagesData = [[NSData alloc] initWithContentsOfFile:packageConfigPath];
NSArray *packages = [NSJSONSerialization JSONObjectWithData:packagesData options:0 error:nil];
localRequest.appletId = @"finapplet_demo";
localRequest.apiServer = request.apiServer;
localRequest.startParams = request.startParams;
localRequest.packages = packages;
localRequest.zipPassword = password;
localRequest.useAppletCache = NO;
[[FATClient sharedClient] startLocalAppletWithRequest:localRequest inParentViewController:currentVC completion:^(BOOL result, FATError *error) {
if (result) {
completion(FATExtensionCodeSuccess, nil);
} else {
completion(FATExtensionCodeFailure, @{@"errMsg":@"打开失败"});
}
} closeCompletion:^{
}];
}
# 2.2 本地小程序的分包读取事件
由于1 打开离线小程序中要传入的小程序zip包太大,而且也不能很好的使用分包小程序的特性。所以,后续又做了优化,在打开本地小程序时,可以不再传入小程序的zip包路径,这时在加载小程序的分包时,会调用代理方法来获取小程序的分包zip文件。
/**
本地小程序从宿主App获取zip分包路径(适用于小程序分包加载,小程序分包加载必须实现)
如果有多个小程序的分包放在app包中,为了避免zip分包同名,可以将不同小程序的分包放在不同文件夹中,
并通过create folder references方式引入,代码中通过 文件夹名称/分包名.zip 方式获取分包
@param appletInfo 小程序信息
@param packDict 分包信息
@param zipPathCallback zip分包路径回调,路径获取失败调用 zipPathCallback(nil)
*/
- (void)localApplet:(FATAppletInfo *)appletInfo packDict:(NSDictionary *)packDict zipPathCallback:(void (^)(NSString *zipPath))zipPathCallback;
# 2.3 getAccountInfo 代理事件
小程序里的getAccountInfo接口需要返回小程序的小程序id,版本、线上版本号。而本地小程序的信息,都是App维护的。所以也需要实现代理事件来返回正确的信息。
/// 获取本地小程序账号信息
/// @brief 获取本地小程序账号信息,返回的信息结构:
/// @{
/// @"miniProgram": @{
/// @"appId": ##小程序appId##,
/// @"envVersion": ##小程序版本##,
/// @"version": ##线上小程序版本号##
/// },
/// @"plugin": @{
/// @"appId": ##插件appId##,
/// @"version": ##插件版本号##
/// }
/// }
/// @param appletInfo 小程序信息
/// @return 小程序账号信息
- (NSDictionary *)localAppletAccountInfo:(FATAppletInfo *)appletInfo;
# 3 离线(本地)小程序新增特性
# 3.1 离线(本地)小程序版本类型
新增离线(本地)小程序版本类型,在打开离线(本地)小程序时,设置FATLocalAppletRequest对象的appletVersionType属性。 该属性为枚举,总共有6种类型:
typedef NS_ENUM(NSUInteger, FATAppletVersionType) {
FATAppletVersionTypeRelease, // 正式版,默认值
FATAppletVersionTypeTrial, // 体验版
FATAppletVersionTypeTemporary, // 临时版,IDE预览版
FATAppletVersionTypeRemoteDebug, // 远程调试版
FATAppletVersionTypeReview, // 审核版
FATAppletVersionTypeDevelopment // 开发版
};
示例代码:
FATLocalAppletRequest *request = [[FATLocalAppletRequest alloc] init];
...
request.appletVersionType = FATAppletVersionTypeTrial;
[[FATClient sharedClient] startLocalAppletWithRequest:request inParentViewController:self completion:^(BOOL result, FATError *error) {
} closeCompletion:^{
}];