初探iOS14-Widget小组件

Note iOS

Word count: 1.6kReading time: 6 min

 2021/03/15 

简单了解iOS14中widget的实现和使用方法

小组件(Widget)可以在主屏幕上实现内容展示和功能跳转。系统会向小组件获取时间线(TimeLine)，根据当前时间对时间线上的数据进行展示。点击正在展示的视觉元素可以跳转到APP内，实现对应的功能。

关键词

开发框架：必须为swiftUI
尺寸：小组件分为小尺寸、中等尺寸、大尺寸三种
TimeLine ：Timeline 是一个以TimelineEntry为元素的数组。TimelineEntry 包含一个 date 的时间对象，用以告知系统在何时使用此对象来创建小组件的快照。也可以自定义一个模型struct，实现TimelineEntry协议，加入业务所需要的数据模型或其他信息。小组件的运行，是基于TimeLine的，不同于普通的app。
SnapShot : 快照，用于小组件在组件库中的展示

Provider

当我们使用Xcode新建一个小组件项目时，Xcode会为我们实现一个默认效果的小组件。

Provider: provider是提供小组件所需信息的结构体，遵循TimeLineProvider协议。其中包含了placeholder getSnapshot getTimeline 这几个方法。

getSnapshot : getSnapshot方法实现了一个当小组件出现异常或者网络错误请求不到数据时展示的view。

func getSnapshot(in context: Context, completion: @escaping (SimpleEntry) -> ()) {
        let entry = SimpleEntry(date: Date())
        completion(entry)
    }

getTimeline : 在这个方法中可以进行网络请求，获得所需要的数据，并保存在对应的entry中，也就是遵循TimelineEntry协议的结构体

func getTimeline(in context: Context, completion: @escaping (Timeline<Entry>) -> ()) {
        var entries: [SimpleEntry] = []
        let currentDate = Date()
        for hourOffset in 0 ..< 5 {
            let entryDate = Calendar.current.date(byAdding: .hour, value: hourOffset, to: currentDate)!
            let entry = SimpleEntry(date: entryDate)
            entries.append(entry)
        }

        let timeline = Timeline(entries: entries, policy: .atEnd)
        completion(timeline)
    }

TimelineEntry : 在上述代码中使用的SimpleEntry就是遵循了TimelineEntry协议的结构体，用来保存所需要的数据。由于小组件是由时间流驱动的，所以TimelineEntry非常重要，它决定了在某个时间小组件显示的内容。
completion : 当调用completion方法时，小组件的内容和界面会进行刷新。注意，小组件每日是有刷新限制的，并且只有主app在前台运行时才可以主动刷新

WidgetEntryView

这个结构体是我们用来展示的视图view，我们可以在里面进行UI的搭建。

struct WidgetEntryView : View {
    var entry: Provider.Entry
    var body: some View {
        Text(entry.date, style: .time)
    }
}

@main

@main
struct TestWidget: Widget {
    let kind: String = "TestWidget"

    var body: some WidgetConfiguration {
        StaticConfiguration(kind: kind, provider: Provider()) { entry in
            TestWidgetEntryView(entry: entry)
        }
        .configurationDisplayName("My Widget")
        .description("This is an example widget.")
        //supportedFamilies不设置的话默认三个样式都实现
        .supportedFamilies([.systemSmall, .systemMedium, .systemLarge])
    }
}

在小组件的开发中，我们会发现有@main关键字，这是整个小组件的主入口，系统从这里开始加载。
在遵循Widget协议的结构体中，会有kind字段，这是小组件的唯一标识。
StaticConfiguration ：初始化配置代码
configurationDisplayName ：添加编辑界面展示的标题
description ：添加编辑界面展示的描述内容
supportedFamilies ：这里可以限制要提供三个样式中的哪几个

那么这时候我们就需要用到WidgetBundle协议了

首先，我们创建好我们需要的widget，也就是多个遵循Widget协议的结构体，当然这些widget各自的timeline和timelineEntry也要写好
接下来我们创建一个遵循WidgetBundle协议的结构体。并将@main标志符更改至这个结构体的上方。
在遵循WidgetBundle协议的结构体中，返回我们写好的widget，就完成了多个小组件的创建。

struct YourWidgets: WidgetBundle {
    @WidgetBundleBuilder
    var body: some Widget {
        OneWidget()
        TwoWidget()
        ThreeWidget()
        ......  
    }
}

关于数据

在widget中，网络请求可以使用原生的URLSession实现. 在使用swift写时我们可以封装一个用来进行网络请求的struct，并在里面实现网络请求和JSON数据转化以及创建数据模型的函数。
示例代码：

static func request(completion: @escaping (Result<Poetry, Error>) -> Void) {
        let url = URL(string: "")!
        let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
            guard error == nil else {
                completion(.failure(error!))
                return
            }
            
            completion(.success(xxx))
        }
        task.resume()
    }

在widget中，是可以拿到主app的一些数据的。实现的方式是App Group。在Widget的Target中添加App groups，并添加与主程序相同的App Group ID，注意，主程序也需要有App groups。设置好之后，我们可以通过NSUserDefaults和NSFileManager两种方式来与主app通讯。前者使用- (instancetype)initWithSuiteName:(NSString *)suitename;方法，传入app group id，就可以存取数据；后者使用- (NSURL *)containerURLForSecurityApplicationGroupIdentifier:(NSString *)groupIdentifier;方法。

关于跳转

跳转是小组件的一个重要功能，如果只实现了简单的数据展示的话小组件并不能成为一个流量入口

widget支持两种跳转方式： widgetURL 和 Link
其中，小尺寸的widget只支持widgetURL
widgetURL : 点击区域是小组件的所有区域，适用于比较简单的小组件。且只能有一个url，多添加的不会响应。
Link : 点击区域可以细分到各个控件。
URL Schemes : URL Schemes是小组件能跳转到主app的重要桥梁。注册自定义 URL Scheme 非常简单，通过 info.plist –> URL Types –> item0 –> URL Schemes –> 自定义的Scheme 来设置。
在iOS13之后，我们可以在SceneDelegate中的代理方法处理跳转的url，并完成跳转后相应的需求。

总结

正如widget的定义App Extension,小组件并不是一个mini的app，它只是一连串由时间流串起来的数据驱动的静态视图。不能实时更新数据是一个很大的限制，所以开发时不能把它当成一个mini app来思考。
合理设计小组件可以增加主app的曝光率，并且点击就可以跳转至主app的指定功能可以使主app更易用。
利用小组件静态、常驻桌面的特点，可以开发出一些如图片展示、词句展示、英文词句等小组件，它还是具有很大的商业价值的。