iOS 3D Touch超详细入门介绍(附带demo示例代码)

一、简介

3d touch是指：通过对屏幕施加不同程度的压力来访问附加功能。应用可以通过显示菜单、展示其他内容和播放动画等形式来表现3d touch，该功能从6s及其以上机型开始得到支持。

3d touch的主要体现形式有三种：

主屏交互(home screen interaction)
预览和跳转(peek and pop)
livephoto

今天主要介绍前两种，第三种涉及到相册资源，有时间会将其作为一个独立的专题进行讲解。文末会附上github地址。

二、提纲

1. 主屏交互(home screen interaction)

静态添加快捷操作(static quick actions)
动态添加快捷操作(dynamic quick actions)

2. 预览和跳转(peek and pop)

peek
①注册3d touch
②通过代理实现功能
pop
①通过代理实现功能

三、实现

1.主屏操作

3d touch在主屏交互的表现形式：当用户点击app的同时并施加一定压力的时候，程序会在适当的位置展示出一个菜单选项列表。操作效果如下图所示：

homescreen.gif

1.1.静态快捷操作

①通过静态的方式添加快捷操作：这种方式主要是在项目的info.plist文件中添加相关的属性。
第一种在info.plist文件添加方法：

第一种infoplist添加方法.png

第二种在info.plist文件添加方法：
1.右键info.plist -->open as ->source code;

第二种infoplist添加方法.png

2.在文件中添加以下代码：

uiapplicationshortcutitems
    
        
            uiapplicationshortcutitemicontype
            uiapplicationshortcuticontypeshare
            uiapplicationshortcutitemtitle
            分享“dm3dtouch”
            uiapplicationshortcutitemtype
            cn.damon.dm3dtouchdemo.openshare
            uiapplicationshortcutitemuserinfo
            
                key2
                value2
            
        
        
            uiapplicationshortcutitemiconfile
            favorite
            uiapplicationshortcutitemtitle
            收藏
            uiapplicationshortcutitemtype
            cn.damon.dm3dtouchdemo.openfavorites
            uiapplicationshortcutitemuserinfo
            
                key1
                value1
            
        
    

1.2.动态快捷操作

①通过动态的方式添加快捷操作：这种方式主要通过代码的形式把shortcutitems对象数组传递给uiapplication单例对象。我们可以在app启动方法：

-(bool)application:(uiapplication *)application didfinishlaunchingwithoptions:(nsdictionary *)launchoptions

或者在windows.rootviewcontroller的viewdidload方法里面添加我们的代码。
代码示例如下：

    nsmutablearray *arrshortcutitem = (nsmutablearray *)[uiapplication sharedapplication].shortcutitems;
    
    uiapplicationshortcutitem *shoreitem1 = [[uiapplicationshortcutitem alloc] initwithtype:@"cn.damon.dm3dtouchdemo.opensearch" localizedtitle:@"搜索" localizedsubtitle:nil icon:[uiapplicationshortcuticon iconwithtype:uiapplicationshortcuticontypesearch] userinfo:nil];
    [arrshortcutitem addobject:shoreitem1];
    
    uiapplicationshortcutitem *shoreitem2 = [[uiapplicationshortcutitem alloc] initwithtype:@"cn.damon.dm3dtouchdemo.opencompose" localizedtitle:@"新消息" localizedsubtitle:@"" icon:[uiapplicationshortcuticon iconwithtype:uiapplicationshortcuticontypecompose] userinfo:nil];
    [arrshortcutitem addobject:shoreitem2];
    
    [uiapplication sharedapplication].shortcutitems = arrshortcutitem;

附：参数对象说明

uiapplicationshortcutitem：可以看作是3d touch点击后，弹出菜单每行对应的模型，一行对应一个uiapplicationshortcutitem对象。

实例化方法：

- (instancetype)initwithtype:(nsstring *)type localizedtitle:(nsstring *)localizedtitle localizedsubtitle:(nullable nsstring *)localizedsubtitle icon:(nullable uiapplicationshortcuticon *)icon userinfo:(nullable nsdictionary *)userinfo：

