iOS 長截圖 - 今是昨非

iOS 長截圖#

背景#

Twitter 上看到 TaioApp 的作者說，iOS 系統有支持長截圖的 API——UIScreenshotService，從 iOS 13 開始就可以使用，下午的時候就在自己的 APP 中體驗了一下。

过程#

When the user takes a screenshot of your app's content, you work with a UIScreenshotService object to provide a PDF version of that screenshot. You do not create a UIScreenshotService object directly. Instead, you retrieve the object from the screenshotService property of your window scene and assign a delegate to it. When the user takes a screenshot, UIKit asks your delegate for the PDF data.

截屏時，使用UIScreenshotService 最終提供的是 PDF，需要通過UIScreenshotServiceDelegate生成 PDF data.

使用如下：

把方法處理封裝到單獨的類，通過方法傳入 view，來決定截屏時使用那個 view 來生成 PDF data。

.h 文件


#import <Foundation/Foundation.h>

@interface WPSScreenShotHelper : NSObject

+ (instancetype)helper;

- (void)configScreenShotHelper:(UIScrollView *)scrollView;

@end

.m 文件


#import "MKScreenShotHelper.h"

@interface MKScreenShotHelper ()<UIScreenshotServiceDelegate>

@property (nonatomic, strong) UIScrollView *contentScrollView;

@end

@implementation MKScreenShotHelper

+ (instancetype)helper {
    static WPSScreenShotHelper *instance = nil;
    static dispatch_once_t onceToken;
    
    dispatch_once(&onceToken, ^{
        if (instance == nil) {
            instance = [WPSScreenShotHelper new];
        }
    });
    return instance;
}

- (instancetype)init {
    self = [super init];
    if (self) {
        if (@available(iOS 13.0, *)) {
            [UIApplication sharedApplication].keyWindow.windowScene.screenshotService.delegate = self;
        }
    }
    return self;
}

- (void)configScreenShotHelper:(UIScrollView *)scrollView {
    self.contentScrollView = scrollView;
}

#pragma mark - UIScreenshotServiceDelegate

- (void)screenshotService:(UIScreenshotService *)screenshotService generatePDFRepresentationWithCompletion:(void (^)(NSData * _Nullable, NSInteger, CGRect))completionHandler  API_AVAILABLE(ios(13.0)){
    
    // 臨時改變 ScrollView 的 size，保證 ScrollView 能完全渲染
    CGRect frame = self.contentScrollView.frame;
    CGPoint contentOffset = self.contentScrollView.contentOffset;
    UIEdgeInsets contentInset = self.contentScrollView.contentInset;
    
    CGRect toFrame = frame;
    toFrame.size = self.contentScrollView.contentSize;
    self.contentScrollView.frame = toFrame;
    
    // 將 scrollView 渲染成 PDF
    NSMutableData *pdfData = [NSMutableData data];
    UIGraphicsBeginPDFContextToData(pdfData, self.contentScrollView.frame, nil);
    UIGraphicsBeginPDFPage();
    CGContextRef pdfContext = UIGraphicsGetCurrentContext();
    [self.contentScrollView.layer renderInContext:pdfContext];
    UIGraphicsEndPDFContext();
    
    // 恢復 scrollView 的 frame
    self.contentScrollView.frame = frame;
    self.contentScrollView.contentOffset = contentOffset;
    self.contentScrollView.contentInset = contentInset;
    
    // 回調結果
    completionHandler(pdfData, 0, CGRectZero);
}

@end

使用UIScreenshotService確實可以長截屏，截的內容的大小是 ScrollView 的 contentSize。

但是有以下一些問題，需要注意：

不在 ScrollView 上的內容使用UIScreenshotService時看不到，比如 navigationBar、tabBar。
webview 的截屏，通過獲取 webview 的 scrollview 的高度，也可以截到。但是，如果是 webview 裡面加載的網頁中間或者網頁部分使用了滑動，即不是 WebView 的 Scroll 而是 H5 網頁裡的 Scroll，這樣的顯示，UIScreenshotService是獲取不到的，因為最後不管怎麼獲取 webview 的 scrollview 的 contentSize 的 Height 一直都是那麼高，滑動的部分不是這個 scrollview。
使用了CAShapeLayer之類的，生成圓角或者其他，如果沒有設置 layer 的 fillColor，最終UIScreenshotService顯示出來會是純黑的。
由於方法的回調依賴 scrollView 生成 PDF data，所以每個需要截圖的界面，在進入時，都需要手動更新 contentScrollView，二級界面的還好說，可以 hook scrollView 的初始化方法，保證每次創建時都更新 helper 的 contentScrollView，但是一級界面的幾個 tab 切換，則只能通過手動更新的方式來設置（或者根據 tabIndex 獲取不同的 scrollview），總之這也是需要注意的地方。

總結#

UIScreenshotService確實能生成長截圖，對於項目結構相對簡潔明瞭、代碼比較規範、只需要某個原生頁面支持長截圖的 APP 來說，可以使用。
但是如果項目中 H5 多，且項目結構複雜的話，使用就不太方便了。