iOS小组件Widget踩坑

上篇文章是对widget的整体调研，真正上项目会有很多坑

运行主项目或者单独运行widget都可以使widget代码生效

一.widget不走断点

1.因为func getTimeline方法不一定每次运行项目都会及时生效，有时widget界面刷新了，但是断点却没走，升级xcode到12.2就好很多

2.在主项目主动调用widget刷新

WidgetCenter.shared.reloadAllTimelines()

需要注意的是这个方法需要import WidgetKit，WidgetKit只有swift版本，所以主项目如果是OC需要混编调用swift

3.在主项目随便打一个断点（比如didFinishLaunch），因为主项目是走断点的，运行下主项目，走断点，运行主项目widget也会运行，发现widget中的断点也走了，神奇

4.老办法：跑一遍主项目再跑widget项目，重新安装APP，clean Xcode，重启Xcode，重启电脑，重启手机

二.widget不刷新，或者刷新不及时

我们都知道widget的刷新是受func getTimeline控制的，因为这个方法受系统控制，系统会根据widget的使用频率和类型，来决定widget的刷新频率，所以func getTimeline的刷新最早时间是我们手动写的刷新策略，很有可能刷新时间会延后
另外手动写的刷新策略过于频繁，会延后小组件的刷新
举个，策略为十分钟以后刷新

        let currentDate = Date()
        let entryDate = Calendar.current.date(byAdding: .minute, value: 10, to: currentDate)!
        let entry = SimpleEntry(date: entryDate)
        
        var entries: [SimpleEntry] = []
        entries.append(entry)
        return Timeline(entries: entries, policy: .after(entryDate))

policy是刷新策略，有三种方式
.atEnd,当前entries执行完毕后，立刻刷新
.after,设定时间刷新
.never,不刷新

entryDate是指定每个entry的刷新时间

虽然第一次添加widget，func getTimeline一定会走，但是在有些机器不能及时的刷新，目前没有找到解决方案，猜测和系统刷新频率有关

还可以像上面说的在主项目主动调用widget刷新WidgetCenter.shared.reloadAllTimelines()，比如在主项目切换到后台时刷新

三.widget黑屏

1.不管是在添加widget界面还是把widget添加到桌面，黑屏可能widget已经崩溃了，单独运行widget Extension查看是否崩溃，
2.func getTimeline方法没有返回，数据错误，网络错误，都要返回func getTimeline的completion闭包
3.采用每个widget单独加载一个widget样式的方案，不要一个widget加载多个widget样式，这样在没有加载出来widget时，系统的占位文本不知道加载哪种widget样式导致黑屏，具体加载方式看上一篇文章
4.有时是设备问题，换台设备试试

四.widget不停刷新

1.调用了持续定位

2.func getTimeline方法中completion闭包被频繁调用，可能存在多个异步调用操作

比如报错：
Terminating app due to uncaught exception 'NSFileHandleOperationException', reason: '*** -[NSConcreteFileHandle fileDescriptor]: Invalid argument'

原因：getTimeline的completion闭包只能调用一次

五.调用主项目，三方库

如果主项目是OC，或者现在widget target项目里面加入OC文件，需要加入桥接文件，如果加入.intentdefinition的配置文件，需要在桥接文件中，引入#import "ConfigurationIntent.h"，否则会报错误Cannot find type 'ConfigurationIntent' in scope。

如果需要用cocopod中的其他库，需要添加新的target，加入在widget扩展中需要用到的库，比如加入AFNetworking：

target 'WidgetExtension' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!

  pod 'AFNetworking'
  # Pods for WidgetExtension

end

如果需要主项目中的文件，在需要用到的.m文件Target Membership中勾选widgetExtention，这样widget小组件才能用这个OC 文件。可能需要一些兼容性改动：引入一些缺少的头文件，勾选其他关联文件的Target Membership，添加widget关联。勾选后编译一下，没问题后把用到的OC文件添加到桥接文件中声明，这样swiftUI才能调用原来OC主项目的文件

六.界面混编问题

widget界面不能用UIKit的任何东西，遵守UIViewRepresentable协议桥接过来也不行，只能用swiftUI写界面

七.不能高德定位

