Mac OSX 开发入门基础系列之NSTask

Task(图片来自网络)

利用NSTask,我们可以在应用中调用外部程序或脚本并获得它的<执行状态和结果
NSTask最为常用的一个场景是为命令行操作提供图形化的界面

1. NSTask 与NSThread的不同

• NSTask会创建隔离的可运行实体,但执行权限受App沙盒限制
• NSTask不与创建的它的进程共享内存空间
• NSTask实例在运行时,环境条件不能改变,需要在运行之前进行配置
• 一个NSTask实例只能运行一次，再次调用会报错
• NSTask默认是异步执行,如果有同步需求,可调用waitUntilExit()方法

2. NSTask 在Swift 中与Objective-C中的不同

• Objective-C中, 是NSTask类
• Swift 中, 是Process类

3. NSTask 使用

我们通过创建一个简单的克隆Git仓库的工程来熟悉NSTask的使用
如果你比较捉急，可以提前从这里下载NSTaskDemo

• 3.1 创建工程(本示例使用Swift,并默认你已经熟悉基本的OSX UI开发),并设置好UI界面,效果如下:

  
  
  

  UI界面

• 3.2 打开ViewController.swift,设置控件的连线属性以及方法:

  
  
  

  设置IBOutlet 和IBAction
• 3.3 实现保存路径选择的方法selectPath

@IBAction func selectPath(_ sender: NSButton) {
        // 1. 创建打开文档面板对象
        let openPanel = NSOpenPanel()
        // 2. 设置确认按钮文字
        openPanel.prompt = "Select"
        // 3. 设置禁止选择文件
        openPanel.canChooseFiles = true
        // 4. 设置可以选择目录
        openPanel.canChooseDirectories = true
        // 5. 弹出面板框
        openPanel.beginSheetModal(for: self.view.window!) { (result) in
            // 6. 选择确认按钮
            if result == NSModalResponseOK {
                // 7. 获取选择的路径
                self.savePath.stringValue = (openPanel.directoryURL?.path)!
                // 8. 保存用户选择路径(为了获取访问权限)
                UserDefaults.standard.setValue(openPanel.url?.path, forKey: kSelectedFilePath)
                UserDefaults.standard.synchronize()
            }
            // 9. 恢复按钮状态
            sender.state = NSOffState
        }
    }

• 3.4 使用NSTask 调用shell,执行git clone命令

@IBAction func startPull(_ sender: NSButton) {
        guard  let executePath = UserDefaults.standard.value(forKey: kSelectedFilePath) as? String else {
            print("no selected path")
            return
        }
        guard repoPath.stringValue != "" else {return}
        if isLoadingRepo {return}   // 如果正在执行,则返回
        isLoadingRepo = true   // 设置正在执行标记
        task = Process()     // 创建NSTask对象
        // 设置task
        task?.launchPath = "/bin/bash"    // 执行路径(这里是需要执行命令的绝对路径)
        // 设置执行的具体命令
        task?.arguments = ["-c","cd \(executePath); git clone \(repoPath.stringValue)"]
        
        task?.terminationHandler = { proce in              // 执行结束的闭包(回调)
            self.isLoadingRepo = false    // 恢复执行标记
            print("finished")
            self.showFiles()   // 显示clone的仓库文件列表
        }
        captureStandardOutputAndRouteToTextView(task!)
        task?.launch()                // 开启执行
        task?.waitUntilExit()       // 阻塞直到执行完毕
    }
 // 显示目录文档列表
    fileprivate func showFiles() {
        guard  let executePath = UserDefaults.standard.value(forKey: kSelectedFilePath) as? String else {
            print("no selected path")
            return
        }
       let listTask = Process()     // 创建NSTask对象
        // 设置task
        listTask.launchPath = "/bin/bash"    // 执行路径(这里是需要执行命令的绝对路径)
        // 设置执行的具体命令
       
        listTask.arguments = ["-c","cd \(executePath + "/" + (repoPath.stringValue as NSString).lastPathComponent); ls "]
    
        captureStandardOutputAndRouteToTextView(listTask)
        
        listTask.launch()                // 开启执行
        listTask.waitUntilExit()
        
    }

