iOS10.0發布啦(貌似過去有點時間了吧 - -)，在宏觀帶給我們使用體驗的提升之外，更多的是帶給iOS開發者一定的欣喜。

因為我們又要學習新東西來適配10啦。

博文所說的Widget（以下稱之為拓展應用）并不是iOS10系統新推出的插件化應用（其實早在iOS8上就已經出現啦，只不過樓主是在iOS10發布之后才算真正的關注它，實在是慚愧呀）。iOS10之前它僅僅是存在于通知那一欄中，至于多隱蔽我就不說了吧。但在iOS10之后獲得重生，地位獲得了巨大的提升，從這點也不難看出蘋果增加了對它的重視。盡管公司的App沒有適配Widget，但作為一個“后知后覺”的iOS開發者，注意到了但不研究一下就說不過去了吧？

為了避免真實情況與博文的圖不太符合，這里聲明一下:樓主用的IDE是最新版的Xcode8.0(沒辦法，還是迫不及待的進行了升級0.0)，可能會與其他版本的Xcode界面不太一樣

博文中的所有代碼:https://github.com/RITL/WidgetDemo(如果有用請star支持一下，感謝)

預覽圖

這里附上Widget Demo中完成后的預覽圖: 這里會稍有不同，如果使用Xcode7及之前版本IDE編譯的應用(后面稱作宿主應用)，那么找到Widget的方法如圖1；如果是Xcode8編譯的宿主應用，那么可以直接通過3D Touch喚起Widget，當然通過第一種也是可以的。不過兩者本質是一樣的。

iOS10以下可以通過右滑以及下滑找到Widget

</img>

iOS10以及6s以上機型可通過3D Touch直接喚出

</img>

創建Widget Extension

1.首先創建一個新的Target: New->Target，Xcode8 會出現如下界面，選擇Today Extension，命名為WidgetExtension:

</img>

2、創建完畢，則會出現如下文件夾，名字什么的不是問題，一般創建好的名字都為TodayViewController，我只不過是改了改名字而已O(∩_∩)O

</img>

3、這里啰嗦一句，雖然作為應用的拓展，但這兩個應用是“獨立”存在的，你也可以認為這拓展應用與宿主應用是兩個完全獨立的應用，這也就是說明在開發過程中會出現一些共享的問題，不過共享問題下面博文會有介紹。在此之前，對于拓展應用，我們也是要去開發者申請APP ID以及開發，發布證書的。

由于樓主只是為了學習，用了Xcode8的Automatically manager signing，它的作用是自動生成id以及證書。

作用細說一點就是：如果開發Team沒有相應的APP ID，那么Xcode會自動生成APP ID; 如果沒有創建相應的證書，那么它會自動創建證書 (當然，正常開發過程中，還是建議手動去創建ID以及配置證書吧)

</img>

4、證書都配置完畢，運行，添加Widget，就可以看到咱們的項目已經具備了Widget的拓展功能，默認的是MainInterface.storyboard上的內容啦:(我改了改Label上的字，O(∩_∩)O)

</img>

布局方式interface builder or coding

如果牽扯到UI繪制的方式，這里只需要調整一點東西即可。Demo中樓主選用的是使用storyboard完成快速布局，當然，如果開發者習慣使用代碼來完成布局，依舊是可以的。需要對拓展應用的info.plist文件做如下操作:

使用interface builder

這個是默認的，如果修改了默認的storyboard，只需要將NSExtensionMainStoryboard的value修改成相應的storyboard名字即可

</img>

使用coding

首先將NSExtensionMainStoryboard字段刪除，添加NSExtensionPrincipalClass字典，value為主控制器的類名即可。

使用這個方法不要忘記在todayViewController的ViewDidLoad中設置preferredContentSize屬性調整大小。

</img>

數據共享

很多的時候我們需要Widget與宿主應用共享一些數據，想到數據共享，如果是單一的APP，我們的方法是很多的，比如單例，文件等形式，但由于拓展與宿主應用是兩個完全獨立的App，并且iOS應用基于沙盒的形式，所以一般的共享數據方法都是實現不了數據共享，這里就需要使用App Groups。

App Groups

1、首先需要在開發者網站注冊一個App Groups

</img>

2、在宿主應用以及拓展應用中將App Groups打開，選中需要共享數據的group

</img>

兩種共享數據的方式

使用UserDefaults共享數據