目前高德定位初始化[[AMapLocationManager alloc] init]，会崩溃；报错Assertion failure in -[CLLocationManager setPausesLocationUpdatesAutomatically:]，但是系统定位可以拿到经纬度，再反地理位置编码
需要在info.plist添加NSLocationAlwaysAndWhenInUseUsageDescription,NSLocationAlwaysUsageDescription,NSLocationUsageDescription,NSLocationWhenInUseUsageDescription，还需要添加NSWidgetWantsLocation设为true，允许小组件定位

八.机型适配，swiftUI布局

widget尺寸.jpeg

这是官方给的widget在各个机型的尺寸，然后我发现widget在各个机型尺寸都不一样，和屏幕比例没有关系，不成比例，到屏幕边缘的距离也各不相同，找不要系统方法，为了获取widget的大小宽高，就根据这个表，写死了一套获取代码(不对，下面有直接获取方法)

enum WidgetSizeEnum {
    case small
    case medium
    case large
}

let ScreenWidth = UIScreen.main.bounds.width
let ScreenHeight = UIScreen.main.bounds.height


func WidgetSize(_ widgetType:WidgetSizeEnum) -> CGSize {
    
    if ScreenWidth == 320 && ScreenHeight == 568 {
        switch widgetType {
        case .small:
            return CGSize(width: 141, height: 141)
        case .medium:
            return CGSize(width: 291, height: 141)
        case .large:
            return CGSize(width: 291, height: 299)
        }
    }
    
    
    if ScreenWidth == 375 && ScreenHeight == 667 {
        switch widgetType {
        case .small:
            return CGSize(width: 148, height: 148)
        case .medium:
            return CGSize(width: 322, height: 148)
        case .large:
            return CGSize(width: 322, height: 324)
        }
    }

    if ScreenWidth == 414 && ScreenHeight == 736 {
        switch widgetType {
        case .small:
            return CGSize(width: 159, height: 159)
        case .medium:
            return CGSize(width: 348, height: 159)
        case .large:
            return CGSize(width: 348, height: 357)
        }
    }
    
    if ScreenWidth == 375 && ScreenHeight == 812 {
        switch widgetType {
        case .small:
            return CGSize(width: 155, height: 155)
        case .medium:
            return CGSize(width: 329, height: 155)
        case .large:
            return CGSize(width: 329, height: 345)
        }
    }
    
    if ScreenWidth == 414 && ScreenHeight == 896 {
        switch widgetType {
        case .small:
            return CGSize(width: 169, height: 169)
        case .medium:
            return CGSize(width: 360, height: 169)
        case .large:
            return CGSize(width: 360, height: 376)
        }
    }
    
  
    switch widgetType {
        case .small:
            return CGSize(width: 148, height: 148)
        case .medium:
            return CGSize(width: 322, height: 148)
        case .large:
            return CGSize(width: 322, height: 324)
    }
}



let kSmallWidgetWidth = WidgetSize(.small).width
let kMediumWidgetWidth = WidgetSize(.medium).width
let kLargeWidgetWidth = WidgetSize(.large).width

let kSmallWidgetHeight = WidgetSize(.small).height
let kMediumWidgetHeight = WidgetSize(.medium).height
let kLargeWidgetHeight = WidgetSize(.large).height

后来发现有些机型没有包含，比如iPhone12，min，max，后来在翻了一遍WidgetKit库终于找到了系统方法，哭了，上面写的这一套是费代码，坑，

public struct TimelineProviderContext {
  public let displaySize: CGSize
}

在widget三个方法placeholder,getSnapshot,getTimeline都可以获取

context.displaySize

swiftUI布局也有很多坑，下次另开一篇文章细说
比如

Image("imageName")
    .resizable()
    .frame(width: fitWidth(22), height: fitWidth(22))

图片设置大小要先设置resizable，否则不生效

发现一个神坑，原来不带编辑功能的小组件，更新版本到有编辑功能的小组件，原来添加的静态不可编辑的小组件就不能用了，重启手机就好了（但不能让用户重启手机吧），新添加的widget没有问题，分析原因是初始化方式改变了，StaticConfiguration变成了IntentConfiguration，代码没更新，所以开始就带上可编辑功能吧