PDFKit 的新功能

PDFKit 的新功能

了解 PDFKit，这个功能全面的框架可帮助您的 App 查看、编辑和保存 PDF 文档。我们将介绍 PDFKit 的最新功能，包括支持实时文本和表格、从图片创建 PDF、构建交互式叠层，以及保存注释等。

资源
- PDFAnnotationWidgetsAdvanced
- - 高清视频
  - 标清视频
相关视频

WWDC22
- WWDC22 第 4 天总结
WWDC19
- PencilKit 简介
下载

Conrad: 我是 Conrad 今天我将为大家介绍 PDFKit 更新的内容以下是我们的议程我们首先快速回顾下 PDFKit 然后了解更新的内容包括实时文本和表单将 PDF 页面转为图片的新方式最后 overlay views (覆盖视图) 首先我们先快速回顾下 PDFKit 是如何运行的 PDFKit 是一个全功能框架能帮助您的 App 查看编辑和编写 PDF 文件在 iOS macOS 和 Mac Catalyst 中均适用也可以通过可将 UI 视图整合到您 APP 中的封装 UIViewRepresentable 在 SwiftUI 中使用 PDFKit PDFKit 包含四个核心类覆盖您 App 中所需的大部分功能 PDFView 是您使用 SwiftUI 或 Interface Builder 加入到布局中的小组件可展示 PDF 文档的内容允许用户导航设置缩放比例及将文本复制到剪贴板
PDFDocument 代表一个 PDF 文件这对 PDFDocument 子类来说并不常见但您总是会用到它是 PDF 对象图的根源是树之躯干无枝不成树
每个文档都包含一个或多个 PDFPage 对象页面渲染内容和存储资源如字体和图像对页面来说都是独特的
我们对象图的绿叶是 PDFAnnotations 这些是可选的然而 PDFPage的内容并不是用于编辑 annotations 则具有交互特性通常是可编辑的这些对象在我们今天的内容中都扮演了对应的角色您可通过下方链接中关于“Introducing PDFKit”的精彩内容来了解更多 PDFKit 的基本原理
现在我们来看下在 iOS 16 和 macOS Ventura 中推出的新功能
PDFKit 当前已支持实时文本在照片 App 中文本通常占少数您可以直接点击复制而在 PDF 中如果您看到的是文本则普遍都是文本人们也希望其发挥文本的功能别无他用而现在使用实时文本您可以在 PDF 文档中选择和搜索文本如这一示例这只是一个扫描的位图完全没有文本
当然 PDFs 有很多页面您打开文档时不会想对一个 PDF 文档的每个页面都费力进行 OCR 因此在您与每个页面发生交互动作时 PDFKit 应需启用 OCR 即时完成无需生成文档副本如果您选择保存整份文档的文本保存时也可以选择对应的选项
除实况文本以外 PDFKit的表单处理也进行了改进即使没有内置文本区域也能自动识别包含表单区域的文档您可以点击这些文本区域输入文本正如您所想的那样
接下来我们说下从图片创建 PDF 页面的新 API
在 iOS 16 和 macOS Ventura 中有一个全新的灵活的 API 可以让您的 App 用图片作为输入创建 PDF 页面您的 App 用 CGImageRef 提供图片 PDFKit 使用您提供的 CGImageRef 并将其用高质量的 JPEG 解码进行压缩由于 CGImageRef 是 CoreGraphics 中的原生数据类型所以无需额外转换
有多个选项可供您处理最常见的情况
MediaBox 指定页面大小您可以选择适合图片的大小或选择纸张尺寸如 Letter
Rotation 可供您指定纵向或横向
还有 UpscaleIfSmaller 如果图片大于 MediaBox 则默认将图片缩小到适应比例如果 UpscaleIfSmaller 已被指定该规则仍有效但如果图片较小则会增加尺寸以适合页面
现在我们来回答下大家都在问的问题 “我怎么能用 PencilKit 在 PDF 页面上绘图呢” 答案就是使用覆盖视图
过去在 PDFs 上绘图的唯一方法就是将 PDFPage 编入子类覆写绘图方法或使用自定义 PDF annotations 但从 iOS 16 和 macOS Ventura 开始现在可以在每个 PDF 页面上覆盖您自己的视图让您的 App 创建实时具有强交互性的视图显示在 PDF 页面上层关于覆盖视图你需要知道以下三点首先您要使用一个新代理在 PDF 页面中安装您的覆盖视图
到了需要保存的时候您需要将内容并入 PDF 说到保存我们会分享一些保存 PDF 文档的最优方法
在 PDF 页面上安装覆盖视图很简单因为 PDFs 可以包含成百上千的页面打开 PDF 时您不会想为这些所有页面创建视图但如果用户快速前后滚动呢您如何知道何时创建视图
幸运的是 PDFKit 已经设计好在用户滚动至所需位置前就能智能准备内容它知道何时请求覆盖视图您的 App 只需要响应它通过新代理发出的请求
PDFPageOverlayViewProvider 是新代理对了 PDFKitPlatformView 只是 UIView 或 NSView 的定义取决于平台你需要运行的最重要方法是 overlayViewForPage 只需要提供您的视图实例 PDFKit 就会应用适当的边界重设其尺寸如果页面有非零旋转它会执行旋转
接下来两个方法是可选的 willDisplayOverlayView 可用于安装您自己的动作处理程序或与 PDFKit 的动作处理程序建立失败关系
在 PDFKit 完成您的视图时会调用 willEndDisplayingOverlayView 可能是因为页面已滚动到视图之外您可在这里发布您的视图但这一方法还有另一个重要用途假如您的视图有一些展示其正在绘制内容的数据您可以用该方法获取数据并将其放置一边我们会用 PencilKit 进行示例但如果您的视图数据被搁置在别处则无需执行此操作
在示例中这是我们用于提供程序的类它执行 PDFPageOverlayViewProvider 代理这是 iOS 所以 PDFKitPlatformView 是一个 UIView 使用地图从 PDFPage 到 UIView 这是占位符代理方法接下来我们看下实现 overlayViewForPage 检查其 pageToView 地图看是否对指定页面建立了视图如果没有则创建一个新视图不管哪种情况我们都能从页面获取绘图并将其放置于画布视图在这些示例中我使用的是 PDFPage 的子类其作用是添加“绘制”属性
现在我们来看下一个方法即 WillEndDisplayingOverlay
willEndDisplayingOverlayView 很简单它从视图中获取绘图并将其存储于我们自定义页面类现在我们已经完成了那就来看下实际的实施吧
通常每年大约这个时候我会在缅因州钓鱼然而现在我却在 WWDC 现场因此有另一个人代替我去旅行我将会给他看下一些我最喜欢的地点并且会用这一 App 来完成在覆盖视图中使用 PencilKit 这一 App 包含我们刚刚看到的代码仅此而已获取屏幕上的覆盖视图的完整代码仅约 30 行因此 Grand Lake Stream 这是大坝池有很多鱼大部分动作都是在这里进行的您沿着这条小路一直走经过树林就能到达大坝池然后钓鱼您可以钓各种鱼或者也可以走这条路越过大坝从这里往下走您可以从那里钓鱼一直到这里环岛一圈下来这里但不管你做什么不要越过这里这里的水流又深又急避开这个地方下来这里到孵化场沿着孵化场旁一直走进入这个池塘您可以在这里抛钓丝这是很好的地方我经常在这里钓鱼
好了现在我们在这个页面做了一些标记我们演示下缩放和滚动
看它响应速度多快
这就好了 PDFKit 的覆盖视图现在您已经有了这些草图那要怎么保存呢我们可以用 PDFAnnotation 类来完成保存时我们希望能实现两点我们希望在高保真的前提下匹配屏幕显示并且我们希望做一些往返编辑 PDF annotations 有一些功能可以实现这些要求 PDF annotations 有一个 “appearance stream” 是 PDF 绘制指令流基本上所有您能用 Quartz2D 绘制的东西 appearance stream 都能记录下来只要能渲染成图片的都能记录如果我们使用 Metal 用的就是这个方法而且由于是作为 PDF 绘图来记录的看起来和在 Adobe Reader Chrome 等的显示都一样
在 PDF 文档中 PDF annotations 是以字典的形式来存储的这意味着我们也可以在私人密钥/值对中存储自定义数据那我们来看看代码是什么样的首先创建 PDFAnnotation 的子类这一步是为了覆写 draw() 方法 PDFKit 在保存我上一张幻灯片中讲的appearance stream 时会调用此方法
要保存文档我们要覆写 UIDocument 的 contents() 这是该函数的概览对应稍后的上下文我们依次通过 PDFDocument 的各页面下一步再来充实循环
每个页面我们都进行以下操作创建我们自定义类的 annotation 将我们的绘图编码至数据将数据添加至 annotation 我们下次打开该文档时就可以使用 value:forAnnotationKey 来回读存储的绘图数据并将其放置到我们的覆盖视图中
最后将 annotation 添加到页面回到我们的 contents() 覆写现在我们页面上已经添加了 annotations 我们用 PDFDocument 的 dataRepresentation() 返回结果
当您的内容被存为 annotation 时文档接收者可对其进行移动重设大小或删除通常来说那正是您想要的但有时您会希望您的 annotations 作为页面的一部分烧录在 iOS 16 和 macOS Ventura 中有一个新的 PDFDocumentWriteOption 可以简化该操作只要添加 burnInAnnotationsOption = true 到保存选项即可完成
说到 PDF 编写选项有一些在 iOS 16 和 macOS Ventura 中已可用我们来看看 CoreGraphics 一直致力于让 PDFs 中保存的图片维持最高保真度因此图片都以无损压缩全解析度保存如果 PDF 在大幅面打印机中打印出来那堪称完美但是更有可能的是图片是在屏幕上显示的这些高保真度的图片数据带来的结果就是文件尺寸超大为了应对这一问题我向大家介绍以下两个选项
saveAllImagesAsJPEG 可完成刚刚所说的操作不管图片是如何创建的都可以通过 JPEG 保存解码入 PDF
optimizeImagesForScreen 可对图片进行下采样直至 HiDPI 屏幕分辨率的最大值这两个选项可以同时使用
createLinearizedPDF 创建一种特殊类型的 PDF 针对网络进行优化 PDF 格式最初在互联网出现前就已设计为从文件末尾读取这意味着它要提前下载所需的只是展示一个线性化 PDF 有了展示文件开始的第一页所需的所有内容因此网页浏览器可先显示该内容并同时加载剩余部分
您可以将这些选项传送到 PDFDocument 的 dataRepresentation 或 writeToURL 方法正是如此 PDFKit 强大简便今天在 iOS 和 macOS 以及有新功能的 iOS 16 和 macOS Ventura 中许多 App 都在使用我已经迫不及待要看看您的成果了
请查看下方的讲座了解更多信息感谢大家的观看

