肇鑫的技术博客

业精于勤,荒于嬉

循环结构中异步代码实现灵活退出(上)

在同步代码时,循环要提前退出十分简单。

for i in 1...10 {
    print(i)
    
    if i == 5 {
        break
    }
}

但是在异步代码中,要灵活退出就不那么容易了。比如,在调用RestAPI时,如果一切正常,就执行下一次循环,如果出错,则进行提示用户,进行重试或者退出。这个就属于异步操作。

import Cocoa

class ViewController: NSViewController {
    private let concurrentQueue = DispatchQueue.global()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        run()
    }
    
    private func run() {
        for i in 1...10 {
            print(i)
            
            if shouldBreak(i) {
                break
            }
        }
    }
    
    private func shouldBreak(_ i:Int) -> Bool {
        var result = false
        let delayInSeconds = Int(arc4random() % 3)

        concurrentQueue.asyncAfter(wallDeadline: .now() + .seconds(delayInSeconds)) {
            if i == 5 {
                result = true
            }
        }
        
        return result
    }
}

由于采用了异步,shouldBreak(_ i:Int) -> Boolresult是先于DispatchQueue.main.async中的代码执行的。因此输出始终是1-10

为保证执行的顺序,需要使用信号量。

import Cocoa

class ViewController: NSViewController {
    private let semaphore = DispatchSemaphore(value: 0)
    private let concurrentQueue = DispatchQueue.global()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        run()
    }
    
    private func run() {
        for i in 1...10 {
            print(i)
            
            if shouldBreak(i) {
                break
            }
        }
    }
    
    private func shouldBreak(_ i:Int) -> Bool {
        var result = false
        let delayInSeconds = Int(arc4random() % 3)

        concurrentQueue.asyncAfter(wallDeadline: .now() + .seconds(delayInSeconds)) {
            if i == 5 {
                result = true
            }
            
            self.semaphore.signal()
        }
        
        semaphore.wait()
        
        return result
    }
}

代码执行正确。下面我们加入改变UI的部分。添加一个NSTextView,让它显示每次的i

import Cocoa

class ViewController: NSViewController {
    private let semaphore = DispatchSemaphore(value: 0)
    private let concurrentQueue = DispatchQueue.global()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        run()
    }
    
    private func run() {
        for i in 1...10 {
            print(i)
            
            if shouldBreak(i) {
                break
            }
        }
    }
    
    private func shouldBreak(_ i:Int) -> Bool {
        var result = false
        let delayInSeconds = Int(arc4random() % 3)

        concurrentQueue.asyncAfter(wallDeadline: .now() + .seconds(delayInSeconds)) {
            DispatchQueue.main.async {
                self.textView.string += "\(i)\n"
            }
            
            if i == 5 {
                result = true
            }
            
            self.semaphore.signal()
        }
        
        semaphore.wait()
        
        return result
    }
    
    @IBOutlet var textView: NSTextView!
}

代码执行后,我们会发现,textView中的i,不是一行一行显示的,而是一开始不显示,然后一下子都显示出来。这和我们期望的不符。

这是什么原因造成的呢?其实,这是因为视图控制器中的代码,默认运行在图形线程,因此semaphore.wait()其实每次都阻塞了图形线程。这导致textView一直没法刷新。直到循环跳出后,界面才成功刷新。

知道了原因,解决办法就有了。将代码从默认的图形线程中移除即可。最终代码:

import Cocoa

class ViewController: NSViewController {
    private let semaphore = DispatchSemaphore(value: 0)
    private let concurrentQueue = DispatchQueue.global()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        concurrentQueue.async {
            self.run()
        }
    }
    
    private func run() {
        for i in 1...10 {
            print(i)
            
            if shouldBreak(i) {
                break
            }
        }
    }
    
    private func shouldBreak(_ i:Int) -> Bool {
        var result = false
        let delayInSeconds = Int(arc4random() % 3)

        concurrentQueue.asyncAfter(wallDeadline: .now() + .seconds(delayInSeconds)) {
            DispatchQueue.main.async {
                self.textView.string += "\(i)\n"
            }
            
            if i == 5 {
                result = true
            }
            
            self.semaphore.signal()
        }
        
        semaphore.wait()
        
        return result
    }
    
    @IBOutlet var textView: NSTextView!
}

