SwiftUI中PDFKit的PDFPageOverlayProvider Coordinator方法未触发排查

1. 协调器创建方式错误 #

你直接在PDFViewWrapper里声明并初始化coordinator属性，但UIViewControllerRepresentable要求必须通过makeCoordinator()方法生成协调器实例。系统会自动管理该方法创建的协调器生命周期，确保代理方法能被正确触发；手动初始化的协调器无法和组件上下文绑定，导致代理回调失效。

2. 内置标注模式冲突 #

pdfView.isInMarkupMode = true开启了PDFKit自带的标注功能，这会覆盖你自定义的pageOverlayViewProvider，导致自定义overlay视图无法加载，对应的代理方法自然不会触发。

修正后的完整代码 #

import SwiftUI
import PDFKit
import PencilKit

struct PDFDocumentView: View {
    var url: URL?
    
    var body: some View {
        if let pdfURL = url, let pdf = PDFDocument(url: pdfURL) {
            PDFViewWrapper(pdfDocument: pdf)
                .frame(maxWidth: .infinity, maxHeight: .infinity)
                .edgesIgnoringSafeArea(.all)
        }
    }
}

struct PDFViewWrapper: UIViewControllerRepresentable {
    var pdfDocument: PDFDocument
    
    // 必须实现该方法创建协调器
    func makeCoordinator() -> OverlayCoordinator {
        OverlayCoordinator()
    }
    
    func makeUIViewController(context: Context) -> UIViewController {
        let pdfView = PDFView()
        pdfView.document = pdfDocument
        // 使用上下文提供的协调器实例
        pdfView.pageOverlayViewProvider = context.coordinator
        pdfView.delegate = context.coordinator
        // 关闭内置标注模式避免冲突
        pdfView.isInMarkupMode = false
        
        let viewController = UIViewController()
        viewController.view.addSubview(pdfView)
        pdfView.translatesAutoresizingMaskIntoConstraints = false
        NSLayoutConstraint.activate([
            pdfView.leadingAnchor.constraint(equalTo: viewController.view.leadingAnchor),
            pdfView.trailingAnchor.constraint(equalTo: viewController.view.trailingAnchor),
            pdfView.bottomAnchor.constraint(equalTo: viewController.view.bottomAnchor),
            pdfView.topAnchor.constraint(equalTo: viewController.view.topAnchor)
        ])
        return viewController
    }
    
    func updateUIViewController(_ uiViewController: UIViewControllerType, context: Context) {}
}

class OverlayCoordinator : NSObject, PDFPageOverlayViewProvider, PDFViewDelegate {
    var pageToViewMapping = [PDFPage: PKCanvasView]()
    
    func pdfView(_ pdfView: PDFView, willDisplayOverlayView overlayView: UIView, for page: PDFPage) {
        print("Overlay view will display for page: \(page.index)")
    }

    func pdfView(_ view: PDFView, overlayViewFor page: PDFPage) -> UIView? {
        print("Creating overlay for page: \(page.index)")
        if let canvasView = pageToViewMapping[page] {
            return canvasView
        } else {
            let canvasView = PKCanvasView(frame: .zero)
            canvasView.backgroundColor = .clear
            canvasView.drawingPolicy = .anyInput
            canvasView.tool = PKInkingTool(ink: .init(.pen), width: 20) // 调整为合理笔宽
            canvasView.isOpaque = false
            pageToViewMapping[page] = canvasView
            return canvasView
        }
    }
}

#Preview {
    // 替换为你的本地测试PDF路径
    PDFDocumentView(url: Bundle.main.url(forResource: "test", withExtension: "pdf"))
}

额外优化点 #

• 简化了PDFDocumentView的可选绑定逻辑，代码更简洁。
• 将原90的笔宽调整为20，避免画笔过于粗大影响体验。
• 预览代码添加了本地PDF示例路径，方便快速测试。

内容的提问来源于stack exchange，提问作者Eshan singh