• 3.5 使用NSPipe获取NSTask 执行的结果信息

在Swift中,NSPipe 被改名为Pipe

     extension ViewController{
      fileprivate func captureStandardOutputAndRouteToTextView(_ task:Process) {
     //1. 设置标准输出管道
     outputPipe = Pipe()
     task.standardOutput = outputPipe
     
     //2. 在后台线程等待数据和通知
     outputPipe.fileHandleForReading.waitForDataInBackgroundAndNotify()
     
     //3. 接受到通知消息
     NotificationCenter.default.addObserver(forName: NSNotification.Name.NSFileHandleDataAvailable, object: outputPipe.fileHandleForReading , queue: nil) { notification in
         
         //4. 获取管道数据 转为字符串
         let output = self.outputPipe.fileHandleForReading.availableData
         let outputString = String(data: output, encoding: String.Encoding.utf8) ?? ""
         if outputString != ""{
             //5. 在主线程处理UI
             DispatchQueue.main.async(execute: {
                 let previousOutput = self.showInfoTextView.string ?? ""
                 let nextOutput = previousOutput + "\n" + outputString
                 self.showInfoTextView.string = nextOutput
                 // 滚动到可视位置
                 let range = NSRange(location:nextOutput.characters.count,length:0)
                 self.showInfoTextView.scrollRangeToVisible(range)
             })
         }            
         //6. 继续等待新数据和通知
         self.outputPipe.fileHandleForReading.waitForDataInBackgroundAndNotify()
               }
            }
       }

4. NSTask 与 SandBox权限

在NSTaskDemo示例工程中,开启了App 的沙盒权限,

• 开启网络访问权限

• 开启了用户选择文件的读写权限

  
  
  

  沙盒权限

在osx 系统中 ,沙盒有个规则:在App运行期间通过NSOpenPanel用户手动打开的任意位置的文件，把这个这个路径保存下来，后面都是可以直接用这个路径继续访问文件,但当App退出后再次运行,这个路径默认是不可以访问的

关于OSX的沙盒机制,推荐学习这篇文档[Cocoa开发之沙盒机制及访问Sandbox之外的文件

推荐文档的补充说明: 永久访问用户授权的url,可以不必在.entitlements文件中填写对应的key与value
(测试环境osx 10.12.5 ,Xcode 8.3.3)

5. 最终效果

运行效果

6. 同步方式获取NSTask的执行结果

func execCmd(cmd: String, arguments: [String]) -> String{
    let task = Process()     // 创建NSTask 实例
    task.launchPath = cmd        // 需要执行的命令
    task.arguments = arguments    // 命令参数
    let output = Pipe()                  // 创建输出实例
    task.standardOutput = output          // 设置输出
    task.launch()                                     // 执行命令
    task.waitUntilExit()                          // 等待退出
    let data = output.fileHandleForReading.readDataToEndOfFile()      // 获取执行结果数据
    return String(data: data, encoding: String.Encoding.utf8) ?? ""     // 返回结果
}

7. 小结

NSTask为我们提供了可以在一个应用中，调用另一个应用<的可能.其中比较普遍的一个使用场景是我们可以在自己的App中，调用强大的Shell命令,或者执行自己写的脚本来实现一些辅助功能
NSPipe用来辅助我们获取NSTask的输出结果,用来展示UI信息

8. 后语

关于NSTask的使用并不十分复杂，但如果想实现强大的需求,最好有一些必备的Shell编程知识，另外值得注意就是沙盒权限问题,文中的一下疑问或者意见,大家可以写在评论区进行讨论，最后希望大家周末愉快~