6:54 - Implementing the overlay protocol

class Coordinator: NSObject, PDFPageOverlayViewProvider {

    var pageToViewMapping = [PDFPage: UIView]()
   
    func pdfView(_ view: PDFView, overlayViewFor page: PDFPage) -> UIView? {
        var resultView: PKCanvasView? = nil
        
        if let overlayView = pageToViewMapping[page] {
            resultView = overlayView
        } else {
            let canvasView = PKCanvasView(frame: .zero)
            canvasView.drawingPolicy = .anyInput
            canvasView.tool = PKInkingTool(.pen, color: .systemYellow, width: 20)
            canvasView.backgroundColor = UIColor.clear
            pageToViewMapping[page] = canvasView
            resultView = canvasView
        }
        
        // If we have stored a drawing on the page, set it on the canvas
        let page = page as! MyPDFPage
        if let drawing = page.drawing {
            resultView?.drawing = drawing;
        }
        return resultView
    }

    func pdfView(_ pdfView: PDFView, willEndDisplayingOverlayView
        overlayView: UIView, for page: PDFPage) {
        let overlayView = overlayView as! PKCanvasView
        let page = page as! MyPDFPage
        page.drawing = overlayView.drawing
        pageToViewMapping.removeValue(forKey: page)
    }
}

10:22 - Create a subclass of PDFAnnotation