循环结构中异步代码实现灵活退出(下)

iOS SDK出错,导致返回值为空指针问题的处理

正常来讲,苹果的SDK是不会在Swift的非Optional的类型返回空指针的。如果我们遇到了这个情况,就应该立刻向苹果提交错误报告,让苹果修复这个API。文中提到的这个API,我已经向苹果提交了错误报告,期待苹果能尽快修复。下面来谈谈遇到这种情况要如何处理。

今天发现的坑是这个,func calendarItem(withIdentifier identifier: String) -> EKCalendarItem,它是EKEventStore的实例的方法,可以用来同时查询EKEventEKReminder匹配对应id的值。这个id指的是EKCalendarItemcalendarItemIdentifier

实际上如果只是想获得EKEvent,我们应该使用func event(withIdentifier identifier: String) -> EKEvent?,可以看到,这个方法的返回值是Optional<EKEvent>类型的,因此不会有空指针的问题。

代码示例:
在获得了访问日历和提醒事项的权限后,我们先创建一个日历和一个事件,保存这个日历和事件,然后删除事件。最后通过事件id来查询这个事件。由于此时事件已经被删除了,打印这个事件会导致程序崩溃。这个例子的意义在于,由于现在我们的日历、提醒事项都是同步的,很有可能的当前设备的事件,在其它设备被删掉了,而此时如果你还用原来的id查询,程序就有可能崩溃,因此需要额外的处理。

import UIKit
import EventKit

class ViewController: UIViewController {
    var store:EKEventStore!

    override func viewDidLoad() {
        super.viewDidLoad()
        
        store = (UIApplication.shared.delegate as! AppDelegate).store
        
        Timer.scheduledTimer(withTimeInterval: 1, repeats: true) { [unowned self] (timer) in
            let status = EKEventStore.authorizationStatus(for: .event)
            if status == .authorized {
                timer.invalidate()
                // add a new event calendar
                let calendar = EKCalendar(for: .event, eventStore: self.store)
                calendar.title = "issue test"
                calendar.source = self.store.sources.filter({ $0.sourceType == .local || $0.sourceType == .calDAV}).first!
                try! self.store.saveCalendar(calendar, commit: false)
                
                // add a new event to above calendar
                let event = EKEvent(eventStore: self.store)
                event.calendar = calendar
                event.title = "Have a rest"
                event.startDate = Date()
                event.endDate = Date().addingTimeInterval(30 * 60)
                try! self.store.save(event, span: .thisEvent)
                
                // commit
                try! self.store.commit()
                
                // store the id of the event 
                let id = event.calendarItemIdentifier
                
                // remove the event
                try! self.store.remove(event, span: .thisEvent, commit: true)
                
                // get the event
                let item = self.store.calendarItem(withIdentifier: id)
                print(item)
            }
        }
        
    }
}

由于我们添加了事件之后,又对事件进行了删除。此时再用事件的id获取项目时,项目实际应该返回nil,但是由于苹果设计这个API出现了问题,返回的不是Optional,而是确定的类型,这导致该值为一个空指针。此时,你就算想使用try catch,也是不行的,因为它并没有throw。此时你对它做的大部分操作,都会导致程序崩溃。难道就没有路可以走了吗?其实也不是。

虽然它不是Optional类型,但是它是确定类型的空指针,这个是苹果API的错误,是从Objective-c转换到Swift时出现的。我们自己写的Swift不会允许这样的情况出现。

某种角度来说,它其实也是个nil,因此,我们可以使用if let as?来进行匹配

 // get the event
 let item = self.store.calendarItem(withIdentifier: id)
 
 if let event = item as? EKEvent {
     print(event)
 }
 else if let reminder = item as? EKReminder {
     print(reminder)
 }
 else {
     print("item is a null pointer")
 }