NSUserDefaults大家應該都是非常熟悉的了，通常用法就是

//獲取UserDefaults的單例對象，完成對應用內相關數據的持久化儲存
[NSUserDefaults standardUserDefaults];

正像之前所說，由于沙盒機制，拓展應用是不允許訪問宿主應用的沙盒路徑的，因此上述用法是不對的，需要搭配app group完成實例化UserDefaults，使用UserDefaults類進行數據共享樓主封裝為RITL_ShareDataDefaultsManager

通過groups實例化UserDefaults對象的代碼如下:

//組名
private static let groupIdentifier : String = "group.com.yue.WidgetTest"

/// 獲得userDefualt對象
private class func __userDefault() -> UserDefaults
{
    return UserDefaults(suiteName: RITL_ShareDataDefaultsManager.groupIdentifier)!
}

存儲數據方法如下，至于為什么會有open關鍵詞(與public作用是一樣的，只不過開發文檔中新的API貌似都改為open了)，因為樓主在Demo中將該文件分離出來了，需要實現"不同命名空間"代碼共用，所以Swift默認的Internal作用域就顯得權限不足了，至于如何分離下面會提及:

//存放數據的鍵值
private static let defaultKey : String = "com.yue.WidgetTest.value"

/// 保存數據
open class func saveData(_ value : String)
{
    //保存數據
    __userDefault().set(value, forKey: RITL_ShareDataDefaultsManager.defaultKey)
    __userDefault().synchronize()
}

獲取數據的方法與保存數據很像:

/// 獲取數據
open class func getData() -> String!
{
    //如果值為nil,表示沒有存過值，返回默認的值
    let value = (__userDefault().value(forKey: RITL_ShareDataDefaultsManager.defaultKey))
    
    __userDefault().synchronize()
    
    guard value == nil else {
        
        return value as! String
    }

    return ""
}

因為是通過文件來生成，所以必須要在必要的時候對存儲的數據進行刪除，如下:

/// 清除數據
open class func clearData()
{
    __userDefault().removeSuite(named: RITL_ShareDataDefaultsManager.groupIdentifier)
    __userDefault().synchronize()
}

使用FileManager共享數據

第二種方法說本質的與第一種是一樣的，因為他們都是通過在本地創建文件完成數據的共享，該功能的Demo中封裝成了RITL_ShareDataFileManager

與第一種不同的就是，它不但要實例化對象，還需要獲得保存數據的路徑，如下:

//組名
private static let groupIdentifier : String = "group.com.yue.WidgetTest"

//存儲的路徑
private static let dataSavePathFile : String = "Library/Caches/widgetTest"

/// 獲得存儲的路徑
private class func __fileManagerSavePath() -> URL
{
    //獲得當前的組的路徑
    var url = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: RITL_ShareDataFileManager.groupIdentifier)
    
    //返回拼接完畢的路徑
    url?.appendPathComponent(RITL_ShareDataFileManager.dataSavePathFile)
    
    return url!
}

保存數據的方法，因為在Swift中有的方法是throw異常的，所以寫法稍有不同，如下:

/// 保存數據
open class func saveData(_ value:String) -> Bool
{
    //進行存儲
    do {
        try value.write(to: __fileManagerSavePath(), atomically: true, encoding: String.Encoding.utf8)
        
    } catch _ as NSError {//出錯
        
        return false
    }
    return true
}

獲取數據的方法只是讀取存放的數據即可，當然Demo中存的是字符串，方法實現如下:

/// 獲取數據
open class func getData() -> String
{
    //用于接收數據
    var value : String
    
    do {//讀取數據
        try value = String(contentsOf: __fileManagerSavePath())
        
    } catch _ as NSError {
        
        return ""http://有誤輸出空字符串
    }
    return value
}

必要時候不要忘記清除數據:

/// 清除數據
open class func clearData() -> Bool
{
//其實不太規范，應該先判斷是否存在該文件，再進行刪除
    do {//開始刪除
        try FileManager.default.removeItem(at: __fileManagerSavePath())
        
    } catch _ as NSError{
        
        return false
    }
    return true
}

代碼共享

這里為什么會有代碼共享呢，如果上面兩個存儲的類寫在了宿主應用目錄下，那么宿主應用使用是沒有問題的，but，這個時候拓展應用是獲取不到這兩個類的，當然，如果每個應用里都寫一套不就可以了，雖然這樣也能解決問題，但我很難用完美解決問題來形容他，因為這樣不僅會出現命名，不好維護等眾多問題，嚴重的時候還會帶來很多問題，話不多說，如何共享代碼呢？