type：对应uiapplicationshortcutitem对象的唯一标识符。
localizedtitle：对应uiapplicationshortcutitem对象的主标题。
localizedsubtitle：对应uiapplicationshortcutitem对象的副标题。
icon：对应要显示的图标，有两种图标：
①定义的类型，代码如下：

+ (instancetype)iconwithtype:(uiapplicationshortcuticontype)type;

②用户自定义的类型，代码如下：

+ (instancetype)iconwithtemplateimagename:(nsstring *)templateimagename;

要注意的是，如果通过第二种自定义方式创建图标，必须使用指定格式的图片，不然显示出来的是一片黑色。开发文档规定格式如下：

icons should be square, single color, and 35x35 points

图片必须是正方形、单色并且尺寸是35*35像素的图片。(点击下载模板)
userinfo：主要是用来提供app的版本信息。

如果同时使用静态和动态的方法添加，其添加的先后顺序是：先添加静态shortcutitem对象，如果静态shortcutitem对象不足4个，则继续添加动态shortcutitem对象。官方文档提及到最多只能添加4个shortcutitem对象，但是有的app却能添加5个，有办法添加5个的欢迎留言讨论。

1.3.点击菜单选项进入app的监听

当添加完shortcutitem对象，我们的下一步任务就是监听用户点击哪一个选项进入到程序。我们只需要在appdelegate中实现代理方法，如下：

- (void)application:(uiapplication *)application performactionforshortcutitem:(uiapplicationshortcutitem *)shortcutitem completionhandler:(void (^)(bool))completionhandler {

    //不管app在后台还是进程被杀死，只要通过主屏快捷操作进来的，都会调用这个方法
    nslog(@"name:%@\ntype:%@", shortcutitem.localizedtitle, shortcutitem.type);    
}

我们可以通过shortcutitem对象获取到唯一标识符，只需要判断标识符就可以处理我们的逻辑任务了。

2.peek and pop

peek and pop主要是通过3d touch，使用户可以在当前视图预览页面、链接或者文件。如果当前页面控制器注册了3d touch，我们只需要点击相应的内容并施加一点压力，就能使当前内容高亮，并且其他内容进入一个模糊虚化的状态；当我们再施加一点压力，就能预览当前内容对应的页面；如果需要进入到该内容对应的页面，我们只需要稍微再施加一点压力直至预览视图放大到全屏，就可以跳转到其对应的页面。另外，如果我们在预览页面的同时，往上拖拽就可以显示出一个类似uiactionsheet界面的快捷操作菜单。以上所述效果如下：


peekandpod.gif

我们通过demo来对peek and pop进行实例分析，以下是该demo大致逻辑、功能说明：


logic.png

1.导航控制器的根控制器是vc1，通过点击vc1中tableview第x行，跳转到vc2。其中,vc2中有一个方法是把数据源的第x个元素替换成字符串【replace item】；
2.通过使用3d touch,在vc1中实现快速预览的功能；
3.使用3d touch，在vc1中跳转进入到vc2；
4.通过快捷菜单中的【替换该元素】选项，替换数据源中的第x个元素

2.1.实现vc1快速预览vc2的功能(peek)

①要使用3d touch，先向要响应3d touch功能的视图控制器注册3d touch，并指定接收手势的源视图。毫无疑问，要响应的视图是tableview中的cell。我们在cell的初始化方法中加入以下代码：

