前言
自从2020年06月22日在WWDC上，苹果也推出了自己的Widget小部件，WidgetKit面向开发使用，这下开发者又有新内容新功能学习了，各大APP先后都已经推出了自己各式各样的小部件，作为一个iOS开发者，暂且不说个人的观点意见，改变不了的，只有接受学习再改造。
简单介绍
开发环境Xcode 12 以上，Widget是依附于主APP之上的，提交的时候一起审核。
WidgetKit完全依托于SwiftUI建设的，从头文件上看甚至可以说WidgetKit是SwiftUI的一个拓展包而已。(Widget和相关的WidgetConfiguration之类的协议直接就在SwiftUI库内)
WidgetConfiguration配置：kind标识符；
provider提供空间刷新时机和刷新内容的对象，其实就是控件内容提供者；placeholder一个默认的控件view；
content一个获取实际渲染view的block(入参数是provider生成的内容)。
以上信息也可以看出来，苹果的小控件并不是像安卓一样可以自由发挥，看起来更像是一个view生成并且截了一个快照贴到了桌面上。点击这个控件事实上也只是打开app而已，控件本身不提供交互功能。这就是苹果的收口方式吧——这样确实可以大大的保障app桌面常驻性能的稳定。
开发实践
先新建主工程，然后通过Xcode 菜单中 File-New-Target，然后选择Widget Extension创建，注意名字不要和主工程重复，还有不要起Widget名字，报错。
@main
struct CustomWidget: Widget {
let kind: String = "CustomWidget"
var body: some WidgetConfiguration {
IntentConfiguration(kind: kind, intent: ConfigurationIntent.self, provider: Provider()) { entry in
CustomWidgetEntryView(entry: entry)
}
.configurationDisplayName("My Widget")
.description("This is an example widget.")
// 创建一个常规的StaticConfiguration，不可配置的状态的 Widget：
StaticConfiguration(kind: kind, provider: CustomProvider()) { entry in
CustomWidgetEntryTwoView(entry: entry)
}
.configurationDisplayName("First Widegt")
.description("This is my first widget!")
.supportedFamilies([.systemSmall])
}
}
WidgetConfiguration本身无法直接使用，目前有两个子类去使用：
StaticConfiguration，静态小控件配置，其实是普通小控件。
IntentConfiguration，带某种意图目的的小控件，创建小部件的时候勾选上就帮你创建好了。
就是一个IntentConfiguration的代码，如果不勾选的话，就是静态StaticConfiguration。这两者的区别只是数据提供的provider触发时机不同。
var body: some WidgetConfiguration {
StaticConfiguration(kind: kind, provider: Provider()) { entry in
_13EntryView(entry: entry)
}
.configurationDisplayName("My Widget")
.description("This is an example widget.")
}
这个时候一个系统默认自带的小部件就已经创建好了：
但是这肯定远远不够，先分析一下默认的Widget结构：
Provider
struct Provider: IntentTimelineProvider {
func placeholder(in context: Context) -> SimpleEntry {
SimpleEntry(date: Date(), configuration: ConfigurationIntent())
}
func getSnapshot(for configuration: ConfigurationIntent, in context: Context, completion: @escaping (SimpleEntry) -> ()) {
let entry = SimpleEntry(date: Date(), configuration: configuration)
completion(entry)
}
func getTimeline(for configuration: ConfigurationIntent, in context: Context, completion: @escaping (Timeline<Entry>) -> ()) {
var entries: [SimpleEntry] = []
// Generate a timeline consisting of five entries an hour apart, starting from the current date.
let currentDate = Date()
for hourOffset in 0 ..< 5 {
let entryDate = Calendar.current.date(byAdding: .hour, value: hourOffset, to: currentDate)!
let entry = SimpleEntry(date: entryDate, configuration: configuration)
entries.append(entry)
}
let timeline = Timeline(entries: entries, policy: .atEnd)
completion(timeline)
}
}
实现了 IntentTimelineProvider 的这个两个重要的方法，其中getSnapshot为了在小部件库中显示小部件，WidgetKit要求提供者提供预览快照，在组件的添加页面可以看到效果,会在Widget被添加的时候执行，getTimeline通过Timeline(entries: entries, policy: .atEnd)刷新数据和控制下一步刷新时间.
placeholder：提供一个默认的视图，当网络数据请求失败或者其他一些异常的时候，用于展示
但是默认情况下是不会自动刷新小部件，如图：
这就需要后面的处理了。
SimpleEntry
struct SimpleEntry: TimelineEntry {
let date: Date
let configuration: ConfigurationIntent
}
SimpleEntry实现了TimelineEntry协议，主要用于Widget数据保存，类似Model。
WidgetEntryView
struct FirstWidgetEntryView : View {
var entry: Provider.Entry
var body: some View {
Text(entry.date, style: .time)
}
}
WidgetEntryView是Widget的页面布局View的部分。
Widget
@main
struct FirstWidget: Widget {
let kind: String = "FirstWidget"
var body: some WidgetConfiguration {
IntentConfiguration(kind: kind, intent: ConfigurationIntent.self, provider: Provider()) { entry in
FirstWidgetEntryView(entry: entry)
}
.configurationDisplayName("My Widget")
.description("This is an example widget.")
}
}
这里可以看做是Widget的入口，@main 函数，可以当做OC的main函数吧，这里定义了Widget的Kind、Provider、View、WidgetConfiguration等。
PreviewProvider
顾名思义，提供预览的View。
struct FirstWidget_Previews: PreviewProvider {
static var previews: some View {
FirstWidgetEntryView(entry: SimpleEntry(date: Date(), configuration: ConfigurationIntent()))
.previewContext(WidgetPreviewContext(family: .systemSmall))
}
}
创建多个Widget
Swift 不能一次创建多个Widget，否则会报错，亲测，一个项目创建两个Widget就会报错，不支持，但是可以修改当前Widget的@main入口文件，这时候就要用到WidgetBundle，Apple提供了相关API:
WidgetBundle
A container used to expose multiple widgets from a single widget extension.
@main
struct GameWidgets: WidgetBundle {
var body: some Widget {
GameStatusWidget()
CharacterDetailWidget()
}
}
注意：
创建多个Widget的时候，注意文件和对应的Target绑定，否则就会报这种各样的错误，被这个问题困扰了许久，如图：
附
Apple文档介绍
https://developer.apple.com/documentation/widgetkit