// Implement a subclass with a drawing override

class MyPDFAnnotation: PDFAnnotation {
    
    override func draw(with box: PDFDisplayBox, in context: CGContext) {
        UIGraphicsPushContext(context)
        context.saveGState()
        
        let page = self.page as! MyPDFPage
        if let drawing = page.drawing {
            let image = drawing.image(from: drawing.bounds, scale: 1)
            image.draw(in: drawing.bounds)
        }
        
        context.restoreGState()
        UIGraphicsPopContext()
    }
}

10:35 - Add annotations to your document when saving

override func contents(forType typeName: String) throws -> Any {
        
    if let pdfDocument = pdfDocument {
      
        // Go through all pages in the document
        for i in 0...pdfDocument.pageCount-1 {
            if let page = pdfDocument.page(at: i) {                       
                if let drawing = (page as! MyPDFPage).drawing {
                        
                    // Create an annotation of our custom subclass
                    let newAnnotation = MyPDFAnnotation(bounds: drawing.bounds,
                                                        forType: .stamp, withProperties: nil)
                        
                    // Add our custom data
                    let codedData = try! NSKeyedArchiver.archivedData(withRootObject: drawing,
                                                                      requiringSecureCoding: true)
                    newAnnotation.setValue(codedData,
                                           forAnnotationKey: PDFAnnotationKey(rawValue: "drawingData"))
                        
                    // Add our annotation to the page
                    page.addAnnotation(newAnnotation)
                }
            }
        }

        // -- Option #1: Save the document to a data representation
        if let resultData = pdfDocument.dataRepresentation() {
            return resultData
        }
      
        // -- Option #2: Save the document to a data representation and "burn in" annotations
        let options = [PDFDocumentWriteOption.burnInAnnotationsOption: true]
        if let resultData = pdfDocument.dataRepresentation(options: options) {
            return resultData
        }
    }
                
    // Fall through to returning empty data
    return Data()
}

正在查找特定内容？在上方输入一个主题，就能直接跳转到相应的精彩内容。

提交你查询的内容时出现错误。请检查互联网连接，然后再试一次。

资源

相关视频

WWDC22

WWDC19