这样就可以临时处理掉这个空指针的问题了。

UserDefaults的正确用法(修正版)

通常使用UserDefaults的方法有两种。

func applicationDidFinishLaunching(_ aNotification: Notification) {
    let dic = ["test":true]
    let id = Bundle.main.bundleIdentifier!
    // 1
    UserDefaults.standard.setPersistentDomain(dic, forName: id)
    // 2
    UserDefaults.standard.register(defaults: dic)
}

我们知道,PersistentDomain是永久的,会写入到磁盘。而register是临时的,每次程序启动都需要重新加载。因此,上面的代码有一些问题,需要改为

func applicationDidFinishLaunching(_ aNotification: Notification) {
   let dic = ["test":true]
   let id = Bundle.main.bundleIdentifier!
   if let _ = UserDefaults.standard.persistentDomain(forName: id) {
       
   }
   else {
       UserDefaults.standard.setPersistentDomain(dic, forName: id)
   }
   
   UserDefaults.standard.register(defaults: dic)
}

即,必须先确定没有这个PersistentDomain,然后才能注册。当重置设置为默认时,二者的代码也有一些差异。

let dic = ["test":true]
let id = Bundle.main.bundleIdentifier!
// 1
UserDefaults.standard.removePersistentDomain(forName: id)
UserDefaults.standard.setPersistentDomain(dic, forName: id)
// 2
UserDefaults.standard.resetStandardUserDefaults()

上面代码1是大家经常在网上看到的,但是它实际存在问题,是不正确的。这段代码表面看起来似乎没什么问题,第一步是删除所有设置,第二部是将设置设为默认。但是,如果你考虑到通知的,就会明白了。假设我们有一个注册到UserDefaults.didChangeNotification的通知。那么第一步就会发出通知,第二步还会再发一次。但是,由于第一步实际上是删除了所有的设置,此时程序有极大的可能会出错。

如果要解决这个问题,上面的代码可能要改为先解除注册的通知,然后删除所有设置,然后再注册通知,再将设置改为默认。但是且慢,我们真的需要这么做吗?为什么一定要清空才能再设置呢?难道不是直接设置就可以了吗?是的,其实直接设置就可以了,完全没必要清空。这样代码也就变成了下面这样:

let dic = ["test":true]
let id = Bundle.main.bundleIdentifier!
// 1
UserDefaults.standard.setPersistentDomain(dic, forName: id)
// 2
UserDefaults.standard.resetStandardUserDefaults()

那么方法2是怎么回事?可不可以也采用直接设置的方式?比如UserDefaults.standard.register(defaults: dic)。实际上是不可以的。这涉及到UserDefaults的原理。在实际使用中,系统是将registration domain和其它domain联合使用的。苹果的文档这样写到。

The registration domain defines the set of default values to use if a given preference is not set explicitly in one of the other domains.
如果其它domain没有设置某个设置,就使用registration domain定义的设置,即它实际是fail safe的默认值。

实际上registration domain,是临时的设置,你在每次启动程序时,都需要设置它。但是,如果用户将registration domain中含有的项的值改变了,系统就会自动将改变的内容写入到一个以你的程序命名的plist中。这里的值的优先级别,要比registration domain里的值的级别高,程序会以这里的为准。当然,你也可以通过直接写入PersistentDomain方法来修改这里的值。但是我们一般不会这么做。而是使用UserDefaults的一系列set方法,当使用set方法时,系统会自动将设置写入到plist中。

使用registration domain的好处

  1. 用户仅能见到非默认的设置,如果有些设置你不打算让用户知道或修改,这样更安全。
  2. 注册和删除的方式更加优雅。
  3. 添加新设置时更为方便,无需考虑程序版本。

结论

正确的使用UserDefaults的方法是:

  1. 在程序每次启动时调用registration domain来写如程序的默认值
  2. 当默认值被被用户修改时,调用UserDefaults的系列set方法来调用
  3. 除非要写入到其它的plist,我们一般不必使用PersistentDomain