- (uitableviewcell *)tableview:(uitableview *)tableview cellforrowatindexpath:(nsindexpath *)indexpath {

    uitableviewcell *cell = [tableview dequeuereusablecellwithidentifier:reusedid];
    
    if (!cell) {
        
        cell = [[uitableviewcell alloc] initwithstyle:uitableviewcellstyledefault reuseidentifier:reusedid];
    }
    
    cell.contentview.backgroundcolor = [uicolor graycolor];
    
    nsstring *str = [nsstring stringwithformat:@"row [%@]", self.arrdata[indexpath.row]];
    
    cell.textlabel.text = str;
    
    //注册3d touch
    /**
     从ios9开始，我们可以通过这个类来判断运行程序对应的设备是否支持3d touch功能。
     uiforcetouchcapabilityunknown = 0,     //未知
     uiforcetouchcapabilityunavailable = 1, //不可用
     uiforcetouchcapabilityavailable = 2    //可用
     */
    if ([self respondstoselector:@selector(traitcollection)]) {
        
        if ([self.traitcollection respondstoselector:@selector(forcetouchcapability)]) {
            
            if (self.traitcollection.forcetouchcapability == uiforcetouchcapabilityavailable) {
                
                [self registerforpreviewingwithdelegate:(id)self sourceview:cell];
            }
        }
    }
    
    return cell;
}

因为只有在6s及其以上的设备才支持3d touch,我们可以通过uitraitcollection这个类的uitraitenvironment协议属性来判断设备是否支持3d touch。
uitraitcollection是uiviewcontroller所遵守的其中一个协议，不仅包含了ui界面环境特征，而且包含了3d touch的特征描述。

②在vc1中实现uiviewcontrollerpreviewingdelegate代理，监听3d touch手势的触发，示例代码如下：

- (nullable uiviewcontroller *)previewingcontext:(id )previewingcontext viewcontrollerforlocation:(cgpoint)location ns_available_ios(9_0) {

    nsindexpath *indexpath = [self.tableview indexpathforcell:(uitableviewcell *)[previewingcontext sourceview]];
    nsstring *str = [nsstring stringwithformat:@"%@",self.arrdata[indexpath.row]];
    
    //创建要预览的控制器
    dmpresentationviewcontroller *presentationvc = [[dmpresentationviewcontroller alloc] init];
    presentationvc.arrdata = (nsmutablearray *)self.arrdata;
    presentationvc.index = indexpath.row;
    presentationvc.strinfo = str;
    
    //指定当前上下文视图rect
    cgrect rect = cgrectmake(0, 0, [uiscreen mainscreen].bounds.size.width, 300);
    previewingcontext.sourcerect = rect;

    return presentationvc;
}

2.2.实现从vc1跳转到vc2的功能(pop)

要从vc1的快速预览视图跳转进入到vc2，我们需要在vc1中实现以下代理方法：

- (void)previewingcontext:(id )previewingcontext commitviewcontroller:(uiviewcontroller *)viewcontrollertocommit ns_available_ios(9_0) {

    [self showviewcontroller:viewcontrollertocommit sender:self];
}

2.3.快捷功能菜单的生成

如果我们需要在vc1快速预览视图出现时，向上拖拽得到一个快捷功能菜单，需要在vc2中实现以下代理方法：

- (nsarray> *)previewactionitems {
    
    nsmutablearray *arritem = [nsmutablearray array];
    
    uipreviewaction *previewaction0 = [uipreviewaction actionwithtitle:@"取消" style:uipreviewactionstyledestructive handler:^(uipreviewaction * _nonnull action, uiviewcontroller * _nonnull previewviewcontroller) {
        
        nslog(@"didclickcancel");
    }];
    
    uipreviewaction *previewaction1 = [uipreviewaction actionwithtitle:@"替换该元素" style:uipreviewactionstyledefault handler:^(uipreviewaction * _nonnull action, uiviewcontroller * _nonnull previewviewcontroller) {
        
        //把下标为index的元素替换成preview
        [self replaceitem];
        
    }];
    
    [arritem addobjectsfromarray:@[previewaction0 ,previewaction1]];
    
    return arritem;
}

实现了这个代理，我们就可以在vc1中快速预览往上拖拽得到一个快捷功能菜单。而且，我们不需要进入vc2，直接通过点击快捷菜单的【替换该元素】这个选项，就能调用vc2替换元素的方法。应用场景：iphone在短信列表页面，通过快捷功能菜单快速回短信。