使用Framework

這個問題在iOS8之后能夠完美的用framework來解決，(如果有人問iOS7怎么辦？請面壁3秒鐘，Widget不是iOS8才對我們開放的么0.0)

1、與創建拓展一樣，New->Target，選擇Cocoa Touch Framework來創建framework，Demo中命名隨便了一點，起名為RITLKit

</img>

2、將需要共享的代碼從源項目的編譯源中刪除，添加到RITLKit中

</img>

3、將創建的framework都要鏈接到宿主項目以及拓展應用的Linked Frameworks and Libraries中，不要忘了，都要添加，不然可能會出現找不到文件的問題

</img>

4、這里提示一下，如果上面的步驟完成，但是在拓展中還是提示找不到文件，那么還需要做一個步驟，就是將我們的framework添加到拓展應用中Allow app extension API only選中即可，將如下:

</img>

5、以上步驟完畢之后，應該就可以在拓展以及宿主應用中實現代碼共用了，但還有一點：

如果是ObjC項目，導入Objc的文件，只需使用#import"XX.h"導入即可，但是如果framework中含有Swift文件，使用#import "Project-Swift.h"是導入不進去項目的，可以使用@import RILTKit; 對創建的framework編譯的文件進行導入，就可以使用Swift文件了，這件事在Demo中也已經實現。

Extension與宿主應用交互

通過點擊Widget上的按鈕來打開宿主應用并實現響應操作也是一種重要的交互手段，如何實現呢？

1、首先我們需要在宿主應用的Target->Info->URL Types中添加url Schemes

</img>

2、通過Widget來打開宿主應用，Demo中點擊Widget中的按鈕跳轉至不同的界面，通過Widget打開宿主應用的操作如下:

/// 打開我的App
- (void)openMyApplication:(NSString *)title
{
    NSURL * url = [NSURL URLWithString:[NSString stringWithFormat:@"WidgetDemoOpenViewController://%@",title]];
    
   [self.extensionContext openURL:url completionHandler:^(BOOL success) {}];
}

3、宿主App通過AppDelegate中的響應openUrl的代理方法，接收信息并發出通知來響應全局:

/// 
-(BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
    if ([url.scheme isEqualToString:@"WidgetDemoOpenViewController"])
    {
        NSLog(@"host = %@",url.host);
        
        //發送通知
        [[NSNotificationCenter defaultCenter] postNotificationName:@"ExtenicationNotification" object:url.host];
    }
    return false;
}

4、宿主應用中響應通知的控制器接收通知即可，比如Demo中是主頁進行跳轉:

//添加獲得拓展打開基礎應用的通知
[[NSNotificationCenter defaultCenter] addObserverForName:@"ExtenicationNotification" object:nil queue:nil usingBlock:^(NSNotification * _Nonnull note) {
   
    //獲得類型
    NSString * type = note.object;
    
    [weakSelf presentTextController:type];
    
}];

NCWidgetProviding協議

如何仔細看，其實Widget的控制器與其他的控制器是沒有區別的，只不過它履行了一個叫做"NCWidgetProviding"的協議。協議方法不多，在iOS10中新增了一個，廢棄了一個，如下:

// 這個就不用多說了吧，沒有很難得單詞哦0.0
typedef NS_ENUM(NSUInteger, NCUpdateResult) {
    NCUpdateResultNewData,
    NCUpdateResultNoData,
    NCUpdateResultFailed
} NS_ENUM_AVAILABLE_IOS(8_0);


/* 該方法是用來告知Widget控制器是否需要更新的一個協議方法 */
- (void)widgetPerformUpdateWithCompletionHandler:(void (^)(NCUpdateResult result))completionHandler;

比如Demo中為了避免重復刷新做了如下操作：

- (void)widgetPerformUpdateWithCompletionHandler:(void (^)(NCUpdateResult))completionHandler {
    // Perform any setup necessary in order to update the view.
    
    // If an error is encountered, use NCUpdateResultFailed
    // If there's no update required, use NCUpdateResultNoData
    // If there's an update, use NCUpdateResultNewData
    //獲得數據
    NSString * newValue = [RITL_ShareDataDefaultsManager getData];
    
    if ([newValue isEqualToString:self.textLabel.text])//表明沒有更新
    {
        completionHandler(NCUpdateResultNoData);
    }
    
    else//需要刷新
    {
        completionHandler(NCUpdateResultNewData);
    }
}

