美文网首页
IOS Today Extension 入门指南

IOS Today Extension 入门指南

作者: 莱怯兜特 | 来源:发表于2018-04-20 17:39 被阅读0次

    简述:

    Provide a quick update or enable a brief task in the Today view of Notification Center
    即Widget窗口组件,类似于快捷入口or快捷窗口,展示在通知栏这

    概览:

    1.创建TodayExtension
    2.运行
    3.生命周期
    4.界面绘制
    5.跳转回主体App
    6.数据共享
    7.其他功能

    一.创建TodayExtension

    1.Flie -> New -> Target -> ios -> Application Extension -> Today Extension

    二.运行TodayExtension

    更改Target至TodayExtension
    运行

    运行后在手机通知栏查看如下:


    111.gif

    三.生命周期

    5D96CD85-7199-4EAC-8C89-D94D688C6BE5.png

    上图为通用的extension生命周期,today extension稍有区别
    1.用户选择appExtension(用户切换至通知栏界面,并滑动显示出我们的extension界面时)
    2.系统启动App Extension
    3.App Extension 代码运行
    4.运行完之后系统kill掉App Extension(离开了我们的extension界面一段时间后)

    extension代码中的回调顺序

    viewDidLoad (界面加载)
    widgetActiveDisplayModeDidChange (控件显示模式发生改变代理,即紧凑和扩展)
    widgetPerformUpdateWithCompletionHandler (官方建议在这个回调中进行数据获取)

    四.界面绘制

    widget有2种模式,compact(紧凑)及expended(扩展)
    expended模式只有在IOS10+才有
    选择expended模式时,系统会增加一个"展开"按钮,供用户自由切换compact和expended模式
    compact mode:所有机型高度为110
    expended mode:根据机型不同高度不同(也可以自由设置高度,小于最大值,大于110)
    以expended模式为例:直接使用系统给的MainInterface.storyboard 进行绘制

    1.stroyboard搭界面
    前110height为compact时显示内容(绿色)
    后面部分为展开时会显示的内容(蓝色)

    直接更改MainInterface.storyboard的默认view.height至300(自定义expended的高度)并填充控件

    E45131B4-5911-468B-93DF-6C0FA341DE28.png

    2.代码实现

    viewDidLoad中设置widget的displayMode为expended(largest)
    widgetActiveDisplayModeDidChange中设置不同模式时的preferredContentSize
    【widget的最终大小是由prefereedContentSize来决定,因此必须手动更改】
    widgetPerformUpdateWithCompletionHandler中更新数据

    - (void)viewDidLoad {
        [super viewDidLoad];
        //设置widget可扩展
        self.extensionContext.widgetLargestAvailableDisplayMode = YES;
    }
    
    //紧凑,扩展的显示模式发生改变时回调
    -(void)widgetActiveDisplayModeDidChange:(NCWidgetDisplayMode)activeDisplayMode withMaximumSize:(CGSize)maxSize{
        NSLog(@"widgetActiveDisplayModeDidChange:%d,height = %.2f, width = %.2f",(int)activeDisplayMode,maxSize.height,maxSize.width);
    
        if (activeDisplayMode == NCWidgetDisplayModeCompact) {
            //紧凑时更改size至最大值
            self.preferredContentSize = CGSizeMake(maxSize.width, maxSize.height);
        }else{
            //扩展时,更改size.height至300
            self.preferredContentSize = CGSizeMake(maxSize.width, 300);
        }
    }
    
    //数据获取
    //官方建议你通过实现它的回调来获取数据
    - (void)widgetPerformUpdateWithCompletionHandler:(void (^)(NCUpdateResult))completionHandler {
          //官方建议在此获取数据
          completionHandler(NCUpdateResultNewData);
    }
    

    五.跳转回主体App(container)

    点击widget的某个按钮,快捷进入到自己app的某个页面

    1.主体app设置URL Schemes

    A5A316F9-8332-44F0-9D57-C76E28BB9A31.png

    2.extension的info.plist里设置白名单

        <key>CFBundleURLSchemes</key>
        <array>
            <string>AMNewInIOS8</string>
        </array>
    

    3.触发跳转 @“Schemes://xxxxxx

    - (IBAction)clickButton:(id)sender {
        NSURL *url = [NSURL URLWithString:@"AMNewInIOS8://"];
        [self.extensionContext openURL:url completionHandler:^(BOOL success) {
            NSLog(@"open status: %d",success);
        }];
    }
    



    4.主体App响应跳转至某个界面(注意ios9+及以前的区别)

    //ios9实现此代理
    -(BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options{
        UINavigationController* navi =  (UINavigationController*)self.window.rootViewController;
        UIStoryboard * sb = [UIStoryboard storyboardWithName:@"Main" bundle:nil];
        UIViewController * todayVC =[sb instantiateViewControllerWithIdentifier:@"NFTodayOpenURLVC"];
        [navi pushViewController:todayVC animated:YES];
        return YES;
    }
    
    //ios9以前实现此代理
    - (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url{
        UINavigationController* navi =  (UINavigationController*)self.window.rootViewController;
        UIStoryboard * sb = [UIStoryboard storyboardWithName:@"Main" bundle:nil];
        UIViewController * todayVC =[sb instantiateViewControllerWithIdentifier:@"NFTodayOpenURLVC"];
        [navi pushViewController:todayVC animated:YES];
        return YES;
    }
    

    六.数据共享

    Extension与主体app处于不同的沙盒中,数据共享及交互需要使用group来进行共享
    同一账号下的所有app及extension可以通过group来进行数据共享

    1.证书建立

    创建App Group (ID必须以group.com开头)
    创建主体App以及Extension的AppId并勾选App Groups功能
    点击App Groups边的Edit进行编辑,勾选之前创建的Group,成为组员

    [图片上传中...(9D8DF0E6-C5F3-42EA-8266-DB5891622E0E.png-793d71-1524216372694-0)] 9D8DF0E6-C5F3-42EA-8266-DB5891622E0E.png

    2.项目配置

    主体App及Extension的Capabilities中打开App Groups选项
    勾选Group

    0AC8ED3A-97A7-4038-BD4C-EDFCA85A139D.png

    3.通过UserDefaults共享基本数据

    //通过UserDefaults存储
    - (void)saveDataByNSUserDefaults
    {
        //填写正确的groupID
        NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.aimi.extension"];
        [shared setObject:@"Hello,UserDefaults" forKey:@"todayExTextStr"];
        [shared synchronize];
    }
    
    //通过UerDefaults 读取数据
    - (NSString *)readDataFromNSUserDefaults
    {
        //填写正确的GroupId
        NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.aimi.extension"];
        NSString *value = [shared valueForKey:@"todayExTextStr"];
        return value;
    }
    

    4.通过NSFileManager共享文件

    //通过NSFileManager 存储
    - (BOOL)saveDataByNSFileManager
    {
        NSError *error = nil;
        //填写正确的GroupID
        NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.com.aimi.extension"];
        containerURL = [containerURL URLByAppendingPathComponent:@"Library/Caches/todayExtension.txt"];
        
        NSString *value = @"Hello,FileManager";
        BOOL result = [value writeToURL:containerURL atomically:YES encoding:NSUTF8StringEncoding error:&error];
        if (!result) {
            NSLog(@"%@",error);
        } else {
            NSLog(@"save value:%@ success.",value);
        }
        
        return result;
    }
    
    //通过NSFileManager 读取数据
    - (NSString *)readDataByNSFileManager
    {
        NSError *error = nil;
        //填写正确的GroupId
        NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.com.aimi.extension"];
        containerURL = [containerURL URLByAppendingPathComponent:@"Library/Caches/todayExtension.txt"];
        NSString *value = [NSString stringWithContentsOfURL:containerURL encoding:NSUTF8StringEncoding error:&error];
        
        return value;
    }
    

    七.其他

    在Today Extension中同样可以进行网络请求,设置图片
    并且Extension界面可以设置动画以及界面切换甚至可以展现一个小游戏(只是没有必要)


    extension和主体App处于不同target,不能直接使用主体App中的框架及图片
    若需要使用网络框架或图片可以另外导入到extension中
    或者在加入图片或文件时,勾选上extension的target即可只用

    推荐做成framework框架,勾选上extension的target (所有extension和主题共用)

    96C47F7C-4DE6-443F-8466-BF331D88E363.png

    其他API:

    //使用这个UIVibrancyEffect效果,让widget里的自定义文字看起来更有原生的那种模糊半透明效果
    //即滑动时文字会随着背景的颜色而变化
    //primary和sencondary暂时测试下来没什么区别
    + (UIVibrancyEffect *)widgetPrimaryVibrancyEffect NS_AVAILABLE_IOS(10_0); 
    + (UIVibrancyEffect *)widgetSecondaryVibrancyEffect NS_AVAILABLE_IOS(10_0);
    
    //如何使用UIVibracyEffect
        UIVibrancyEffect* primaryEffect = [UIVibrancyEffect widgetPrimaryVibrancyEffect];
        UIVisualEffectView* primaryView = [[UIVisualEffectView alloc]initWithEffect:primaryEffect];
        primaryView.frame = CGRectMake(100, 40, 100, 40);
        
        UILabel* l1 = [[UILabel alloc]initWithFrame:primaryView.bounds];
        l1.tintColor = [UIColor redColor];
        l1.font = [UIFont systemFontOfSize:16];
        l1.textAlignment = NSTextAlignmentLeft;
        l1.text = @"Primary";
    
       //必须将subview添加到contenView里
        [primaryView.contentView addSubview:l1];
        
        
        [self.view addSubview:primaryView];
    

    相关文章

      网友评论

          本文标题:IOS Today Extension 入门指南

          本文链接:https://www.haomeiwen.com/subject/iyepkftx.html