// iOS10 版本之后將不會再被喚起
// 用來設置Widget控制器邊框間距的方法，如果出現偏差，可以調整此方法的返回值進行操作
- (UIEdgeInsets)widgetMarginInsetsForProposedMarginInsets:(UIEdgeInsets)defaultMarginInsets NS_DEPRECATED_IOS(8_0, 10_0, "This method will not be called on widgets linked against iOS versions 10.0 and later.");


// iOS10 新增的方法
// 用來設置Widget是展開還是折疊狀態的方法，可以設置相關的preferredContentSizes屬性修改大小
- (void)widgetActiveDisplayModeDidChange:(NCWidgetDisplayMode)activeDisplayMode withMaximumSize:(CGSize)maxSize NS_AVAILABLE_IOS(10_0);

保存數據的時機

這個看具體的需求，比如Demo中就是選擇在宿主應用將要失去Active狀態的時候進行數據的保存，實現如下:

    //獲得失去前臺的監聽
    [[NSNotificationCenter defaultCenter] addObserverForName:UIApplicationWillResignActiveNotification object:nil queue:nil usingBlock:^(NSNotification * _Nonnull note) {//進行數據的保存
        
        //保存當前的數據
#ifdef RITL_ShareDataType_UserDefaults
        //第一種保存數據
        [RITL_ShareDataDefaultsManager saveData:weakSelf.mainTextField.text];
        
#else
        //第二種保存數據
        [RITL_ShareDataFileManager saveData:weakSelf.mainTextField.text];
#endif
        
    }];

Widget無法展開折疊問題

2016-09-24補充

之前丟了一點，也有小伙伴們問，就是說按照上面的方式來開發插件，不能折疊的問題.

解決方案:

//在TodayViewController的ViewDidLoad里面需要設置最大展示的類型
#ifdef __IPHONE_10_0 //因為是iOS10才有的，還請記得適配
    //如果需要折疊
    self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeExpanded;
#endif

Widget高度范圍

2016-09-28補充

首先感謝一下CSDN用戶qq_29012653的提示，之前沒有太注意，在協議方法widgetActiveDisplayModeDidChange:withMaximumSize:打印了一下各種狀態下的MaxSize:

// 5s模擬器下:
// NCWidgetDisplayModeCompact模式下:{304, 110}
// NCWidgetDisplayModeExpanded模式下:{304, 528}

// 6s模擬器下：
// NCWidgetDisplayModeCompact模式下:{359, 110}
// NCWidgetDisplayModeExpanded模式下:{359, 616}

//從上面來看，雖說是最大的Size,但不得不說，蘋果還是把Widget的高度范圍限制在了110 ~ 最大值之間
//如果設置高度小于110，那么default = 110;
//如果設置高度大于最大的616，那么default = 最大值;

但折疊狀態下，可能是出于規范的考慮，蘋果是果斷的將高度固定在110上，所以這個時候我們設置preferredContentSize屬性是沒有任何效果的。

更多的歡迎下載Github代碼一起鉆研~3Q

感謝一下博文對我的幫助，感謝
iOS開發之widget實現
 WWDC 2014 Session筆記 - iOS 通知中心擴展制作入門

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

iOS開發------Widget(Today Extension)插件化開發

iOS開發------Widget(Today Extension)插件化開發

預覽圖

創建Widget Extension

布局方式interface builder or coding

使用interface builder

使用coding

數據共享

App Groups

兩種共享數據的方式

使用UserDefaults共享數據

使用FileManager共享數據

代碼共享

使用Framework

Extension與宿主應用交互

NCWidgetProviding協議

保存數據的時機

Widget無法展開折疊問題

Widget高度范圍

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

iOS開發------Widget(Today Extension)插件化開發

預覽圖

創建Widget Extension

布局方式interface builder or coding

使用interface builder

使用coding

數據共享

App Groups

兩種共享數據的方式

使用UserDefaults共享數據

使用FileManager共享數據

代碼共享

使用Framework

Extension與宿主應用交互

NCWidgetProviding協議

保存數據的時機

Widget無法展開折疊問題

Widget高度范圍

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频